com.softwarefx.chartfx.server.statistical
Class StudyZScores

java.lang.Object
  com.softwarefx.chartfx.server.statistical.Study
      com.softwarefx.chartfx.server.statistical.StudyInteractive
          com.softwarefx.chartfx.server.statistical.StudyZScores

All Implemented Interfaces:

IStudy

public class StudyZScores
extends StudyInteractive
implements IStudy

Provides access to the StudyZScores object

This class is specifically used to control attributes of studies that include z scores for display. The supported members allow developers to control what the z scores lines selected data series and color.

Constructor Summary

StudyZScores()

Method Summary

Color	getColor() Gets the Color.
int	getSeries() Gets the Series.
String	getValue(int series) Sets the value for a StudyCustom object.
void	setColor(Color value) Sets the color for the selected StudyZScores object.
void	setSeries(int value) Sets a value indicating which series in the chart the ZScore study will be applied.

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

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

Constructor Detail

StudyZScores

public StudyZScores()

Method Detail

getColor

public Color getColor()

Gets the Color. For more detail see setColor(java.awt.Color).

Specified by:

getColor in interface IStudy

Overrides:

getColor in class Study

getSeries

public int getSeries()

Gets the Series. For more detail see setSeries(int).

getValue

public String getValue(int series)

Sets the value for a StudyCustom object.

Remarks:

The Statistics.getStudies() property of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies property may also be used to obain the entire StudiesCollection.

This property may only be used with StudyCustom objects, as other study objects will have precalcuated values based on the chart data. In order for a StudyCustom item to have a value, it must be configured.

Specified by:

getValue in interface IStudy

Overrides:

getValue in class Study

See Also:

Statistics.getStudies(), StudyCustom, StudiesCollection, Statistics

setColor

public void setColor(Color value)

Sets the color for the selected StudyZScores object.

Remarks:

You can obtain the StudyZScores object for a selected study when adding the study to the Studies collection as follows:

The setSeries(int)# property may be used to assign which series the ZScores study will be applied.

See Also:

setSeries(int), Statistics.getStudies(), StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection, Statistics

setSeries

public void setSeries(int value)

Sets a value indicating which series in the chart the ZScore study will be applied.

Remarks:

You can obtain the StudyZScores object for a selected study when adding the study to the Studies collection as follows:

You can configure the color for the ZScore lines in the chart using the setColor(java.awt.Color) property.

See Also:

setColor(java.awt.Color), Statistics.getStudies(), StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection, Statistics