|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
oracle.dss.graph.BaseGraphComponent | +--oracle.dss.graph.Series
The series component of the graph. A series usually represents a dimension member such as "Shoes" or "Boston".
Method Summary | |
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. |
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 for the markers of series. |
int |
getDefaultFitlineType() Retrieves the default type of fitline for all series. |
int |
getDefaultLineWidth() Retrieves the default width for the data lines 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 that you want to use for this series, such as exponential, or logarithmic. |
int |
getLineWidth(int series) Retrieves the width for the data lines that belong to the specified 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. |
SFX |
getSFX(int series) Retrieves the SFX object for the series. |
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. |
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 for the markers 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 |
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 you want to use for this series, such as exponential, or logarithmic. |
void |
setLineWidth(int width, int series) Specifies the width for the data lines that belong to the specified 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. |
void |
setTransparent(boolean yesNo, int series) Specifies whether the fill color for the markers of the series is transparent. |
Methods inherited from class oracle.dss.graph.BaseGraphComponent |
selectObject |
Method Detail |
public SFX getSFX(int series) throws SeriesOutOfRangeException
SFX
object for the series. The SFX
object allows you to retrieve and specify attributes for special effects.series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.SFX
object for the series.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public boolean isAssignedToY2(int series) throws SeriesOutOfRangeException
series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.true
if the series of data is plotted against the Y2-axis, false
if it is plotted against the Y1-axis.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public void setAssignedToY2(boolean yesNo, int series) throws SeriesOutOfRangeException
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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public java.awt.Color getBorderColor(int series) throws SeriesOutOfRangeException
setBorderUsingDefaults
method to false
.series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public void setBorderColor(java.awt.Color newColor, int series) throws SeriesOutOfRangeException
setBorderUsingDefaults
method to false
.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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public boolean isBorderTransparent(int series) throws SeriesOutOfRangeException
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
.series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.true
if the borders are transparent, false
if the borders are visible.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public void setBorderTransparent(boolean yesNo, int series) throws SeriesOutOfRangeException
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
.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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public java.awt.Color getColor(int series) throws SeriesOutOfRangeException
series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public void setColor(java.awt.Color newColor, int series) throws SeriesOutOfRangeException
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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public java.awt.Color getDefaultBorderColor()
setBorderUsingDefaults
method to true
.public void setDefaultBorderColor(java.awt.Color newColor)
setBorderUsingDefaults
method to true
.newColor
- The default border color for the markers of all series.public boolean isDefaultBorderTransparent()
setBorderUsingDefaults
method to true
.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.public void setDefaultBorderTransparent(boolean yesNo)
setBorderUsingDefaults
method to true
.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.public void setFitlineType(int type, int series) throws SeriesOutOfRangeException
type
- A constant that represents the type of fitline that you want 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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.BaseGraphComponent.FT_LINEAR
, BaseGraphComponent.FT_EXPONENTIAL
, BaseGraphComponent.FT_LOGARITHMIC
, BaseGraphComponent.FT_NONE
public int getFitlineType(int series) throws SeriesOutOfRangeException
series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.BaseGraphComponent.FT_LINEAR
, BaseGraphComponent.FT_EXPONENTIAL
, BaseGraphComponent.FT_LOGARITHMIC
, BaseGraphComponent.FT_NONE
public int getLineWidth(int series) throws SeriesOutOfRangeException
series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public void setLineWidth(int width, int series) throws SeriesOutOfRangeException
The value that you set in this method takes effect only when the DepthRadius
attribute of the graph is set to zero.
series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.width
- The width for the data lines that belong to the series.SeriesOutOfRangeException
- If series
is less than zero or is greater than or equal to the value of the SeriesObjectCount
attribute of the graph.Graph.setDepthRadius(int)
public int getMarkerShape(int series) throws SeriesOutOfRangeException
MarkerShape
property applies only to data markers that appear in line, point, scatter, and bubble graphs. It does not affect the shape of bars or slices.series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.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
public void setMarkerShape(int shape, int series) throws SeriesOutOfRangeException
MarkerShape
property applies only to data markers that appear in line, point, scatter, and bubble graphs. It does not affect the shape of bars or slices.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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.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
public int getMarkerType(int series) throws SeriesOutOfRangeException
series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.BaseGraphComponent.MT_AREA
, BaseGraphComponent.MT_BAR
, BaseGraphComponent.MT_MARKER
, BaseGraphComponent.MT_DEFAULT
public void setMarkerType(int type, int series) throws SeriesOutOfRangeException
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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.BaseGraphComponent.MT_AREA
, BaseGraphComponent.MT_BAR
, BaseGraphComponent.MT_MARKER
, BaseGraphComponent.MT_DEFAULT
public int getPieSliceExplode(int series) throws SeriesOutOfRangeException
series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public void setPieSliceExplode(int explode, int series) throws SeriesOutOfRangeException
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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public boolean isTransparent(int series) throws SeriesOutOfRangeException
setBorderTransparent
and the setTransparent
methods to true
. When an attribute or an object is transparent, it is not visible, but you can select it.series
- The index of the series. The values range from 0 to the value of graph.getSeriesObjectCount
minus 1.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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public void setTransparent(boolean yesNo, int series) throws SeriesOutOfRangeException
setBorderTransparent
and the setTransparent
methods to true
. When an attribute or an object is transparent, it is not visible, but you can select it.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.SeriesOutOfRangeException
- If series
is less than zero, or greater than or equal to the value of the SeriesObjectCount
property of the graph.public boolean isBorderUsingDefaults()
setDefaultBorderColor
method and the setDefaultBorderTransparent
method.true
if they use the default values, false
if they use the values that are set in the setBorderColor
method and the setBorderTransparent
method.public void setBorderUsingDefaults(boolean yesNo)
setDefaultBorderColor
method and the setDefaultBorderTransparent
method.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.public void setDefaultColor(java.awt.Color color)
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.setColor(java.awt.Color, int)
public java.awt.Color getDefaultColor()
color
is null, then the graph assigns its own default colors to series, repeating colors as necessary.getColor(int)
public void setDefaultMarkerType(int markerType)
markerType
- The default type of markers used for series.BaseGraphComponent.MT_AREA
, BaseGraphComponent.MT_BAR
, BaseGraphComponent.MT_DEFAULT
, BaseGraphComponent.MT_MARKER
public int getDefaultMarkerType()
BaseGraphComponent.MT_AREA
, BaseGraphComponent.MT_BAR
, BaseGraphComponent.MT_DEFAULT
, BaseGraphComponent.MT_MARKER
public void setDefaultMarkerShape(int markerShape)
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.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_AUTOMATIC
public int getDefaultMarkerShape()
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_AUTOMATIC
public void setDefaultLineWidth(int lineWidth)
The value that you set in this method takes effect only when the DepthRadius
attribute of the graph is set to zero.
lineWidth
- The default width for the data lines of series.Graph.setDepthRadius(int)
public int getDefaultLineWidth()
public void setDefaultAssignedToY2(int assignedToY2)
assignedToY2
- A constant that represents the default axis assignment. Valid constants are listed in the See Also section.BaseGraphComponent.DY2_TRUE
, BaseGraphComponent.DY2_FALSE
, BaseGraphComponent.DY2_AUTO_ASSIGN
public int getDefaultAssignedToY2()
BaseGraphComponent.DY2_TRUE
, BaseGraphComponent.DY2_FALSE
, BaseGraphComponent.DY2_AUTO_ASSIGN
public void setDefaultFitlineType(int type)
type
- A constant that represents the default type of fitline for series. Valid constants are listed in the See Also section.BaseGraphComponent.FT_EXPONENTIAL
, BaseGraphComponent.FT_LOGARITHMIC
, BaseGraphComponent.FT_LINEAR
, BaseGraphComponent.FT_NONE
public int getDefaultFitlineType()
BaseGraphComponent.FT_EXPONENTIAL
, BaseGraphComponent.FT_LOGARITHMIC
, BaseGraphComponent.FT_LINEAR
, BaseGraphComponent.FT_NONE
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |