SeriesSet (Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components)

java.lang.Object
- oracle.adf.view.faces.bi.component.BIComplexAttributeBase
- - oracle.adf.view.faces.bi.component.graph.SeriesSet

All Implemented Interfaces:

javax.faces.component.StateHolder
```
public class SeriesSet
extends BIComplexAttributeBase
```
Defines properties for the series of a graph.

Since:

11.0

Field Summary

Fields
Modifier and Type	Field and Description
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`ASSIGNED_TO_Y2_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`BAR_SHAPE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`BORDER_COLOR_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`BORDER_TRANSPARENT_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`COLOR_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`FITLINE_TYPE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`LINE_DISPLAYED_KEY`
`static java.lang.String`	`LINE_DISPLAYED_NAME`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`LINE_WIDTH_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`MARKER_COLOR_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`MARKER_DISPLAYED_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`MARKER_SHAPE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`MARKER_TYPE_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`SERIES_MAP_KEY`
`static BIFacesBeanImpl.Type`	`TYPE`

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors
Constructor and Description

SeriesSet()

Constructors
Constructor and Description
`SeriesSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyProperties(java.util.HashMap map)` Applications do not need to call this method.
`int`	`getBarShape()` Gets the shape of bars in a bar graph.
`protected org.apache.myfaces.trinidad.bean.FacesBean.Type`	`getBeanType()`
`int`	`getDefaultAssignedToY2()` Retrieves the default axis assignment for series.
`java.awt.Color`	`getDefaultBorderColor()` Retrieves the default border color of the series.
`java.awt.Color`	`getDefaultColor()` Retrieves the default fill color 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.
`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.
`Series`	`getSeries(int i, boolean createNew)`
`java.util.Map`	`getSeriesMap()`
`boolean`	`isDefaultBorderTransparent()` Indicates whether the borders for the markers of the series are transparent.
`boolean`	`isLineDisplayed()` Indicates whether data lines appear in a line graph.
`boolean`	`isMarkerDisplayed()` Indicates whether data markers appear in a line or area graph.
`protected void`	`resetStyleProperties()`
`java.lang.Object`	`saveState(javax.faces.context.FacesContext context)`
`void`	`setBarShape(int shape)` Sets the shape of bars in a bar graph.
`void`	`setBarShape(java.lang.String shape)` Sets the shape of bars in a bar graph.
`void`	`setDefaultAssignedToY2(int assignedToY2)` Specifies the default axis assignment for series.
`void`	`setDefaultAssignedToY2(java.lang.String assignedToY2)` Specifies the default assignment of each series for dual-Y graphs.
`void`	`setDefaultBorderColor(java.awt.Color newColor)` Specifies the default border color of the series.
`void`	`setDefaultBorderTransparent(boolean yesNo)` Specifies whether the borders for the markers of the series are transparent.
`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`	`setDefaultFitlineType(java.lang.String type)` Specifies the default type of fitline, if any, that is displayed for each series.
`void`	`setDefaultLineWidth(int width)` 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 shape)` Specifies the default shape for the data markers of series.
`void`	`setDefaultMarkerShape(java.lang.String shape)` The default marker shape for each series.
`void`	`setDefaultMarkerType(int type)` Specifies the default marker type for series.
`void`	`setDefaultMarkerType(java.lang.String type)` Specifies the default marker type for each series in this graph.
`void`	`setLineDisplayed(boolean displayed)` Specifies whether data lines appear in a line graph.
`void`	`setMarkerDisplayed(boolean displayed)` Specifies whether data markers appear in a line or area graph.
`void`	`setSeriesMap(java.util.Map map)`

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, registerAttachedObjectKey, restoreState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE
```
public static final BIFacesBeanImpl.Type TYPE
```
  - COLOR_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLOR_KEY
```
  - MARKER_COLOR_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey MARKER_COLOR_KEY
```
  - LINE_WIDTH_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey LINE_WIDTH_KEY
```
  - FITLINE_TYPE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey FITLINE_TYPE_KEY
```
  - MARKER_TYPE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey MARKER_TYPE_KEY
```
  - MARKER_SHAPE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey MARKER_SHAPE_KEY
```
  - ASSIGNED_TO_Y2_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey ASSIGNED_TO_Y2_KEY
```
  - SERIES_MAP_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SERIES_MAP_KEY
```
  - BORDER_COLOR_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey BORDER_COLOR_KEY
```
  - BORDER_TRANSPARENT_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey BORDER_TRANSPARENT_KEY
```
  - LINE_DISPLAYED_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey LINE_DISPLAYED_KEY
```
  - MARKER_DISPLAYED_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey MARKER_DISPLAYED_KEY
```
  - BAR_SHAPE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey BAR_SHAPE_KEY
```
  - LINE_DISPLAYED_NAME
```
public static final java.lang.String LINE_DISPLAYED_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SeriesSet
```
public SeriesSet()
```
- Method Detail
  - 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
  - setDefaultAssignedToY2
```
public void setDefaultAssignedToY2(java.lang.String assignedToY2)
```
    Specifies the default assignment of each series for dual-Y graphs. Valid values are:
    Parameters:
    assignedToY2 - A constant that represents the default axis assignment. Valid constants are:
    
    DY2_TRUE - Assign series to Y2-axis.
    
    DY2_FALSE - Assign series to Y1-axis.
    
    DY2_AUTO_ASSIGN - (Default) Use default assignment of series to an axis.
  - 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
  - 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
  - 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
  - getDefaultBorderColor
```
public java.awt.Color getDefaultBorderColor()
```
    Retrieves the default border color of the series.
    
    Returns:
    
    The default border color of the series. For transparent border color, this returns null.
  - setDefaultBorderColor
```
public void setDefaultBorderColor(java.awt.Color newColor)
```
    Specifies the default border color of the series.
    
    Parameters:
    
    newColor - The default border color of the series. If this is null, the border color is made transparent.
  - isDefaultBorderTransparent
```
public boolean isDefaultBorderTransparent()
```
    Indicates whether the borders for the markers of the series are transparent.
    
    Returns:
    
    true if the borders are transparent, false if the borders are visible.
  - setDefaultBorderTransparent
```
public void setDefaultBorderTransparent(boolean yesNo)
```
    Specifies whether the borders for the markers of the series are transparent.
    
    Parameters:
    
    yesNo - true to make the borders transparent, false to make the borders visible.
  - 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:
    
    #setColor
  - 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:
    
    #getColor
  - 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
  - setDefaultFitlineType
```
public void setDefaultFitlineType(java.lang.String type)
```
    Specifies the default type of fitline, if any, that is displayed for each series. Valid values are:
    Parameters:
    type - A constant that represents the default type of fitline for series. Valid constants are listed:
    
    FT_NONE - (Default) Do not use fit lines.
    
    FT_LINEAR - Use a linear fitline.
    
    FT_LOGARITHMIC - Use a logarithmic fit line.
    
    FT_EXPONENTIAL - Use an exponential fit line.
  - 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
  - setDefaultLineWidth
```
public void setDefaultLineWidth(int width)
```
    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
  - getDefaultLineWidth
```
public int getDefaultLineWidth()
```
    Retrieves the default width for the data lines of series.
    
    Returns:
    
    The default width for the data lines of series.
  - setDefaultMarkerShape
```
public void setDefaultMarkerShape(int shape)
```
    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_AUTOMATIC
  - setDefaultMarkerShape
```
public void setDefaultMarkerShape(java.lang.String shape)
```
    The default marker shape for each series. This attribute is relevant only for line, scatter, polar, combination, radar, area and bubble graphs (bubbles honor only MS_NONE, MS_AUTOMATIC, MS_CIRCLE, and MS_HUMAN setting) Valid values are:
    Parameters:
    shape - 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.
    
    MS_NONE - Do not use series markers.
    
    MS_AUTOMATIC - (Default) Use default markers. In this case, the line, scatter, polar or combination graph assigns marker shapes to each series rotating through square, circle, diamond, plus sign, and triangle. The bubble graph assigns marker shapes to circle.
    
    MS_SQUARE - Use square markers.
    
    MS_CIRCLE - Use circular markers.
    
    MS_DIAMOND - Use diamond markers.
    
    MS_PLUS - Use plus sign markers.
    
    MS_TRIANGLE_UP - Use triangle markers.
    
    MS_HUMAN - Use human shaped markers. When the markerSize is specified, the human marker is scaled so that its width matches the markerSize value.
  - 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_AUTOMATIC
  - setDefaultMarkerType
```
public void setDefaultMarkerType(int type)
```
    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_LINE
  - setDefaultMarkerType
```
public void setDefaultMarkerType(java.lang.String type)
```
    Specifies the default marker type for each series in this graph. This attribute is relevant for combination graphs and line graphs. All types apply to combination graphs. The different line types apply to line graphs. Valid values are:
    Parameters:
    type - The default type of markers used for series.
    
    MT_AREA - Use area markers.
    
    MT_BAR - Use bar markers.
    
    MT_MARKER - Use regular line.
    
    MT_CURVE_LINE - Use curve line.
    
    MT_STEPPED_LINE - Use stepped line.
    
    MT_CENTERED_STEPPED_LINE - Use centered stepped line.
    
    MT_DEFAULT - (Default) Use an appropriate marker based on graph type.
  - 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_LINE
  - applyProperties
```
public void applyProperties(java.util.HashMap map)
```
    Applications do not need to call this method. This is for internal use.
    
    Overrides:
    
    applyProperties in class BIComplexAttributeBase
    
    Parameters:
    
    map - hashMap that contains property value pairs.
  - resetStyleProperties
```
protected void resetStyleProperties()
```
  - getSeries
```
public Series getSeries(int i,
                        boolean createNew)
```
  - setSeriesMap
```
public void setSeriesMap(java.util.Map map)
```
  - getSeriesMap
```
public java.util.Map getSeriesMap()
```
  - setMarkerDisplayed
```
public void setMarkerDisplayed(boolean displayed)
```
    Specifies whether data markers appear in a line or area graph. If you set this property to true, then you should also make sure that the MarkerShape property for each series in the graph is not set to BaseGraphComponent.MS_NONE.
    If you set this property to false, then you should be sure to set the LineDisplayed property to true.
    
    Parameters:
    
    displayed - true to display data markers, false to hide data markers.
    
    See Also:
    
    setLineDisplayed(boolean), Series.setMarkerShape(int), BaseGraphComponent.MS_NONE
  - isMarkerDisplayed
```
public boolean isMarkerDisplayed()
```
    Indicates whether data markers appear in a line or area graph.
    
    Returns:
    
    true if the data markers are displayed, false if the data markers are not displayed.
  - setLineDisplayed
```
public void setLineDisplayed(boolean displayed)
```
    Specifies whether data lines appear in a line graph. If you set this property to false, then the graph sets the MarkerDisplayed property to true.
    
    Parameters:
    
    displayed - true to display lines, false not to display them.
    
    See Also:
    
    setMarkerDisplayed(boolean)
  - isLineDisplayed
```
public boolean isLineDisplayed()
```
    Indicates whether data lines appear in a line graph.
    
    Returns:
    
    true if a line graph displays lines, false if the line graph does not display lines.
    
    See Also:
    
    setMarkerDisplayed(boolean)
  - getBarShape
```
public int getBarShape()
```
    Gets the shape of bars in a bar graph. The default is BAR_SHAPE_RECTANGLE.
    
    Returns:
    
    the shape of bars in a bar graph
    
    See Also:
    
    GraphConstants.BAR_SHAPE_RECTANGLE, GraphConstants.BAR_SHAPE_CYLINDER, GraphConstants.BAR_SHAPE_TRIANGLE, GraphConstants.BAR_SHAPE_DIAMOND
  - setBarShape
```
public void setBarShape(int shape)
```
    Sets the shape of bars in a bar graph. The default is BAR_SHAPE_RECTANGLE.
    
    Parameters:
    
    shape - the shape of bars in a bar graph
    
    See Also:
    
    GraphConstants.BAR_SHAPE_RECTANGLE, GraphConstants.BAR_SHAPE_CYLINDER, GraphConstants.BAR_SHAPE_TRIANGLE, GraphConstants.BAR_SHAPE_DIAMOND
  - setBarShape
```
public void setBarShape(java.lang.String shape)
```
    Sets the shape of bars in a bar graph.
    Parameters:
    shape - Shape of bars in a bar graph. Valid values are the following:
    
    RECTANGLE - (Default) A flat rectangular data marker for bar graph.
    
    CYLINDER - A cylindrical data marker for bar graph.
    
    TRIANGLE - A triangular based bar data marker for bar graph.
    
    DIAMOND - A diamond shaped based bar data marker for bar graph.
    
    Note: Animation is only supported for bar graphs with barShape = "RECTANGLE".
  - saveState
```
public java.lang.Object saveState(javax.faces.context.FacesContext context)
```
    Specified by:
    
    saveState in interface javax.faces.component.StateHolder
    
    Overrides:
    
    saveState in class BIComplexAttributeBase
  - getBeanType
```
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
```
    Specified by:
    
    getBeanType in class BIComplexAttributeBase

Class SeriesSet

Field Summary

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

Constructor Summary

Method Summary

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

Methods inherited from class java.lang.Object

Field Detail

TYPE

COLOR_KEY

MARKER_COLOR_KEY

LINE_WIDTH_KEY

FITLINE_TYPE_KEY

MARKER_TYPE_KEY

MARKER_SHAPE_KEY

ASSIGNED_TO_Y2_KEY

SERIES_MAP_KEY

BORDER_COLOR_KEY

BORDER_TRANSPARENT_KEY

LINE_DISPLAYED_KEY

MARKER_DISPLAYED_KEY

BAR_SHAPE_KEY

LINE_DISPLAYED_NAME

Constructor Detail

SeriesSet

Method Detail

setDefaultAssignedToY2

setDefaultAssignedToY2

getDefaultAssignedToY2

setDefaultColor

getDefaultColor

getDefaultBorderColor

setDefaultBorderColor

isDefaultBorderTransparent

setDefaultBorderTransparent

setDefaultMarkerColor

getDefaultMarkerColor

setDefaultFitlineType

setDefaultFitlineType

getDefaultFitlineType

setDefaultLineWidth

getDefaultLineWidth

setDefaultMarkerShape

setDefaultMarkerShape

getDefaultMarkerShape

setDefaultMarkerType

setDefaultMarkerType

getDefaultMarkerType

applyProperties

resetStyleProperties

getSeries

setSeriesMap

getSeriesMap

setMarkerDisplayed

isMarkerDisplayed

setLineDisplayed

isLineDisplayed

getBarShape

setBarShape

setBarShape

saveState

getBeanType