oracle.dss.graph
Class Y1Axis

java.lang.Object
  oracle.dss.dataView.BaseComponentXML
      oracle.dss.graph.BaseGraphComponent
          oracle.dss.graph.BaseDataAxis
              oracle.dss.graph.Y1Axis

All Implemented Interfaces:

Formattable, ViewFormatCallback, Line, Visible, BaseViewFormatCallback

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.

Field Summary

Fields inherited from class oracle.dss.graph.BaseDataAxis

a_ascending, a_axisLocation, a_axisMaxLabelVisible, a_axisMinLabelVisible, a_minAutoMajorTickStep, m_id, m_identObj2, m_labelIdentObj, m_majorGridIdentObj, m_minorGridIdentObj, m_viewFormat

Fields inherited from class oracle.dss.graph.BaseGraphComponent

a_assignedToY2, a_association, a_automaticRotation, a_axisAutoScaledFromZero, a_axisMaxAutoScaled, a_axisMaxValue, a_axisMinAutoScaled, a_axisMinValue, a_axisZoomMaxValue, a_axisZoomMinValue, a_backGround, a_borderStyle, a_borderTransparent, a_borderUsingDefaults, a_borderWidth, a_color, a_defaultAssignedToY2, a_defaultBorderColor, a_defaultBorderTransparent, a_defaultColor, a_defaultFitlineType, a_defaultLineWidth, a_defaultMarkerColor, a_defaultMarkerShape, a_defaultMarkerType, a_displayedInLegend, a_explicitEnd, a_explicitStart, a_fitlineType, a_focusFactor, a_group, a_height, a_high_value, a_horizontalAlignment, a_imageSource, a_isometricProjection, a_labelPosition, a_legendMarkersPerRow, a_legendOrientation, a_legendTextPosition, a_lightSourceX, a_lightSourceY, a_lightSourceZ, a_line_value, a_lineColor, a_lineIndex, a_lineStyle, a_lineWidth, a_location, a_logarithmicBase, a_low_value, a_majorTickStep, a_majorTickStepAutomatic, a_markerColor, a_markerShape, a_markerSize, a_markersPerRowAutomatic, a_markerTextAngleDefault, a_markerTextPlace, a_markerTextRadiusDefault, a_markerType, a_minorTickStep, a_minorTickStepType, a_mode, a_panX, a_panY, a_pieSliceExplode, a_quadrantLineCountX, a_quadrantLineCountY, a_quadrantLineValueX, a_quadrantLineValueY, a_rendered, a_rollover_behavior, a_scaledLogarithmic, a_series, a_sharePanelProperties, a_sizeX, a_sizeY, a_sizeZ, a_skippedWithLabels, a_squareRisers, a_text, a_textFittingAutomatic, a_textRotation, a_textType, a_thresholdMaxValue, a_thresholdMinValue, a_tickLabelSkipCount, a_tickLabelSkipFirst, a_tickLabelSkipMode, a_tickLabelStaggered, a_tickLabelWrapped, a_tickStyle, a_translationX, a_translationY, a_translationZ, a_transparent, a_type, a_verticalAlignment, a_viewerX, a_viewerY, a_viewerZ, a_visibility, a_visible, a_wallThickX, a_wallThickY, a_wallThickZ, a_width, a_wordWrapEnabled, a_x, a_xValue, a_y, a_yValue, a_yValueAssignment, a_zoomFactor, al_both, AL_BOTH, al_left, AL_LEFT, al_right, AL_RIGHT, ap_always, AP_ALWAYS, ap_never, AP_NEVER, ar_horiz_rotate_270, AR_HORIZ_ROTATE_270, ar_horiz_rotate_90, AR_HORIZ_ROTATE_90, ar_no_rotate, AR_NO_ROTATE, dy2_auto_assign, DY2_AUTO_ASSIGN, dy2_false, DY2_FALSE, dy2_true, DY2_TRUE, FP_LG_CHECK, FP_LG_CROSSHATCH, FP_LG_DIAG_UP_LT, FP_LG_DIAG_UP_RT, FP_LG_DIAMOND_CHECK, FP_LG_TRIANGLE_CHECK, FP_MAX, FP_SM_CHECK, FP_SM_CROSSHATCH, FP_SM_DIAG_UP_LT, FP_SM_DIAG_UP_RT, FP_SM_DIAMOND_CHECK, FP_SM_TRIANGLE_CHECK, fs_bold, FS_BOLD, fs_bold_italic_underline, FS_BOLD_ITALIC_UNDERLINE, fs_bold_underline, FS_BOLD_UNDERLINE, fs_italic, FS_ITALIC, fs_italic_bold, FS_ITALIC_BOLD, fs_italic_underline, FS_ITALIC_UNDERLINE, fs_plain, FS_PLAIN, fs_underline, FS_UNDERLINE, ft_color, FT_COLOR, ft_exponential, FT_EXPONENTIAL, ft_gradient, FT_GRADIENT, ft_linear, FT_LINEAR, ft_logarithmic, FT_LOGARITHMIC, ft_none, FT_NONE, FT_PATTERN, ft_texture, FT_TEXTURE, gd_diagonal_135, GD_DIAGONAL_135, gd_diagonal_45, GD_DIAGONAL_45, gd_down, GD_DOWN, gd_down_left, GD_DOWN_LEFT, gd_down_right, GD_DOWN_RIGHT, gd_left, GD_LEFT, gd_radial, GD_RADIAL, gd_radial_bottom_left, GD_RADIAL_BOTTOM_LEFT, gd_radial_bottom_right, GD_RADIAL_BOTTOM_RIGHT, gd_radial_top_left, GD_RADIAL_TOP_LEFT, gd_radial_top_right, GD_RADIAL_TOP_RIGHT, gd_right, GD_RIGHT, gd_up, GD_UP, gd_up_left, GD_UP_LEFT, gd_up_right, GD_UP_RIGHT, gs_automatic, GS_AUTOMATIC, gs_extended, GS_EXTENDED, gs_grid, GS_GRID, gs_in, GS_IN, gs_none, GS_NONE, gs_out, GS_OUT, gs_span, GS_SPAN, lap_bottom, LAP_BOTTOM, lap_left, LAP_LEFT, lap_right, LAP_RIGHT, lap_top, LAP_TOP, ld_percent, LD_PERCENT, ld_text, LD_TEXT, ld_text_percent, LD_TEXT_PERCENT, ld_value, LD_VALUE, LEGENDMARKERSLIMIT, lo_automatic, LO_AUTOMATIC, lo_horizontal, LO_HORIZONTAL, lo_vertical, LO_VERTICAL, lp_inside, LP_INSIDE, lp_no_labels, LP_NO_LABELS, lp_outside_feeler_if_needed, LP_OUTSIDE_FEELER_IF_NEEDED, lp_outside_with_feeler, LP_OUTSIDE_WITH_FEELER, lp_outside_without_feeler, LP_OUTSIDE_WITHOUT_FEELER, ls_dash, LS_DASH, ls_dash_dot, LS_DASH_DOT, ls_dotted, LS_DOTTED, ls_solid, LS_SOLID, ltp_above, LTP_ABOVE, ltp_below, LTP_BELOW, ltp_on_left, LTP_ON_LEFT, ltp_on_marker, LTP_ON_MARKER, ltp_on_right, LTP_ON_RIGHT, m_commonGraph, m_identObj, m_pfj, ms_automatic, MS_AUTOMATIC, ms_circle, MS_CIRCLE, ms_diamond, MS_DIAMOND, ms_human, MS_HUMAN, ms_none, MS_NONE, ms_plus, MS_PLUS, ms_square, MS_SQUARE, ms_triangle_down, MS_TRIANGLE_DOWN, ms_triangle_up, MS_TRIANGLE_UP, mt_area, MT_AREA, mt_bar, MT_BAR, mt_centered_stepped_line, MT_CENTERED_STEPPED_LINE, MT_CURVE_AREA, mt_curve_line, MT_CURVE_LINE, mt_default, MT_DEFAULT, mt_marker, MT_MARKER, mt_stepped_line, MT_STEPPED_LINE, mtp_center, MTP_CENTER, mtp_custom, MTP_CUSTOM, mtp_inside_max, MTP_INSIDE_MAX, mtp_inside_min, MTP_INSIDE_MIN, mtp_on_maxedge, MTP_ON_MAXEDGE, mtp_outside_max, MTP_OUTSIDE_MAX, QUADRANTLINEVALUELIMIT, ro_area, RO_AREA, ro_back, RO_BACK, ro_front, RO_FRONT, ro_line, RO_LINE, sv_hidden, SV_HIDDEN, sv_visible, SV_VISIBLE, tdm_stretched, TDM_STRETCHED, tdm_tiled, TDM_TILED, tls_automatic, TLS_AUTOMATIC, tls_manual, TLS_MANUAL, tls_noskip, TLS_NOSKIP, tr_horiz, TR_HORIZ, tr_horiz_rotate_270, TR_HORIZ_ROTATE_270, tr_horiz_rotate_90, TR_HORIZ_ROTATE_90, tsm_explicit, TSM_EXPLICIT, tsm_off, TSM_OFF, va_bottom, va_center, va_top, VF_PIE_SLICE_LABEL, VF_STOCK_VOLUME, VF_X1, VF_Y1, VF_Y2, VF_Z

Fields inherited from class oracle.dss.dataView.BaseComponentXML

m_jsfHashMap

Constructor Summary

Y1Axis(CommonGraph graph)

Method Summary

double	getAutoMajorTickStep()
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	getAxisZoomMaxValue() Retrieves the high value for the range that the axis can zoom to, when the high value is not set automatically.
double	getAxisZoomMinValue() Retrieves the low value for the range that the axis can zoom to, when the low value is not set automatically.
protected java.lang.String	getComponentName()
double	getMajorTickStep() Retrieves the number of tick marks that the graph hides between tick marks that are displayed on this data axis.
double	getMinorTickStep() Retrieves the number of minor 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	setAxisZoomMaxValue(double value) Specifies the high value for the range that the axis can zoom to, when the high value is not set automatically.
void	setAxisZoomMinValue(double value) Specifies the low value for the range that the axis can zoom to, 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	setMinorTickStep(double value) Specifies the number of minor tick marks that the graph hides between tick marks that are displayed on this data axis.
void	setVisible(boolean visible) Specifies whether this axis is visible.

Methods inherited from class oracle.dss.graph.BaseDataAxis

convertAxisLocationToInt, convertAxisLocationToString, formatChanged, getAxisLocation, getDataEndPoints, getDataEndPoints, getLineColor, getLineWidth, getLogarithmicBase, getMajorTickStepXML, getMinAutoMajorTickStep, getMinorTickStepType, getMinorTickStepXML, getNonstyleXML, getStyleXML, getViewFormat, isAscending, isAxisMaxLabelVisible, isAxisMinLabelVisible, isScaledLogarithmic, isVisible, resetStyle, resetToDefault, selectObject, setAscending, setAxisLocation, setAxisMaxLabelVisible, setAxisMinLabelVisible, setLineColor, setLineWidth, setLogarithmicBase, setMajorTickStepXML, setMinAutoMajorTickStep, setMinorTickStepType, setMinorTickStepXML, setNonstyleXML, setScaledLogarithmic, setStyleXML, setViewFormat

Methods inherited from class oracle.dss.graph.BaseGraphComponent

convertAssociationToInt, convertFillPatternToString, convertGradientDirectionToString, convertHorizontalAlignmentToInt, convertHorizontalAlignmentToString, convertLineStyleToInt, convertLineStyleToString, convertLocationToInt, convertTextRotationtToInt, convertTickStyleToInt, convertTypeToInt, hexStringToInt, toHexString

Methods inherited from class oracle.dss.dataView.BaseComponentXML

getStyleXML, getXML, setNonstyleXML, setXML, setXML, setXML, setXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Y1Axis

public Y1Axis(CommonGraph graph)

Parameters:

graph - The Graph that this object belongs to.

For internal use only. Application developers should not use this

Constructor. Application developers should not have to construct this object, because the graph does it automatically.

Method Detail

isAxisAutoScaledFromZero

public boolean isAxisAutoScaledFromZero()

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

Specified by:

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.

Specified by:

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.

Specified by:

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.

See Also:

BaseDataAxis.setAxisMaxValue(double)

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.

Specified by:

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.

See Also:

BaseDataAxis.setAxisMaxValue(double)

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.

Specified by:

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.

See Also:

BaseDataAxis.setAxisMinValue(double)

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.

Specified by:

setAxisMinAutoScaled in class BaseDataAxis

Parameters:

yesNo - 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.

See Also:

BaseDataAxis.setAxisMinValue(double)

getAxisMaxAutoValue

public double getAxisMaxAutoValue()

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

Specified by:

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.

Specified by:

getAxisMaxValue in class BaseDataAxis

Returns:

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

See Also:

BaseDataAxis.setAxisMaxAutoScaled(boolean)

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.

Specified by:

setAxisMaxValue in class BaseDataAxis

Parameters:

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

See Also:

BaseDataAxis.setAxisMaxAutoScaled(boolean)

getAxisMinAutoValue

public double getAxisMinAutoValue()

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

Specified by:

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.

Specified by:

getAxisMinValue in class BaseDataAxis

Returns:

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

See Also:

BaseDataAxis.setAxisMinAutoScaled(boolean)

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.

Specified by:

setAxisMinValue in class BaseDataAxis

Parameters:

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

See Also:

BaseDataAxis.setAxisMinAutoScaled(boolean)

getAxisZoomMaxValue

public double getAxisZoomMaxValue()

Retrieves the high value for the range that the axis can zoom to, 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.

Specified by:

getAxisZoomMaxValue in class BaseDataAxis

Returns:

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

setAxisZoomMaxValue

public void setAxisZoomMaxValue(double value)

Specifies the high value for the range that the axis can zoom to, 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.

Specified by:

setAxisZoomMaxValue in class BaseDataAxis

Parameters:

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

getAxisZoomMinValue

public double getAxisZoomMinValue()

Retrieves the low value for the range that the axis can zoom to, 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.

Specified by:

getAxisZoomMinValue in class BaseDataAxis

Returns:

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

setAxisZoomMinValue

public void setAxisZoomMinValue(double value)

Specifies the low value for the range that the axis can zoom to, 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.

Specified by:

setAxisZoomMinValue in class BaseDataAxis

Parameters:

value - The low value for the range of this zoom 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)

getMinorTickStep

public double getMinorTickStep()

Retrieves the number of minor tick marks that the graph hides between tick marks that are displayed on this data axis. For example, if you set MinorTickStep 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 setMinorTickStepAutomatic method to false.

Overrides:

getMinorTickStep in class BaseDataAxis

Returns:

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

See Also:

#setMinorTickStepAutomatic

getAutoMajorTickStep

public double getAutoMajorTickStep()

Specified by:

getAutoMajorTickStep in class BaseDataAxis

Returns:

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

See Also:

setMajorTickStepAutomatic(boolean)

For internal use only. Application developers should not use this

Retrieves the tick step value for this axis that is automatically calculated by pfj based on a data source. This value may change only when a data source changes, or the maximum or minimum scale value on Y1 axis changes.

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)

setMinorTickStep

public void setMinorTickStep(double value)

Specifies the number of minor tick marks that the graph hides between tick marks that are displayed on this data axis. For example, if you set MinorTickStep 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 setMinorTickStepAutomatic method to false.

Overrides:

setMinorTickStep in class BaseDataAxis

Parameters:

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

See Also:

#setMinorTickStepAutomatic

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.

See Also:

BaseDataAxis.setMajorTickStep(double)

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.

See Also:

BaseDataAxis.setMajorTickStep(double)

setVisible

public void setVisible(boolean visible)

Specifies whether this axis is visible.

Specified by:

setVisible in interface Visible

Overrides:

setVisible in class BaseDataAxis

Parameters:

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

getComponentName

protected java.lang.String getComponentName()

Overrides:

getComponentName in class BaseComponentXML

For internal use only. Application developers should not use this

Retrieves the name of the object.