com.steema.teechart.functions
Class HistogramFunction

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.functions.Function
          extended by com.steema.teechart.functions.HistogramFunction

public class HistogramFunction
extends Function

Title: HistogramFunction class

Description: Histogram function.

Example:


 function = new com.steema.teechart.functions.Histogram();
 function.setChart(myChart.getChart());
 function.setPeriod(0); //all points

 Line functionSeries = new Line(myChart.getChart());
 functionSeries.setTitle("Histogram");
 functionSeries.setDataSource(series);
 functionSeries.getXValues().setOrder(ValueListOrder.NONE);
 //functionSeries.setVerticalAxis(VerticalAxis.RIGHT);
 functionSeries.setFunction(function);
 

Copyright (c) 2005-2013 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL


Field Summary
 
Fields inherited from class com.steema.teechart.functions.Function
canUsePeriod, dPeriod, HideSourceList, noSourceRequired, series, SingleSource, updating
 
Fields inherited from class com.steema.teechart.TeeBase
chart, InternalUse
 
Constructor Summary
HistogramFunction()
           
HistogramFunction(IBaseChart c)
           
 
Method Summary
 void addPoints(java.util.Vector source)
          Gets all points from Source series, performs a function operation on points and stores results in ParentSeries.
 boolean getCumulative()
          Gets cumulative histogram.
 java.lang.String getDescription()
          Gets descriptive text.
 int getNumBins()
          Gets Number of bins (centerpoints) in histogram.
 void setCumulative(boolean value)
          Sets cumulative histogram.
 void setNumBins(int value)
          Sets Number of bins (centerpoints) in histogram.
 
Methods inherited from class com.steema.teechart.functions.Function
addFunctionXY, calculate, calculateAllPoints, calculateByPeriod, calculateMany, calculatePeriod, clear, dispose, doCalculation, getPeriod, getPeriodAlign, getPeriodStyle, getSeries, newInstance, readResolve, recalculate, setPeriod, setPeriodAlign, setPeriodStyle, setSeries, valueList
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, setChart, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HistogramFunction

public HistogramFunction()

HistogramFunction

public HistogramFunction(IBaseChart c)
Method Detail

getCumulative

public boolean getCumulative()
Gets cumulative histogram.

Returns:
boolean

setCumulative

public void setCumulative(boolean value)
Sets cumulative histogram.
If true, cumulative histogram is calculated.

Parameters:
value - boolean

getNumBins

public int getNumBins()
Gets Number of bins (centerpoints) in histogram.
Default value: 20

Returns:
int

setNumBins

public void setNumBins(int value)
Sets Number of bins (centerpoints) in histogram.
Default value: 20

Parameters:
value - int

addPoints

public void addPoints(java.util.Vector source)
Gets all points from Source series, performs a function operation on points and stores results in ParentSeries.

Overrides:
addPoints in class Function
Parameters:
source - ArrayList

getDescription

public java.lang.String getDescription()
Gets descriptive text.

Overrides:
getDescription in class Function
Returns:
String