com.softwarefx.chartfx.server.statistical

Class StudyInteractive

java.lang.Object

com.softwarefx.chartfx.server.statistical.Study

com.softwarefx.chartfx.server.statistical.StudyInteractive

All Implemented Interfaces:

IStudy

Direct Known Subclasses:

StudyConstant, StudyCustom, StudyLine, StudyStripe, StudyZScores

public 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

Constructors

Constructor and Description
StudyInteractive()

Method Summary

Methods

Modifier and Type	Method and Description
Axis	getAxis() Gets or sets a value indicating the Axis a StudyInteractive object is associated.
boolean	isInteractive() Gets or sets a value specifying whether or not the user will have access to interact with the selected study.
boolean	isVisible() Gets or sets a value specifying whether or not the StudyInteractive object will be visible in the chart.
void	resetInteractive() Set the property Interactive to its default value.
void	resetVisible() Set the property Visible to its default value.
void	setAxis(Axis 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 com.softwarefx.chartfx.server.statistical.Study

createAnalysisMultiStudy, createAnalysisStudy, createDistributionFormulaStudy, createTestMultiStudy, createTestStudy, getColor, getDecimals, getID, getText, getValue, getValue, isBold, isIndented, resetBold, resetDecimals, resetIndented, resetText, 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 Axis getAxis()

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

setAxis

public void setAxis(Axis value)

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

Parameters:

value -

isInteractive

public boolean isInteractive()

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

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

When this method 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 isVisible method may be used to show or hide the selected study in the chart.

To configure a selected StudyInteractive object to be non-interactive:

Specified by:

isInteractive in interface IStudy

Overrides:

isInteractive in class Study

See Also:

resetInteractive

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.

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

When this method 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 isVisible method may be used to show or hide the selected study in the chart.

To configure a selected StudyInteractive object to be non-interactive:

Parameters:

value -

See Also:

resetInteractive

isVisible

public boolean isVisible()

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

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

• When this method is set to true, the study and cooresponding ConstantLine/Stripe/ErrorBar/Line will be visible in the chart. The isInteractive method 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 isVisible method by checking and unchecking the study's checkbox in the chart legend.

To configure the selected StudyInteractive object to be visible in the chart:

Specified by:

isVisible in interface IStudy

Overrides:

isVisible in class Study

See Also:

resetVisible

setVisible

public void setVisible(boolean value)

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

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

• When this method is set to true, the study and cooresponding ConstantLine/Stripe/ErrorBar/Line will be visible in the chart. The isInteractive method 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 isVisible method by checking and unchecking the study's checkbox in the chart legend.

To configure the selected StudyInteractive object to be visible in the chart:

Specified by:

setVisible in interface IStudy

Overrides:

setVisible in class Study

Parameters:

value -

See Also:

resetVisible

resetInteractive

public void resetInteractive()

Set the property Interactive to its default value.

See Also:

isInteractive

resetVisible

public void resetVisible()

Set the property Visible to its default value.

See Also:

isVisible