com.softwarefx.chartfx.server.statistical
Class StudyFormula

java.lang.Object
  com.softwarefx.chartfx.server.statistical.Study
      com.softwarefx.chartfx.server.statistical.StudyInteractive
          com.softwarefx.chartfx.server.statistical.StudyLine
              com.softwarefx.chartfx.server.statistical.StudyFormula

All Implemented Interfaces:

IStudy

Direct Known Subclasses:

StudyDistribution, StudyLowess, StudyPolynomialRegression

public class StudyFormula
extends StudyLine
implements IStudy

Provides access to the StudyFormula object.

Developers can create custom formulas with associated function delegates to handle processing when a formula is used.

Constructor Summary

StudyFormula(int id, FormulaDelegateListener formula)

Method Summary

double	getCurveMax() Gets the value indicating curve max.
double	getCurveMin() Gets the value indicating curve min.
FormulaDelegateListener	getFormula() Gets the Formula.
int	getSteps() Gets the Steps.
double	getXMax() Gets the Max X value for the distribution.
double	getXMin() Gets the Min X value for the distribution.
boolean	isFillArea() Gets the FillArea.
boolean	isSpline() Gets the Spline.
void	setFillArea(boolean value) Sets the boolean indicating whether the area under the curve is filled.
void	setFormula(FormulaDelegateListener value) Sets the delegate associated with this formula.
void	setSpline(boolean value) Sets the boolean indicating showing the Spline.
void	setSteps(int value) Sets the number of steps in the distribution

Methods inherited from class com.softwarefx.chartfx.server.statistical.StudyLine

getColor, getLine, getValue, isBehind, setBehind

Methods inherited from class com.softwarefx.chartfx.server.statistical.StudyInteractive

getAxis, isInteractive, isVisible, setAxis, setInteractive, setVisible

Methods inherited from class com.softwarefx.chartfx.server.statistical.Study

createStudy, createStudy, createStudy, createStudy, createStudy, getDecimals, getID, getText, getValue, isBold, isIndented, setBold, setDecimals, setIndented, setText, setValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.softwarefx.chartfx.server.statistical.IStudy

getColor, getText, getValue, isBold, isIndented, isInteractive, isVisible, setBold, setIndented, setVisible

Constructor Detail

StudyFormula

public StudyFormula(int id,
                    FormulaDelegateListener formula)

Method Detail

getCurveMax

public double getCurveMax()

Gets the value indicating curve max.

Remarks:

The formula must be added to the statistical object's Studies collection before a CurveMax value is available.

getCurveMin

public double getCurveMin()

Gets the value indicating curve min.

Remarks:

The formula must be added to the statistical object's Studies collection before a CurveMin value is available.

getFormula

public FormulaDelegateListener getFormula()

Gets the Formula. For more detail see setFormula(com.softwarefx.chartfx.server.statistical.FormulaDelegateListener).

getSteps

public int getSteps()

Gets the Steps. For more detail see setSteps(int).

getXMax

public double getXMax()

Gets the Max X value for the distribution.

Remarks:

This is a read-only property.

getXMin

public double getXMin()

Gets the Min X value for the distribution.

Remarks:

This is a read-only property.

isFillArea

public boolean isFillArea()

Gets the FillArea. For more detail see setFillArea(boolean).

isSpline

public boolean isSpline()

Gets the Spline. For more detail see setSpline(boolean).

setFillArea

public void setFillArea(boolean value)

Sets the boolean indicating whether the area under the curve is filled.

Remarks:

The coloring of the fill area is selected based on the current chart palette.

setFormula

public void setFormula(FormulaDelegateListener value)

Sets the delegate associated with this formula.

Remarks:

The Formula function delegate is called anytime a formula property is referenced.

setSpline

public void setSpline(boolean value)

Sets the boolean indicating showing the Spline.

Remarks:

A Spline is only available for certain Statistical galleries.

setSteps

public void setSteps(int value)

Sets the number of steps in the distribution

Remarks:

This value must be greater than 0.