com.softwarefx.chartfx.server.statistical
Class StudyLine

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

All Implemented Interfaces:

IStudy

Direct Known Subclasses:

StudyErrorBars, StudyFormula, StudyLinearRegression

public abstract class StudyLine
extends StudyInteractive
implements IStudy

Provides access to the StudyLine object

This class is specifically used to control attributes of studies that utilize a Line object.

Constructor Summary

StudyLine()

Method Summary

Color	getColor() Error: Member StudyLine.Color member not found
Line	getLine() Gets the Line object and exposes the supported members of the Line class.
String	getValue(int series) Sets the value for a StudyCustom object.
boolean	isBehind() Gets the Behind.
void	setBehind(boolean value) Sets a value indicating whether a selected StudyLine object will be painted infront or behind data series in the chart.

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

StudyLine

public StudyLine()

Method Detail

getColor

public Color getColor()

Error: Member StudyLine.Color member not found

ERROR: Doc member not found

Specified by:

getColor in interface IStudy

Overrides:

getColor in class Study

getLine

public Line getLine()

Gets the Line object and exposes the supported members of the Line class.

Remarks:

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

This property exposes the Line class members which allows you to customize the width, style, and caps for the selected line.

The setBehind(boolean) property allows you to specify whether the selected StudyLine object will be painted infront or behind the chart series.

See Also:

setBehind(boolean), Statistics.getStudies(), StudiesCollection, StudiesCollection, Statistics

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

isBehind

public boolean isBehind()

Gets the Behind. For more detail see setBehind(boolean).

setBehind

public void setBehind(boolean value)

Sets a value indicating whether a selected StudyLine object will be painted infront or behind data series in the chart.

Remarks:

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

The getLine() property exposes additional members to customize the width, style, and caps for the selected line.

See Also:

getLine(), StudiesCollection.add(com.softwarefx.chartfx.server.statistical.Analysis), StudiesCollection, Statistics