oracle.dss.graph
Class Y1Axis

oracle.dss.graph.BaseGraphComponent
  |
  +--oracle.dss.graph.BaseDataAxis
        |
        +--oracle.dss.graph.Y1Axis

All Implemented Interfaces:

Formattable, Visible

public class Y1Axis

extends BaseDataAxis

A numeric axis on a line, bar, area, scatter, bubble or stock market graph. This usually represents a range of quantities, such as dollars. On most graphs, it is the left-hand vertical axis. On horizontal graphs, this it is the top horizontal axis.

Fields inherited from class oracle.dss.graph.BaseGraphComponent

AL_BOTH, AL_LEFT, AL_RIGHT, AP_ALWAYS, AP_NEVER, AR_HORIZ_ROTATE_270, AR_HORIZ_ROTATE_90, AR_NO_ROTATE, DY2_AUTO_ASSIGN, DY2_FALSE, DY2_TRUE, FS_BOLD, FS_BOLD_ITALIC_UNDERLINE, FS_BOLD_UNDERLINE, FS_ITALIC, FS_ITALIC_BOLD, FS_ITALIC_UNDERLINE, FS_PLAIN, FS_UNDERLINE, FT_COLOR, FT_EXPONENTIAL, FT_GRADIENT, FT_LINEAR, FT_LOGARITHMIC, FT_NONE, FT_TEXTURE, GD_DIAGONAL_135, GD_DIAGONAL_45, GD_DOWN, GD_DOWN_LEFT, GD_DOWN_RIGHT, GD_LEFT, GD_RADIAL, GD_RADIAL_BOTTOM_LEFT, GD_RADIAL_BOTTOM_RIGHT, GD_RADIAL_TOP_LEFT, GD_RADIAL_TOP_RIGHT, GD_RIGHT, GD_UP, GD_UP_LEFT, GD_UP_RIGHT, GS_EXTENDED, GS_GRID, GS_IN, GS_OUT, GS_SPAN, LAP_BOTTOM, LAP_LEFT, LAP_RIGHT, LAP_TOP, LD_PERCENT, LD_TEXT, LD_TEXT_PERCENT, LD_VALUE, LEGENDMARKERSLIMIT, LO_AUTOMATIC, LO_HORIZONTAL, LO_VERTICAL, LP_INSIDE, LP_NO_LABELS, LP_OUTSIDE_WITH_FEELER, LP_OUTSIDE_WITHOUT_FEELER, LTP_ABOVE, LTP_BELOW, LTP_ON_LEFT, LTP_ON_MARKER, LTP_ON_RIGHT, MS_AUTOMATIC, MS_CIRCLE, MS_DIAMOND, MS_NONE, MS_PLUS, MS_SQUARE, MS_TRIANGLE_DOWN, MS_TRIANGLE_UP, MT_AREA, MT_BAR, MT_DEFAULT, MT_MARKER, MTP_CENTER, MTP_CUSTOM, MTP_INSIDE_MAX, MTP_INSIDE_MIN, MTP_ON_MAXEDGE, MTP_OUTSIDE_MAX, QUADRANTLINEVALUELIMIT, TDM_STRETCHED, TDM_TILED, TLS_AUTOMATIC, TLS_MANUAL, TLS_NOSKIP, TR_HORIZ, TR_HORIZ_ROTATE_270, TR_HORIZ_ROTATE_90, VF_STOCK_VOLUME, VF_X1, VF_Y1, VF_Y2, VF_Z

Method Summary

double	getAxisMaxAutoValue() Retrieves the high value of the automatic range for this axis.
double	getAxisMaxValue() Retrieves the high value for the range of this axis, when the high value is not set automatically.
double	getAxisMinAutoValue() Retrieves the low value for the automatic range of this axis.
double	getAxisMinValue() Retrieves the low value for the range of this axis, when the low value is not set automatically.
double	getMajorTickStep() Retrieves the number of tick marks that the graph hides between tick marks that are displayed on this data axis.
boolean	isAxisAutoScaledFromZero() Indicates whether the automatic range on this axis begins with zero.
boolean	isAxisMaxAutoScaled() Indicates whether the graph automatically sets the high value for this axis.
boolean	isAxisMinAutoScaled() Indicates whether the graph automatically sets the minimum value for this axis.
boolean	isMajorTickStepAutomatic() This method is not really required to be overridden we are waiting for the Perspective enhancement.
void	setAxisAutoScaledFromZero(boolean yesNo) Specifies whether the automatic range on this axis begins with zero.
void	setAxisMaxAutoScaled(boolean yesNo) Specifies whether the graph automatically sets the high value for this axis.
void	setAxisMaxValue(double value) Specifies the high value for the range of this axis, when the high value is not set automatically.
void	setAxisMinAutoScaled(boolean yesNo) Specifies whether the graph automatically sets the the minimum value for this axis.
void	setAxisMinValue(double value) Specifies the low value for the range of this axis, when the low value is not set automatically.
void	setMajorTickStep(double value) Specifies the number of tick marks that the graph hides between tick marks that are displayed on this data axis.
void	setMajorTickStepAutomatic(boolean yesNo) This method is not really required to be overridden we are waiting for the Perspective enhancement.
void	setVisible(boolean visible) Specifies whether this axis is visible.

Methods inherited from class oracle.dss.graph.BaseDataAxis

getAxisLocation, getDataEndPoints, getLineColor, getLineWidth, getLogarithmicBase, getMinAutoMajorTickStep, getViewFormat, isAscending, isAxisMaxLabelVisible, isAxisMinLabelVisible, isScaledLogarithmic, isVisible, selectObject, setAscending, setAxisLocation, setAxisMaxLabelVisible, setAxisMinLabelVisible, setLineColor, setLineWidth, setLogarithmicBase, setMinAutoMajorTickStep, setScaledLogarithmic, setViewFormat

Method Detail

isAxisAutoScaledFromZero

public boolean isAxisAutoScaledFromZero()

Indicates whether the automatic range on this axis begins with zero.

Overrides:

isAxisAutoScaledFromZero in class BaseDataAxis

Returns:

true if it begins with zero, false if it begins with the lowest data value on the axis.

setAxisAutoScaledFromZero

public void setAxisAutoScaledFromZero(boolean yesNo)

Specifies whether the automatic range on this axis begins with zero.

Overrides:

setAxisAutoScaledFromZero in class BaseDataAxis

Parameters:

yesNo - true if it begins with zero, false if it begins with the lowest data value on the axis.

isAxisMaxAutoScaled

public boolean isAxisMaxAutoScaled()

Indicates whether the graph automatically sets the high value for this axis. When this method returns false, the graph uses the value that is set in the setAxisMaxValue method.

Overrides:

isAxisMaxAutoScaled in class BaseDataAxis

Returns:

true if the high value is automatically set, false if the graph uses the value that is set in the setAxisMaxValue method.

setAxisMaxAutoScaled

public void setAxisMaxAutoScaled(boolean yesNo)

Specifies whether the graph automatically sets the high value for this axis. When you set this method to false, the graph uses the value that is set in the setAxisMaxValue method.

Overrides:

setAxisMaxAutoScaled in class BaseDataAxis

Parameters:

yesNo - true to make the graph set the high value automatically, false to make the graph use the value that is set in the setAxisMaxValuemethod.

isAxisMinAutoScaled

public boolean isAxisMinAutoScaled()

Indicates whether the graph automatically sets the minimum value for this axis. When this method is set to false, the graph uses the value that is set in the setAxisMinValue method.

Overrides:

isAxisMinAutoScaled in class BaseDataAxis

Returns:

true if the minimum value is set automatically, false if the graph uses the value that is set in the setAxisMinValue method.

setAxisMinAutoScaled

public void setAxisMinAutoScaled(boolean yesNo)

Specifies whether the graph automatically sets the the minimum value for this axis. When you set this method to false, the graph uses the value that is set in the setAxisMinValue method.

Overrides:

setAxisMinAutoScaled in class BaseDataAxis

Returns:

true to make the graph set the minimum value automatically, false to make the graph use the value that is set in the setAxisMinValue method.

getAxisMaxAutoValue

public double getAxisMaxAutoValue()

Retrieves the high value of the automatic range for this axis.

Overrides:

getAxisMaxAutoValue in class BaseDataAxis

Returns:

The high value of the automatic range for this axis.

getAxisMaxValue

public double getAxisMaxValue()

Retrieves the high value for the range of this axis, when the high value is not set automatically. To make the axis use the value that this method returns, set the setAxisMaxAutoScaled method to false.

Overrides:

getAxisMaxValue in class BaseDataAxis

Returns:

The high value for the range of this axis, when the high value is not set automatically.

setAxisMaxValue

public void setAxisMaxValue(double value)

Specifies the high value for the range of this axis, when the high value is not set automatically. To make the axis use the parameter value that is passed by this method, set the setAxisMaxAutoScaled method to false.

Overrides:

setAxisMaxValue in class BaseDataAxis

Parameters:

value - The high value for the range of this axis, when the high value is not set automatically.

getAxisMinAutoValue

public double getAxisMinAutoValue()

Retrieves the low value for the automatic range of this axis.

Overrides:

getAxisMinAutoValue in class BaseDataAxis

Returns:

The low value for the automatic range of this axis.

getAxisMinValue

public double getAxisMinValue()

Retrieves the low value for the range of this axis, when the low value is not set automatically. To make the axis use the value that this method returns, set the setAxisMinAutoScaled method to false.

Overrides:

getAxisMinValue in class BaseDataAxis

Returns:

The low value for the range of this axis, when the low value is not set automatically.

setAxisMinValue

public void setAxisMinValue(double value)

Specifies the low value for the range of this axis, when the low value is not set automatically. To make the axis use the parameter value that is passed by this method, set the setAxisMinAutoScaled method to false.

Overrides:

setAxisMinValue in class BaseDataAxis

Parameters:

value - The low value for the range of this axis, when the low value is not set automatically.

getMajorTickStep

public double getMajorTickStep()

Retrieves the number of tick marks that the graph hides between tick marks that are displayed on this data axis. For example, if you set MajorTickStep to 10, then the tick marks appear at 0, 10, 20, 30, and so on. (This assumes that AxisAutoScaledFromZero and AxisMinAutoScaled are both set to true.)

To make the graph use the value that this method returns, set the setMajorTickStepAutomatic method to false.

Overrides:

getMajorTickStep in class BaseDataAxis

Returns:

The interval (or step) at which to tick marks are displayed on this data axis.

See Also:

setMajorTickStepAutomatic(boolean)

setMajorTickStep

public void setMajorTickStep(double value)

Specifies the number of tick marks that the graph hides between tick marks that are displayed on this data axis. For example, if you set MajorTickStep to 10, then the tick marks appear at 0, 10, 20, 30, and so on. (This assumes that AxisAutoScaledFromZero and AxisMinAutoScaled are both set to true.)

To make the graph use the value that is set in this method, set the setMajorTickStepAutomatic method to false.

Overrides:

setMajorTickStep in class BaseDataAxis

Parameters:

value - The interval (or step) at which to display tick marks on this data axis.

See Also:

setMajorTickStepAutomatic(boolean)

isMajorTickStepAutomatic

public boolean isMajorTickStepAutomatic()

This method is not really required to be overridden we are waiting for the Perspective enhancement. Indicates whether the number of tick marks that the graph hides between tick marks that are displayed is calculated automatically.

Overrides:

isMajorTickStepAutomatic in class BaseDataAxis

Returns:

true if the number is calculated automatically, false if it is set in the setMajorTickStep method.

setMajorTickStepAutomatic

public void setMajorTickStepAutomatic(boolean yesNo)

This method is not really required to be overridden we are waiting for the Perspective enhancement. Specifies whether the number of tick marks that the graph hides between tick marks that are displayed is calculated automatically.

Overrides:

setMajorTickStepAutomatic in class BaseDataAxis

Parameters:

yesNo - true to make the graph calculate it automatically, false to make the graph use the value that is set in the setMajorTickStep method.

setVisible

public void setVisible(boolean visible)

Specifies whether this axis is visible.

Overrides:

setVisible in class BaseDataAxis

Parameters:

visible - true to make it visible, false to make it invisible.