SoftwareFX.ChartFX.Statistical
Class StudyInteractive

java.lang.Object
  SoftwareFX.ChartFX.Statistical.Study
      SoftwareFX.ChartFX.Statistical.StudyInteractive

Direct Known Subclasses:

StudyConstant, StudyCustom, StudyLine, StudyStripe, StudyZScores

public abstract class StudyInteractive
extends Study

Provides access to the StudyInteractive object.

This class is specifically used to control attributes of studies that users may interact. These interactive studies, when added to the extension, allow end users to show or hide in the statistical chart.

Constructor Summary

StudyInteractive()

Method Summary

int	getAxis() Gets the Axis.
boolean	isInteractive() Gets the Interactive.
boolean	isVisible() Gets the Visible.
void	setAxis(int value) Gets or sets a value indicating the Axis a StudyInteractive object is associated.
void	setInteractive(boolean value) Gets or sets a value specifying whether or not the user will have access to interact with the selected study.
void	setVisible(boolean value) Gets or sets a value specifying whether or not the StudyInteractive object will be visible in the chart.

Methods inherited from class SoftwareFX.ChartFX.Statistical.Study

createStudyAnalysis, createStudyAnalysisMulti, createStudyDistributionFormula, createStudyTest, createStudyTestMulti, 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

Constructor Detail

StudyInteractive

public StudyInteractive()

Method Detail

getAxis

public int getAxis()

Gets the Axis. For more detail see setAxis(int).

isInteractive

public boolean isInteractive()

Gets the Interactive. For more detail see setInteractive(boolean).

isVisible

public boolean isVisible()

Gets the Visible. For more detail see setVisible(boolean).

setAxis

public void setAxis(int value)

Gets or sets a value indicating the Axis a StudyInteractive object is associated.

Remarks:

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

StudyInteractive si1 = (StudyInteractive) statistics1.getStudies().addAnalysis(Analysis.LOWER_QUARTILE);


Use the setVisible(boolean) property to show or hide a selected StudyInteractive study in a chart.

The setInteractive(boolean) property allows you to configure whether end users will be able to control a selected study or not.

See Also:

setInteractive(boolean), setVisible(boolean)

setInteractive

public void setInteractive(boolean value)

Gets or sets a value specifying whether or not the user will have access to interact with the selected study.

Remarks:

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

StudyInteractive si1 = (StudyInteractive) statistics1.getStudies().AddAnalysis(Analysis.LOWER_QUARTILE);


When this property is set to false, the checkbox for the selected study is not visible. Therefore, users do not have the ability to interact with the chart via the selected study.

The setVisible(boolean) property may be used to show or hide the selected study in the chart.

See Also:

setVisible(boolean), Statistics.getStudies(), StudiesCollection.add(java.lang.Object), StudiesCollection, Statistics

setVisible

public void setVisible(boolean value)

Gets or sets a value specifying whether or not the StudyInteractive object will be visible in the chart.

Remarks:

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

StudyInteractive si1 = (StudyInteractive) statistics1.getStudies().addAnalysis(Analysis.MEAN);


When this property is set to true, the study and cooresponding ConstantLine/Stripe/ErrorBar/Line will be visible in the chart. The setInteractive(boolean) property allows you to specify whether end users may interact with the study. If Interactive is set to true, users may change the value of the Visible property by checking and unchecking the study's checkbox in the chart legend.

See Also:

setInteractive(boolean), Statistics.getStudies(), StudiesCollection.add(java.lang.Object), StudiesCollection, Statistics