oracle.dss.graph
Class Series

java.lang.Object
  oracle.dss.dataView.BaseComponentXML
      oracle.dss.graph.BaseGraphComponent
          oracle.dss.graph.Series

All Implemented Interfaces:

UISeriesColor

public class Series
extends BaseGraphComponent
implements UISeriesColor

The series component of the graph. A series usually represents a dimension member such as "Shoes" or "Boston".

Field Summary

protected boolean	m_isMarkerShapeSet
protected int	m_seriesCount
protected SFX[]	m_sfx
protected int	m_startSeries

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

Series(CommonGraph graph)

Method Summary

static int	convertAssignedToY2ToInt(java.lang.String string)
protected java.lang.String	convertAssignedToY2ToString(int value)
static int	convertFitlineTypeToInt(java.lang.String string)
protected java.lang.String	convertFitlineTypeToString(int value)
static int	convertMarkerShapeToInt(java.lang.String string)
static java.lang.String	convertMarkerShapeToString(int value)
static int	convertMarkerTypeToInt(java.lang.String string)
protected java.lang.String	convertMarkerTypeToString(int value)
static int	convertVisibilityToInt(java.lang.String string)
protected java.lang.String	convertVisibilityToString(int value)
protected void	displayMarkers() Ensures that marker shapes are looped properly when new data is set.
protected void	displayMarkers(int oldType)
java.awt.Color	getBorderColor(int series) Retrieves the border color for the markers of the series.
java.awt.Color	getColor(int series) Retrieves the fill color for the markers of the series.
protected java.lang.String	getComponentName()
int	getDefaultAssignedToY2() Retrieves the default axis assignment for series.
java.awt.Color	getDefaultBorderColor() Retrieves the default border color for the markers of all series.
java.awt.Color	getDefaultColor() Retrieves the default fill color of series.
int	getDefaultFitlineType() Retrieves the default type of fitline for all series.
int	getDefaultLineStyle() Retrieves the default style for the data lines of series.
int	getDefaultLineWidth() Retrieves the default width for the data lines of series.
java.awt.Color	getDefaultMarkerColor() Retrieves the default fill color for the markers of series.
int	getDefaultMarkerShape() Retrieves the default shape for the data makers of series.
int	getDefaultMarkerType() Retrieves the default type of markers used for series.
int	getFitlineType(int series) Retrieves the type of fitline for a series.
int	getLineStyle(int iSeries) Retrieves the style of the data line for the specified series.
int	getLineWidth(int series) Retrieves the width for the data line for the specified series.
java.awt.Color	getMarkerColor(int series) Retrieves the fill color for the markers of the series.
int	getMarkerShape(int series) Retrieves the shape for the data markers that belong to the series.
int	getMarkerType(int series) Retrieves the type of markers used for the series.
int	getPieSliceExplode(int series) Retrieves the distance that separates an exploded slice from the rest of the pie in a pie graph or from the rest of the ring in a ring graph.
protected boolean	getSeriesItemsXML(boolean allProperties, boolean allOverriddenProperties, oracle.dss.util.xml.ContainerNode node)
protected boolean	getSeriesXML(boolean allProperties, boolean allOverriddenProperties, oracle.dss.util.xml.ObjectNode seriesNode, int i)
SFX	getSFX(int series) Retrieves the SFX object for the series.
int	getVisibility(int series) Get the visibility of the series.
protected oracle.dss.util.xml.ContainerNode	getXML(boolean allProperties, boolean allOverriddenProperties)
boolean	isAssignedToY2(int series) Indicates whether the series of data is plotted against the Y2-axis.
boolean	isBorderTransparent(int series) Indicates whether the borders for the markers of the series are transparent.
boolean	isBorderUsingDefaults() Indicates whether the marker borders of all of the series in the graph are using the default color and transparency values.
boolean	isDefaultBorderTransparent() Indicates whether the borders for the markers of all series are transparent by default.
boolean	isTransparent(int series) Indicates whether the fill color for the markers of the series is transparent.
protected void	resetStyle()
void	setAssignedToY2(boolean yesNo, int series) Specifies whether the series of data is plotted against the Y2-axis.
void	setBorderColor(java.awt.Color newColor, int series) Specifies the border color for the markers of the series.
void	setBorderTransparent(boolean yesNo, int series) Specifies whether the borders for the markers of the series are transparent.
void	setBorderUsingDefaults(boolean yesNo) Specifies whether the marker borders of all of the series in the graph are using the default color and transparency values.
void	setColor(java.awt.Color newColor, int series) Specifies the fill color for the markers of the series.
void	setDefaultAssignedToY2(int assignedToY2) Specifies the default axis assignment for series.
void	setDefaultBorderColor(java.awt.Color newColor) Specifies the default border color for the markers of all series.
void	setDefaultBorderTransparent(boolean yesNo) Specifies whether the borders for the markers of all series are transparent by default.
void	setDefaultColor(java.awt.Color color) Specifies the default fill color of series.
void	setDefaultFitlineType(int type) Specifies the default type of fitline to use for series.
void	setDefaultLineWidth(int lineWidth) Specifies the default width for the data lines of series.
void	setDefaultMarkerColor(java.awt.Color color) Specifies the default fill color for the markers of series.
void	setDefaultMarkerShape(int markerShape) Specifies the default shape for the data markers of series.
void	setDefaultMarkerType(int markerType) Specifies the default marker type for series.
void	setFitlineType(int type, int series) Specifies the type of fitline, such as exponential, or logarithmic, to display for a series.
void	setLineStyle(int style, int iSeries) Specifies the style of the data line for the specified series.
void	setLineWidth(int width, int series) Specifies the width for the data lines for the specified series.
void	setMarkerColor(java.awt.Color newColor, int series) Specifies the fill color for the markers of the series.
void	setMarkerShape(int shape, int series) Specifies the shape for the data makers that belong to the series.
void	setMarkerType(int type, int series) Specifies the type of markers used for the series.
void	setPieSliceExplode(int explode, int series) Specifies how far the slices for the series are exploded.
protected void	setSeriesItemsXML(oracle.dss.util.xml.ContainerNode node)
protected void	setSeriesXML(oracle.dss.util.xml.ObjectNode seriesNode, int series, boolean allProperties, java.util.HashMap map)
void	setTransparent(boolean yesNo, int series) Specifies whether the fill color for the markers of the series is transparent.
void	setVisibility(int visibility, int series) Set the visibility of the series.
protected void	setXML(oracle.dss.util.xml.ContainerNode node, boolean allProperties)
protected void	setXML(oracle.dss.util.xml.ContainerNode node, boolean allProperties, java.util.HashMap map)

Methods inherited from class oracle.dss.graph.BaseGraphComponent

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

Methods inherited from class oracle.dss.dataView.BaseComponentXML

getNonstyleXML, getStyleXML, getStyleXML, getXML, setNonstyleXML, setNonstyleXML, setStyleXML, setXML, setXML, setXML, setXML

Methods inherited from class java.lang.Object

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

Field Detail

m_startSeries

protected int m_startSeries

For internal use only. Application developers should not use this

m_seriesCount

protected int m_seriesCount

For internal use only. Application developers should not use this

m_sfx

protected SFX[] m_sfx

For internal use only. Application developers should not use this

m_isMarkerShapeSet

protected boolean m_isMarkerShapeSet

Constructor Detail

Series

public Series(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

getSFX

public SFX getSFX(int series)
           throws SeriesOutOfRangeException

Retrieves the SFX object for the series. The SFX object allows you to retrieve and specify attributes for special effects.

When Graph.getSeriesEffect() returns Graph.SE_GRADIENT, any settings in the SFX object for the Series are ignored, and you cannot set new settings. To use the SFX settings, call Graph.setSeriesEffect(int), passing Graph.SE_NONE.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

The SFX object for the series.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

isAssignedToY2

public boolean isAssignedToY2(int series)
                       throws SeriesOutOfRangeException

Indicates whether the series of data is plotted against the Y2-axis.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

true if the series of data is plotted against the Y2-axis, false if it is plotted against the Y1-axis.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

setAssignedToY2

public void setAssignedToY2(boolean yesNo,
                            int series)
                     throws SeriesOutOfRangeException

Specifies whether the series of data is plotted against the Y2-axis.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

yesNo - true to plot the series of data against the Y2-axis, false to plot it against the Y1-axis.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

getBorderColor

public java.awt.Color getBorderColor(int series)
                              throws SeriesOutOfRangeException

Retrieves the border color for the markers of the series. To use the border color that this method returns, set the setBorderUsingDefaults method to false.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

The border color for the markers of the series.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

setBorderColor

public void setBorderColor(java.awt.Color newColor,
                           int series)
                    throws SeriesOutOfRangeException

Specifies the border color for the markers of the series. To use the border color that is set in this method, set the setBorderUsingDefaults method to false.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

newColor - The border color for the markers of the series.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

isBorderTransparent

public boolean isBorderTransparent(int series)
                            throws SeriesOutOfRangeException

Indicates whether the borders for the markers of the series are transparent. To make the markers of the series transparent, set both the setBorderTransparent and the setTransparent methods to true. When an attribute or an object is transparent, it is not visible, but you can select it. To use the value that this method returns, set the setBorderUsingDefaults method to false.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

true if the borders are transparent, false if the borders are visible.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

setBorderTransparent

public void setBorderTransparent(boolean yesNo,
                                 int series)
                          throws SeriesOutOfRangeException

Specifies whether the borders for the markers of the series are transparent. To make the markers of the series transparent, set both the setBorderTransparent and the setTransparent methods to true. When an attribute or an object is transparent, it is not visible, but you can select it. To use the boolean parameter value that is set in this method, set the setBorderUsingDefaults method to false.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

yesNo - true to make the borders transparent, false to make the borders visible.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

getColor

public java.awt.Color getColor(int series)
                        throws SeriesOutOfRangeException

Retrieves the fill color for the markers of the series.

Specified by:

getColor in interface UISeriesColor

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

The fill color for the markers of the series. For transparent fill color, this returns null.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

setColor

public void setColor(java.awt.Color newColor,
                     int series)
              throws SeriesOutOfRangeException

Specifies the fill color for the markers of the series.

Specified by:

setColor in interface UISeriesColor

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

newColor - The fill color for the markers of the series. If this is null, the fill color is made transparent.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

See Also:

Graph.getSeriesObjectCount()

getMarkerColor

public java.awt.Color getMarkerColor(int series)
                              throws SeriesOutOfRangeException

Retrieves the fill color for the markers of the series.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

The fill color for the markers of the series. For transparent fill color, this returns null.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

setMarkerColor

public void setMarkerColor(java.awt.Color newColor,
                           int series)
                    throws SeriesOutOfRangeException

Specifies the fill color for the markers of the series.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

newColor - The fill color for the markers of the series. If this is null, the fill color is made transparent.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

getDefaultBorderColor

public java.awt.Color getDefaultBorderColor()

Retrieves the default border color for the markers of all series. To use the border color that this object returns, set the setBorderUsingDefaults method to true.

Returns:

The default border color for the markers of all series.

setDefaultBorderColor

public void setDefaultBorderColor(java.awt.Color newColor)

Specifies the default border color for the markers of all series. To use the border color that this object sets, set the setBorderUsingDefaults method to true.

Parameters:

newColor - The default border color for the markers of all series.

isDefaultBorderTransparent

public boolean isDefaultBorderTransparent()

Indicates whether the borders for the markers of all series are transparent by default. When an attribute or an object is transparent, it is not visible, but you can select it. To use the value that this method returns, set the setBorderUsingDefaults method to true.

Returns:

true if the borders for the markers of all series are transparent by default, false if the graph uses the value that is set in the setBorderTransparent method for each series.

setDefaultBorderTransparent

public void setDefaultBorderTransparent(boolean yesNo)

Specifies whether the borders for the markers of all series are transparent by default. When an object is transparent, it is not visible, but you can select it. To use the parameter value that is set in this method, set the setBorderUsingDefaults method to true.

Parameters:

yesNo - true to make the borders for the markers of all series transparent by default, false to make the graph use the value that is set in the setBorderTransparent method for each series.

setFitlineType

public void setFitlineType(int type,
                           int series)
                    throws SeriesOutOfRangeException

Specifies the type of fitline, such as exponential, or logarithmic, to display for a series.

Parameters:

type - A constant that represents the type of fitline to use for this series. Valid constants are listed in the See Also section.

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

See Also:

Fitline, BaseGraphComponent.FT_LINEAR, BaseGraphComponent.FT_EXPONENTIAL, BaseGraphComponent.FT_LOGARITHMIC, BaseGraphComponent.FT_NONE

getFitlineType

public int getFitlineType(int series)
                   throws SeriesOutOfRangeException

Retrieves the type of fitline for a series.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

A constant that represents the type of fitline for this series. Valid constants are listed in the See Also section.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

See Also:

BaseGraphComponent.FT_LINEAR, BaseGraphComponent.FT_EXPONENTIAL, BaseGraphComponent.FT_LOGARITHMIC, BaseGraphComponent.FT_NONE

getLineWidth

public int getLineWidth(int series)
                 throws SeriesOutOfRangeException

Retrieves the width for the data line for the specified series.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

The width of the data line for the series.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

setLineWidth

public void setLineWidth(int width,
                         int series)
                  throws SeriesOutOfRangeException

Specifies the width for the data lines for the specified series.

The value that you set in this method takes effect only when the DepthRadius attribute of the graph is set to zero.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

width - The width to set for the data line for the series.

Throws:

SeriesOutOfRangeException - If series is less than zero or is greater than or equal to the value of the SeriesObjectCount attribute of the graph.

See Also:

Graph.setDepthRadius(int)

setLineStyle

public void setLineStyle(int style,
                         int iSeries)
                  throws SeriesOutOfRangeException

Specifies the style of the data line for the specified series.

The value that you set in this method takes effect only when the DepthRadius property of the graph is set to zero.

Parameters:

style - A constant that represents the style to set. Valid constants are listed in the See Also section.

iSeries - The index of the series. The values range from 0 to the value of Graph.getSeriesObjectCount minus 1.

Throws:

SeriesOutOfRangeException - If iSeries is less than zero or is greater than or equal to the value of the SeriesObjectCount attribute of the graph.

See Also:

BaseGraphComponent.LS_DASH, BaseGraphComponent.LS_DASH_DOT, BaseGraphComponent.LS_DOTTED, BaseGraphComponent.LS_SOLID

getLineStyle

public int getLineStyle(int iSeries)
                 throws SeriesOutOfRangeException

Retrieves the style of the data line for the specified series.

Parameters:

iSeries - The index of the series. The values range from 0 to the value of Graph.getSeriesObjectCount minus 1.

Returns:

A constant that represents the style of the data line for the series. Valid constants are listed in the See Also section.

Throws:

SeriesOutOfRangeException - If iSeries is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

See Also:

BaseGraphComponent.LS_DASH, BaseGraphComponent.LS_DASH_DOT, BaseGraphComponent.LS_DOTTED, BaseGraphComponent.LS_SOLID

getMarkerShape

public int getMarkerShape(int series)
                   throws SeriesOutOfRangeException

Retrieves the shape for the data markers that belong to the series. The MarkerShape property applies only to data markers that appear in line, scatter, and bubble graphs. It does not affect the shape of bars or slices.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

A constant that represents the shape for the data markers that belong to the series. Constants are listed in the See Also section.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

See Also:

BaseGraphComponent.MS_AUTOMATIC, BaseGraphComponent.MS_NONE, BaseGraphComponent.MS_CIRCLE, BaseGraphComponent.MS_DIAMOND, BaseGraphComponent.MS_PLUS, BaseGraphComponent.MS_SQUARE, BaseGraphComponent.MS_TRIANGLE_DOWN, BaseGraphComponent.MS_TRIANGLE_UP, BaseGraphComponent.MS_HUMAN

setMarkerShape

public void setMarkerShape(int shape,
                           int series)
                    throws SeriesOutOfRangeException

Specifies the shape for the data makers that belong to the series. The MarkerShape property applies only to data markers that appear in line, scatter, and bubble graphs. It does not affect the shape of bars or slices.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

shape - A constant that represents the shape for the data markers that belong to this series. Valid constants are listed in the See Also section.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

See Also:

BaseGraphComponent.MS_AUTOMATIC, BaseGraphComponent.MS_NONE, BaseGraphComponent.MS_CIRCLE, BaseGraphComponent.MS_DIAMOND, BaseGraphComponent.MS_PLUS, BaseGraphComponent.MS_SQUARE, BaseGraphComponent.MS_TRIANGLE_DOWN, BaseGraphComponent.MS_TRIANGLE_UP, BaseGraphComponent.MS_HUMAN

getMarkerType

public int getMarkerType(int series)
                  throws SeriesOutOfRangeException

Retrieves the type of markers used for the series. Markers that belong to the same series are the same type.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

The type of markers used for the series. Valid constants are listed in the See Also section.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

See Also:

BaseGraphComponent.MT_AREA, BaseGraphComponent.MT_BAR, BaseGraphComponent.MT_MARKER, BaseGraphComponent.MT_DEFAULT

setMarkerType

public void setMarkerType(int type,
                          int series)
                   throws SeriesOutOfRangeException

Specifies the type of markers used for the series. Markers that belong to the same series are the same type.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

type - The type of markers used for the series. Valid constants are listed in the See Also section.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

See Also:

BaseGraphComponent.MT_AREA, BaseGraphComponent.MT_BAR, BaseGraphComponent.MT_MARKER, BaseGraphComponent.MT_DEFAULT

getPieSliceExplode

public int getPieSliceExplode(int series)
                       throws SeriesOutOfRangeException

Retrieves the distance that separates an exploded slice from the rest of the pie in a pie graph or from the rest of the ring in a ring graph. Exploded slices are pulled apart from the rest of the pie or ring that they belong to. The values range from 0 to 100.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

How far the slices for the series are exploded.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

setPieSliceExplode

public void setPieSliceExplode(int explode,
                               int series)
                        throws SeriesOutOfRangeException

Specifies how far the slices for the series are exploded. Exploded slices are pulled apart from the rest of the pie that they belong to. The values range from 0 to 100.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

explode - How far the slices for the series are exploded.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

isTransparent

public boolean isTransparent(int series)
                      throws SeriesOutOfRangeException

Indicates whether the fill color for the markers of the series is transparent. To make the markers of this series transparent, set both the setBorderTransparent and the setTransparent methods to true. When an object is transparent, it is not visible, but you can select it.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

true if the fill color for the markers of the series is transparent, false if the fill color for the markers of this series is visible.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

setTransparent

public void setTransparent(boolean yesNo,
                           int series)
                    throws SeriesOutOfRangeException

Specifies whether the fill color for the markers of the series is transparent. To make the markers of this series transparent, set both the setBorderTransparent and the setTransparent methods to true. When an object is transparent, it is not visible, but you can select it.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

yesNo - true to make the fill color for the markers of the series transparent, false to make the fill color for the markers of this series visible.

Throws:

SeriesOutOfRangeException - If series is less than zero, or greater than or equal to the value of the SeriesObjectCount property of the graph.

SeriesOutOfRangeException

isBorderUsingDefaults

public boolean isBorderUsingDefaults()

Indicates whether the marker borders of all of the series in the graph are using the default color and transparency values. The default border color and transparency values are set in the setDefaultBorderColor method and the setDefaultBorderTransparent method.

Returns:

true if they use the default values, false if they use the values that are set in the setBorderColor method and the setBorderTransparent method.

setBorderUsingDefaults

public void setBorderUsingDefaults(boolean yesNo)

Specifies whether the marker borders of all of the series in the graph are using the default color and transparency values. The default border color and transparency values are set in the setDefaultBorderColor method and the setDefaultBorderTransparent method.

Parameters:

yesNo - true to make them use the default values, false to make them use the values that are set in the setBorderColor method and the setBorderTransparent method.

setDefaultColor

public void setDefaultColor(java.awt.Color color)

Specifies the default fill color of series.

Parameters:

color - The default fill color for the markers of series. If color is null, then the graph assigns its own default colors to series, repeating colors as necessary.

See Also:

setColor(java.awt.Color, int)

getDefaultColor

public java.awt.Color getDefaultColor()

Retrieves the default fill color of series.

Returns:

The default fill color for the markers of series. If color is null, then the graph assigns its own default colors to series, repeating colors as necessary.

See Also:

getColor(int)

setDefaultMarkerColor

public void setDefaultMarkerColor(java.awt.Color color)

Specifies the default fill color for the markers of series.

Parameters:

color - The default fill color for the markers of series. If color is null, then the graph assigns its own default colors to series, repeating colors as necessary.

See Also:

setMarkerColor(java.awt.Color, int)

getDefaultMarkerColor

public java.awt.Color getDefaultMarkerColor()

Retrieves the default fill color for the markers of series.

Returns:

The default fill color for the markers of series. If color is null, then the graph assigns its own default colors to series, repeating colors as necessary.

See Also:

getMarkerColor(int)

setDefaultMarkerType

public void setDefaultMarkerType(int markerType)

Specifies the default marker type for series. Markers in a single series have the same type. This method specifies a default type for all series.

Parameters:

markerType - The default type of markers used for series.

See Also:

BaseGraphComponent.MT_AREA, BaseGraphComponent.MT_BAR, BaseGraphComponent.MT_DEFAULT, BaseGraphComponent.MT_MARKER

getDefaultMarkerType

public int getDefaultMarkerType()

Retrieves the default type of markers used for series. Markers in a single series have the same type. This method specifies a default type for series.

Returns:

The default type of markers used for series.

See Also:

BaseGraphComponent.MT_AREA, BaseGraphComponent.MT_BAR, BaseGraphComponent.MT_DEFAULT, BaseGraphComponent.MT_MARKER

setDefaultMarkerShape

public void setDefaultMarkerShape(int markerShape)

Specifies the default shape for the data markers of series.

Parameters:

markerShape - A constant that represents the default shape for the data markers of series. Valid constants are listed in the See Also section. If marker shape is automatic, then the graph assigns its default shapes, repeating shapes if necessary.

See Also:

BaseGraphComponent.MS_CIRCLE, BaseGraphComponent.MS_DIAMOND, BaseGraphComponent.MS_NONE, BaseGraphComponent.MS_PLUS, BaseGraphComponent.MS_SQUARE, BaseGraphComponent.MS_TRIANGLE_DOWN, BaseGraphComponent.MS_TRIANGLE_UP, BaseGraphComponent.MS_HUMAN, BaseGraphComponent.MS_AUTOMATIC

getDefaultMarkerShape

public int getDefaultMarkerShape()

Retrieves the default shape for the data makers of series.

Returns:

A constant that represents the default shape for the data markers of series. Valid constants are listed in the See Also section. If the marker shape is automatic, then the graph assigns its default shapes, repeating shapes if necessary.

See Also:

BaseGraphComponent.MS_CIRCLE, BaseGraphComponent.MS_DIAMOND, BaseGraphComponent.MS_NONE, BaseGraphComponent.MS_PLUS, BaseGraphComponent.MS_SQUARE, BaseGraphComponent.MS_TRIANGLE_DOWN, BaseGraphComponent.MS_TRIANGLE_UP, BaseGraphComponent.MS_HUMAN, BaseGraphComponent.MS_AUTOMATIC

setDefaultLineWidth

public void setDefaultLineWidth(int lineWidth)

Specifies the default width for the data lines of series. All of the data lines are the same width.

The value that you set in this method takes effect only when the DepthRadius attribute of the graph is set to zero.

Parameters:

lineWidth - The default width for the data lines of series.

See Also:

Graph.setDepthRadius(int)

getDefaultLineWidth

public int getDefaultLineWidth()

Retrieves the default width for the data lines of series.

Returns:

The default width for the data lines of series.

getDefaultLineStyle

public int getDefaultLineStyle()

Retrieves the default style for the data lines of series.

Returns:

The default style for the data lines of series.

setDefaultAssignedToY2

public void setDefaultAssignedToY2(int assignedToY2)

Specifies the default axis assignment for series.

Parameters:

assignedToY2 - A constant that represents the default axis assignment. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.DY2_TRUE, BaseGraphComponent.DY2_FALSE, BaseGraphComponent.DY2_AUTO_ASSIGN

getDefaultAssignedToY2

public int getDefaultAssignedToY2()

Retrieves the default axis assignment for series.

Returns:

A constant that represents the default axis assignment. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.DY2_TRUE, BaseGraphComponent.DY2_FALSE, BaseGraphComponent.DY2_AUTO_ASSIGN

setDefaultFitlineType

public void setDefaultFitlineType(int type)

Specifies the default type of fitline to use for series. The graph supports linear, exponential, and logarithmic fitlines.

Parameters:

type - A constant that represents the default type of fitline for series. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.FT_EXPONENTIAL, BaseGraphComponent.FT_LOGARITHMIC, BaseGraphComponent.FT_LINEAR, BaseGraphComponent.FT_NONE

getDefaultFitlineType

public int getDefaultFitlineType()

Retrieves the default type of fitline for all series. The graph supports linear, exponential, and logarithmic fitlines.

Returns:

A constant that represents the default type of fitline for series. Valid constants are listed in the See Also section.

See Also:

BaseGraphComponent.FT_EXPONENTIAL, BaseGraphComponent.FT_LOGARITHMIC, BaseGraphComponent.FT_LINEAR, BaseGraphComponent.FT_NONE

setVisibility

public void setVisibility(int visibility,
                          int series)
                   throws SeriesOutOfRangeException

Set the visibility of the series.

Parameters:

visibility - The visibility of the series. Constants are defined in BaseGraphComponent and begin with SV_.

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Throws:

SeriesOutOfRangeException - If series is less than zero or is greater than or equal to the value of the SeriesObjectCount attribute of the graph.

See Also:

BaseGraphComponent.SV_VISIBLE, BaseGraphComponent.SV_HIDDEN

getVisibility

public int getVisibility(int series)
                  throws SeriesOutOfRangeException

Get the visibility of the series.

Parameters:

series - The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount minus 1.

Returns:

The visibility of the series. Constants are defined in BaseGraphComponent and begin with SV_.

Throws:

SeriesOutOfRangeException - If series is less than zero or is greater than or equal to the value of the SeriesObjectCount attribute of the graph.

See Also:

BaseGraphComponent.SV_VISIBLE, BaseGraphComponent.SV_HIDDEN

convertMarkerShapeToInt

public static int convertMarkerShapeToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts MarkerShape String constants to Integer constants. This is used by get/setXML().

convertMarkerTypeToInt

public static int convertMarkerTypeToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts MarkerType String constants to Integer constants. This is used by get/setXML().

convertFitlineTypeToInt

public static int convertFitlineTypeToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts FitlineType String constants to Integer constants. This is used by get/setXML().

convertAssignedToY2ToInt

public static int convertAssignedToY2ToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts AssignedToY2 String constants to Integer constants. This is used by get/setXML().

convertMarkerShapeToString

public static java.lang.String convertMarkerShapeToString(int value)

For internal use only. Application developers should not use this

Converts MarkerShape Integer constants to String constants. This is used by get/setXML().

convertMarkerTypeToString

protected java.lang.String convertMarkerTypeToString(int value)

For internal use only. Application developers should not use this

Converts MarkerType Integer constants to String constants. This is used by get/setXML().

convertFitlineTypeToString

protected java.lang.String convertFitlineTypeToString(int value)

For internal use only. Application developers should not use this

Converts FitlineType Integer constants to String constants. This is used by get/setXML().

convertAssignedToY2ToString

protected java.lang.String convertAssignedToY2ToString(int value)

For internal use only. Application developers should not use this

Converts AssignedToY2 Integer constants to String constants. This is used by get/setXML().

convertVisibilityToInt

public static int convertVisibilityToInt(java.lang.String string)

For internal use only. Application developers should not use this

Converts Visibility String constants to Integer constants. This is used by get/setXML().

convertVisibilityToString

protected java.lang.String convertVisibilityToString(int value)

For internal use only. Application developers should not use this

Converts Visibility Integer constants to String constants. This is used by get/setXML().

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

getXML

protected oracle.dss.util.xml.ContainerNode getXML(boolean allProperties,
                                                   boolean allOverriddenProperties)

For internal use only. Application developers should not use this

Gets XML from this Series object

getSeriesItemsXML

protected boolean getSeriesItemsXML(boolean allProperties,
                                    boolean allOverriddenProperties,
                                    oracle.dss.util.xml.ContainerNode node)

For internal use only. Application developers should not use this

Retrieves style attributes of SeriesItems to XML returns whether if the style is overridden

getSeriesXML

protected boolean getSeriesXML(boolean allProperties,
                               boolean allOverriddenProperties,
                               oracle.dss.util.xml.ObjectNode seriesNode,
                               int i)

For internal use only. Application developers should not use this

Retrieves style properties of Series to XML returns whether if the style is overridden

setXML

protected void setXML(oracle.dss.util.xml.ContainerNode node,
                      boolean allProperties,
                      java.util.HashMap map)

For internal use only. Application developers should not use this

Sets XML on this SeriesItems object

setXML

protected void setXML(oracle.dss.util.xml.ContainerNode node,
                      boolean allProperties)

For internal use only. Application developers should not use this

Sets XML on this SeriesItems object

setSeriesItemsXML

protected void setSeriesItemsXML(oracle.dss.util.xml.ContainerNode node)

For internal use only. Application developers should not use this

Sets SeriesItesm style XML on this Series object

setSeriesXML

protected void setSeriesXML(oracle.dss.util.xml.ObjectNode seriesNode,
                            int series,
                            boolean allProperties,
                            java.util.HashMap map)

For internal use only. Application developers should not use this

Sets Series style XML on this Series object

displayMarkers

protected void displayMarkers(int oldType)

displayMarkers

protected void displayMarkers()

Ensures that marker shapes are looped properly when new data is set. displayMarkers(int oldType) should be called when changing graphType.

resetStyle

protected void resetStyle()

For internal use only. Application developers should not use this

reset style properties