com.infragistics.faces.chart.component
Class Series

java.lang.Object
  com.infragistics.faces.shared.component.ModelComponent
      com.infragistics.faces.chart.component.Series

All Implemented Interfaces:

IChartAttributes, ISeriesBase, java.io.Serializable

public class Series

extends ModelComponent

implements ISeriesBase, IChartAttributes

Defines a series used to logically and visually compose data points.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.infragistics.faces.chart.component.IChartAttributes

CLOSE, CLUSTER_WIDTH, COLUMN_WIDTH, DATA_STYLE_CLASS, EXPLODED_RADIUS, hello, HIGH, INNER_RADIUS, LEGEND_CAPTION, LEGEND_CAPTION_STYLE_CLASS, LOW, MARKER_BULLET_SIZE, MARKER_BULLET_STYLE_CLASS, MARKER_BULLET_TYPE, MARKER_BULLET_VISIBLE, MARKER_CAPTION, MARKER_CAPTION_STYLE_CLASS, MARKER_CAPTION_VISIBLE, OPEN, RADIUS, SHAPE_TYPE, START_ANGLE, TOOLTIP_CAPTION, VALUE

Constructor Summary

Series()

Method Summary

java.util.List	getAxes() Returns the collection of Axis objects applied to all nested series.
java.lang.Object	getChartAttribute(java.lang.String key) Returns the named attribute value.
java.lang.String	getChartType() Returns the chart type for nested series.
java.lang.Number	getClose() Returns the numerical "close" value.<p> The close value is used by candlestick and OHLC charts.
java.lang.Number	getClusterWidth() Returns the percentage of the available cluster width used to create value clusters.<p> Setting a value of 100% causes adjacent clusters to be packed contiguously, a typical value is 80%.
java.lang.Number	getColumnWidth() Returns the percentage of the available column width used to create columns.<p> A value of 100% causes adjacent columns to be packed contiguously.
java.lang.String	getDataMapping() Returns the data mapping used to convert the external data model to internal names.
java.util.List	getDataPoints() Returns the collection of datapoints defining this series contents.
javax.faces.model.DataModel	getDataSource() Returns the data source used to create the individual data points for this series.
java.lang.String	getDataStyleClass() Returns the CSS style class that is applied to data points or series.
java.lang.Number	getExplodedRadius() Returns the percentage of available space used to offset pie and donut segments.
java.lang.Number	getHigh() Returns the numerical "high" value.<p> The high value is used by range, candlestick and OHLC charts.
java.lang.Number	getInnerRadius() Returns the percentage of available space used for donut holes.
java.lang.String	getLegendCaption() Returns the legend label for data points and series in automatic legend fill mode.
java.lang.String	getLegendCaptionStyleClass() Returns the CSS style class applied to automatically generated legend labels.
java.lang.Number	getLow() Returns the numerical "low" value.<p> The low value is used by range, candlestick and OHLC charts.
java.lang.Number	getMarkerBulletSize() Returns the marker size (in pixels).
java.lang.String	getMarkerBulletStyleClass() Returns the CSS style class applied to datapoint bullets.
java.lang.String	getMarkerBulletType() Returns the datapoint bullet shape.
java.lang.Boolean	getMarkerBulletVisible() Returns the datapoint bullet visibility flag.
java.lang.String	getMarkerCaption() Returns the datapoint label string.
java.lang.String	getMarkerCaptionStyleClass() Returns the CSS style class applied to datapoint labels.
java.lang.Boolean	getMarkerCaptionVisible() Returns the datapoint label string visibility flag.
java.lang.Number	getOpen() Returns the numerical "open" value<p> The open value is used by candlestick and OHLC charts.
java.lang.Number	getRadius() Returns the percentage of available space used to create pie and donut segments.
java.lang.String	getShapeType() Returns the shape applied to datapoints and series.
java.lang.Number	getStartAngle() Returns the clockwise angle in degrees from twelve o'clock for the zero value in pie and dount charts.
java.lang.String	getTooltipCaption() Returns the tooltip string for datapoints and series.
java.lang.Number	getValue() Returns the numerical "value" value.<p> The value is used by column, area and line charts.
void	setAxes(java.util.List axes) Sets the collection of Axis objects applied to all nested series.
void	setChartAttribute(java.lang.String key, java.lang.Object value) Set an arbitrary named attribute to an attribute value.
void	setChartType(java.lang.String chartType) Sets the chart type for nested series.
void	setClose(java.lang.Number close) Sets the numerical "close" value.<p> The close value is used by candlestick and OHLC charts.
void	setClusterWidth(java.lang.Number clusterWidth) Sets the percentage of the available cluster width used to create value clusters.<p> Setting a value of 100% causes adjacent clusters to be packed contiguously, a typical value is 80%.
void	setColumnWidth(java.lang.Number columnWidth) Sets the percentage of the available column width used to create columns.<p> A value of 100% causes adjacent columns to be packed contiguously.
void	setDataMapping(java.lang.String dataMapping) Sets the data mapping used to convert the external data model to internal names.
void	setDataPoints(java.util.List dataPoints) Sets the collection of datapoints defining this series contents.
void	setDataSource(javax.faces.model.DataModel dataSource) Sets the data source used to create the individual data points for this series.
void	setDataStyleClass(java.lang.String dataStyleClass) Sets the CSS style class that is applied to data points or series.
void	setExplodedRadius(java.lang.Number explodedRadius) Sets the percentage of available space used to offset pie and donut segments.
void	setHigh(java.lang.Number high) Sets the numerical "high" value.<p> The high value is used by range, candlestick and OHLC charts.
void	setInnerRadius(java.lang.Number innerRadius) Sets the percentage of available space used for donut holes.
void	setLegendCaption(java.lang.String legendCaption) Sets the legend label for data points and series in automatic legend fill mode.
void	setLegendCaptionStyleClass(java.lang.String legendCaptionStyleClass) Sets the CSS style class applied to automatically generated legend labels.
void	setLow(java.lang.Number low) Sets the numerical "low" value.<p> The low value is used by range, candlestick and OHLC charts.
void	setMarkerBulletSize(java.lang.Number markerBulletSize) Sets the marker size (in pixels).
void	setMarkerBulletStyleClass(java.lang.String markerBulletStyleClass) Sets the CSS style class applied to datapoint bullets.
void	setMarkerBulletType(java.lang.String markerBulletType) Sets the datapoint bullet shape.
void	setMarkerBulletVisible(java.lang.Boolean markerBulletVisible) Sets the datapoint bullet visibility flag.
void	setMarkerCaption(java.lang.String markerCaption) Sets the datapoint label string.
void	setMarkerCaptionStyleClass(java.lang.String markerCaptionStyleClass) Sets the CSS style class applied to datapoint labels.
void	setMarkerCaptionVisible(java.lang.Boolean markerCaptionVisible) Sets the datapoint label string visibility flag.
void	setOpen(java.lang.Number open) Sets the numerical "open" value<p> The open value is used by candlestick and OHLC charts.
void	setRadius(java.lang.Number radius) Sets the percentage of available space used to create pie and donut segments.
void	setShapeType(java.lang.String shapeType) Sets the shape applied to datapoints and series.
void	setStartAngle(java.lang.Number startAngle) Sets the clockwise angle in degrees from twelve o'clock for the zero value in pie and dount charts.
void	setTooltipCaption(java.lang.String tooltipCaption) Sets the tooltip string for datapoints and series.
void	setValue(java.lang.Number value) Sets the numerical "value" value.<p> The value is used by column, area and line charts.

Methods inherited from class com.infragistics.faces.shared.component.ModelComponent

getParent, getValueBinding, setParent, setValueBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

Series

public Series()

Method Detail

getAxes

public java.util.List getAxes()

Returns the collection of Axis objects applied to all nested series.

Specified by:

getAxes in interface ISeriesBase

Returns:

com.infragistics.faces.chart.component.Axis

getChartType

public java.lang.String getChartType()

Returns the chart type for nested series.

Specified by:

getChartType in interface ISeriesBase

Returns:

com.infragistics.faces.chart.enumeration.ChartType (area, column, doughnut, line, pie, rangeArea, rangeColumn)

getDataPoints

public java.util.List getDataPoints()

Returns the collection of datapoints defining this series contents.

Returns:

com.infragistics.faces.chart.component.DataPoint

setAxes

public void setAxes(java.util.List axes)

Sets the collection of Axis objects applied to all nested series.

Specified by:

setAxes in interface ISeriesBase

Parameters:

axes - java.util.List

setChartType

public void setChartType(java.lang.String chartType)

Sets the chart type for nested series.

Specified by:

setChartType in interface ISeriesBase

Parameters:

chartType - String (area, column, doughnut, line, pie, rangeArea, rangeColumn)

getChartAttribute

public java.lang.Object getChartAttribute(java.lang.String key)

Description copied from interface: IChartAttributes

Returns the named attribute value.

Specified by:

getChartAttribute in interface IChartAttributes

Parameters:

key - the attribute name. may not be null.

Returns:

the attribute value, or null if the attribute is not defined in the object

setChartAttribute

public void setChartAttribute(java.lang.String key,
                              java.lang.Object value)

Description copied from interface: IChartAttributes

Set an arbitrary named attribute to an attribute value.

Specified by:

setChartAttribute in interface IChartAttributes

Parameters:

key - the attribute name. may not be null.

value - the attribute value. may be null, in which case the named attribute is removed from the object.

getClose

public java.lang.Number getClose()

Returns the numerical "close" value.<p> The close value is used by candlestick and OHLC charts.

Specified by:

getClose in interface IChartAttributes

Returns:

java.lang.Number

setClose

public void setClose(java.lang.Number close)

Sets the numerical "close" value.<p> The close value is used by candlestick and OHLC charts.

Specified by:

setClose in interface IChartAttributes

Parameters:

close - Number

getClusterWidth

public java.lang.Number getClusterWidth()

Returns the percentage of the available cluster width used to create value clusters.<p> Setting a value of 100% causes adjacent clusters to be packed contiguously, a typical value is 80%.

Specified by:

getClusterWidth in interface IChartAttributes

Returns:

java.lang.Number

setClusterWidth

public void setClusterWidth(java.lang.Number clusterWidth)

Sets the percentage of the available cluster width used to create value clusters.<p> Setting a value of 100% causes adjacent clusters to be packed contiguously, a typical value is 80%.

Specified by:

setClusterWidth in interface IChartAttributes

Parameters:

clusterWidth - Number

getColumnWidth

public java.lang.Number getColumnWidth()

Returns the percentage of the available column width used to create columns.<p> A value of 100% causes adjacent columns to be packed contiguously. Values less than 100% cause a space between adjacent columns and values greater than 100% cause adjacent columns to overlap.

Specified by:

getColumnWidth in interface IChartAttributes

Returns:

java.lang.Number

setColumnWidth

public void setColumnWidth(java.lang.Number columnWidth)

Sets the percentage of the available column width used to create columns.<p> A value of 100% causes adjacent columns to be packed contiguously. Values less than 100% cause a space between adjacent columns and values greater than 100% cause adjacent columns to overlap.

Specified by:

setColumnWidth in interface IChartAttributes

Parameters:

columnWidth - Number

setDataMapping

public void setDataMapping(java.lang.String dataMapping)

Sets the data mapping used to convert the external data model to internal names.

Specified by:

setDataMapping in interface ISeriesBase

Parameters:

dataMapping - String

setDataPoints

public void setDataPoints(java.util.List dataPoints)

Sets the collection of datapoints defining this series contents.

Parameters:

dataPoints - java.util.List

getDataSource

public javax.faces.model.DataModel getDataSource()

Returns the data source used to create the individual data points for this series.

Specified by:

getDataSource in interface ISeriesBase

Returns:

javax.faces.model.DataModel

setDataSource

public void setDataSource(javax.faces.model.DataModel dataSource)

Sets the data source used to create the individual data points for this series.

Specified by:

setDataSource in interface ISeriesBase

Parameters:

dataSource - DataModel

getDataStyleClass

public java.lang.String getDataStyleClass()

Returns the CSS style class that is applied to data points or series.

Specified by:

getDataStyleClass in interface IChartAttributes

Returns:

java.lang.String

setDataStyleClass

public void setDataStyleClass(java.lang.String dataStyleClass)

Sets the CSS style class that is applied to data points or series.

Specified by:

setDataStyleClass in interface IChartAttributes

Parameters:

dataStyleClass - String

getExplodedRadius

public java.lang.Number getExplodedRadius()

Returns the percentage of available space used to offset pie and donut segments.

Specified by:

getExplodedRadius in interface IChartAttributes

Returns:

java.lang.Number

setExplodedRadius

public void setExplodedRadius(java.lang.Number explodedRadius)

Sets the percentage of available space used to offset pie and donut segments.

Specified by:

setExplodedRadius in interface IChartAttributes

Parameters:

explodedRadius - Number

getHigh

public java.lang.Number getHigh()

Returns the numerical "high" value.<p> The high value is used by range, candlestick and OHLC charts.

Specified by:

getHigh in interface IChartAttributes

Returns:

java.lang.Number

setHigh

public void setHigh(java.lang.Number high)

Sets the numerical "high" value.<p> The high value is used by range, candlestick and OHLC charts.

Specified by:

setHigh in interface IChartAttributes

Parameters:

high - Number

getInnerRadius

public java.lang.Number getInnerRadius()

Returns the percentage of available space used for donut holes.

Specified by:

getInnerRadius in interface IChartAttributes

Returns:

java.lang.Number

setInnerRadius

public void setInnerRadius(java.lang.Number innerRadius)

Sets the percentage of available space used for donut holes.

Specified by:

setInnerRadius in interface IChartAttributes

Parameters:

innerRadius - Number

getLegendCaption

public java.lang.String getLegendCaption()

Returns the legend label for data points and series in automatic legend fill mode.

Specified by:

getLegendCaption in interface IChartAttributes

Returns:

java.lang.String

setLegendCaption

public void setLegendCaption(java.lang.String legendCaption)

Sets the legend label for data points and series in automatic legend fill mode.

Specified by:

setLegendCaption in interface IChartAttributes

Parameters:

legendCaption - String

getLegendCaptionStyleClass

public java.lang.String getLegendCaptionStyleClass()

Returns the CSS style class applied to automatically generated legend labels.

Specified by:

getLegendCaptionStyleClass in interface IChartAttributes

Returns:

java.lang.String

setLegendCaptionStyleClass

public void setLegendCaptionStyleClass(java.lang.String legendCaptionStyleClass)

Sets the CSS style class applied to automatically generated legend labels.

Specified by:

setLegendCaptionStyleClass in interface IChartAttributes

Parameters:

legendCaptionStyleClass - String

getLow

public java.lang.Number getLow()

Returns the numerical "low" value.<p> The low value is used by range, candlestick and OHLC charts.

Specified by:

getLow in interface IChartAttributes

Returns:

java.lang.Number

setLow

public void setLow(java.lang.Number low)

Sets the numerical "low" value.<p> The low value is used by range, candlestick and OHLC charts.

Specified by:

setLow in interface IChartAttributes

Parameters:

low - Number

getMarkerBulletSize

public java.lang.Number getMarkerBulletSize()

Returns the marker size (in pixels).

Specified by:

getMarkerBulletSize in interface IChartAttributes

Returns:

java.lang.Number

setMarkerBulletSize

public void setMarkerBulletSize(java.lang.Number markerBulletSize)

Sets the marker size (in pixels).

Specified by:

setMarkerBulletSize in interface IChartAttributes

Parameters:

markerBulletSize - Number

getMarkerBulletStyleClass

public java.lang.String getMarkerBulletStyleClass()

Returns the CSS style class applied to datapoint bullets.

Specified by:

getMarkerBulletStyleClass in interface IChartAttributes

Returns:

java.lang.String

setMarkerBulletStyleClass

public void setMarkerBulletStyleClass(java.lang.String markerBulletStyleClass)

Sets the CSS style class applied to datapoint bullets.

Specified by:

setMarkerBulletStyleClass in interface IChartAttributes

Parameters:

markerBulletStyleClass - String

getMarkerBulletType

public java.lang.String getMarkerBulletType()

Returns the datapoint bullet shape.

Specified by:

getMarkerBulletType in interface IChartAttributes

Returns:

com.infragistics.faces.chart.enumeration.BulletType (circle, iTriangle, square, star, triangle)

setMarkerBulletType

public void setMarkerBulletType(java.lang.String markerBulletType)

Sets the datapoint bullet shape.

Specified by:

setMarkerBulletType in interface IChartAttributes

Parameters:

markerBulletType - String (circle, iTriangle, square, star, triangle)

getMarkerBulletVisible

public java.lang.Boolean getMarkerBulletVisible()

Returns the datapoint bullet visibility flag.

Specified by:

getMarkerBulletVisible in interface IChartAttributes

Returns:

java.lang.Boolean

setMarkerBulletVisible

public void setMarkerBulletVisible(java.lang.Boolean markerBulletVisible)

Sets the datapoint bullet visibility flag.

Specified by:

setMarkerBulletVisible in interface IChartAttributes

Parameters:

markerBulletVisible - Boolean

getMarkerCaption

public java.lang.String getMarkerCaption()

Returns the datapoint label string.

Specified by:

getMarkerCaption in interface IChartAttributes

Returns:

java.lang.String

setMarkerCaption

public void setMarkerCaption(java.lang.String markerCaption)

Sets the datapoint label string.

Specified by:

setMarkerCaption in interface IChartAttributes

Parameters:

markerCaption - String

getMarkerCaptionStyleClass

public java.lang.String getMarkerCaptionStyleClass()

Returns the CSS style class applied to datapoint labels.

Specified by:

getMarkerCaptionStyleClass in interface IChartAttributes

Returns:

java.lang.String

setMarkerCaptionStyleClass

public void setMarkerCaptionStyleClass(java.lang.String markerCaptionStyleClass)

Sets the CSS style class applied to datapoint labels.

Specified by:

setMarkerCaptionStyleClass in interface IChartAttributes

Parameters:

markerCaptionStyleClass - String

getMarkerCaptionVisible

public java.lang.Boolean getMarkerCaptionVisible()

Returns the datapoint label string visibility flag.

Specified by:

getMarkerCaptionVisible in interface IChartAttributes

Returns:

java.lang.Boolean

setMarkerCaptionVisible

public void setMarkerCaptionVisible(java.lang.Boolean markerCaptionVisible)

Sets the datapoint label string visibility flag.

Specified by:

setMarkerCaptionVisible in interface IChartAttributes

Parameters:

markerCaptionVisible - Boolean

getOpen

public java.lang.Number getOpen()

Returns the numerical "open" value<p> The open value is used by candlestick and OHLC charts.

Specified by:

getOpen in interface IChartAttributes

Returns:

java.lang.Number

setOpen

public void setOpen(java.lang.Number open)

Sets the numerical "open" value<p> The open value is used by candlestick and OHLC charts.

Specified by:

setOpen in interface IChartAttributes

Parameters:

open - Number

getRadius

public java.lang.Number getRadius()

Returns the percentage of available space used to create pie and donut segments.

Specified by:

getRadius in interface IChartAttributes

Returns:

java.lang.Number

setRadius

public void setRadius(java.lang.Number radius)

Sets the percentage of available space used to create pie and donut segments.

Specified by:

setRadius in interface IChartAttributes

Parameters:

radius - Number

getShapeType

public java.lang.String getShapeType()

Returns the shape applied to datapoints and series.

Specified by:

getShapeType in interface IChartAttributes

Returns:

com.infragistics.faces.chart.enumeration.ShapeType (chamfered, cone, cylinder, cylinderChamfered, cylinderRounded, elliptical, fiveChamfered, fiveElliptical, fivePrism, fivePyramid, fiveRounded, fourElliptical, pyramid, round, rounded, sixChamfered, sixElliptical, sixPrism, sixPyramid, sixRounded, square, threeChamfered, threeElliptical, threePrism, threePyramid, threeRounded)

setShapeType

public void setShapeType(java.lang.String shapeType)

Sets the shape applied to datapoints and series.

Specified by:

setShapeType in interface IChartAttributes

Parameters:

shapeType - String (chamfered, cone, cylinder, cylinderChamfered, cylinderRounded, elliptical, fiveChamfered, fiveElliptical, fivePrism, fivePyramid, fiveRounded, fourElliptical, pyramid, round, rounded, sixChamfered, sixElliptical, sixPrism, sixPyramid, sixRounded, square, threeChamfered, threeElliptical, threePrism, threePyramid, threeRounded)

getStartAngle

public java.lang.Number getStartAngle()

Returns the clockwise angle in degrees from twelve o'clock for the zero value in pie and dount charts.

Specified by:

getStartAngle in interface IChartAttributes

Returns:

java.lang.Number

setStartAngle

public void setStartAngle(java.lang.Number startAngle)

Sets the clockwise angle in degrees from twelve o'clock for the zero value in pie and dount charts.

Specified by:

setStartAngle in interface IChartAttributes

Parameters:

startAngle - Number

getTooltipCaption

public java.lang.String getTooltipCaption()

Returns the tooltip string for datapoints and series.

Specified by:

getTooltipCaption in interface IChartAttributes

Returns:

java.lang.String

setTooltipCaption

public void setTooltipCaption(java.lang.String tooltipCaption)

Sets the tooltip string for datapoints and series.

Specified by:

setTooltipCaption in interface IChartAttributes

Parameters:

tooltipCaption - String

getValue

public java.lang.Number getValue()

Returns the numerical "value" value.<p> The value is used by column, area and line charts.

Specified by:

getValue in interface IChartAttributes

Returns:

java.lang.Number

setValue

public void setValue(java.lang.Number value)

Sets the numerical "value" value.<p> The value is used by column, area and line charts.

Specified by:

setValue in interface IChartAttributes

Parameters:

value - Number

getDataMapping

public java.lang.String getDataMapping()

Returns the data mapping used to convert the external data model to internal names.

Specified by:

getDataMapping in interface ISeriesBase

Returns:

java.lang.String