SoftwareFX.ChartFX.Statistical
Class StudyStripe

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

public final class StudyStripe
extends StudyInteractive

Provides access to the StudyStripe object.

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

Constructor Summary

StudyStripe(int studyType, int id, int stripeType)

Method Summary

java.awt.Color	getColor() Gets the Color.
java.lang.Object[]	getStripes() Returns the collection of stripes associated with a StudyStripe object.
int	getType() Gets the Type.
void	setColor(java.awt.Color value) Gets or sets the color for a selected StudyStripe object;
void	setType(int value) Gets or sets the type for a StudyStripe object.

Methods inherited from class SoftwareFX.ChartFX.Statistical.StudyInteractive

getAxis, isInteractive, isVisible, setAxis, setInteractive, setVisible

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

StudyStripe

public StudyStripe(int studyType,
                   int id,
                   int stripeType)

Method Detail

getColor

public java.awt.Color getColor()

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

getStripes

public java.lang.Object[] getStripes()

Returns the collection of stripes associated with a StudyStripe object.

Remarks:

All the useful visual attributes have been exposed in the Study class. However, this could be useful for quickly assigning attributes to the entire collection of stripes at one time.

See Also:

Study

getType

public int getType()

Gets the Type. For more detail see setType(int).

setColor

public void setColor(java.awt.Color value)

Gets or sets the color for a selected StudyStripe object;

Remarks:

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

StudyStripe ss1 = (StudyStripe) statistics1.getStudies().addAnalysis(Analysis.LOWER_QUARTILE);


See Also:

Statistics.getStudies(), StudiesCollection, Statistics

setType

public void setType(int value)

Gets or sets the type for a StudyStripe object.

Values:

StripeType : StripeType

Value	Description
StripeType.MIDDLE	Middle.
StripeType.UNDER	Under.
StripeType.OVER	Over.

Remarks:

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

StudyStripe ss1 = (StudyStripe) statistics1.getStudies().addAnalysis(Analysis.LOWER_QUARTILE);


This property allows you to configure the stripe how to paint relative to the plotted data (Middle, Over or Under);

See Also:

Statistics.getStudies(), setColor(java.awt.Color), getStripes(), Statistics, StudiesCollection