com.infragistics.faces.chart.component
Interface IChartAttributes

All Known Implementing Classes:

DataPoint, Series

public interface IChartAttributes

Interface for all classes which support chart attributes.

Classes which implement this interface allow users to attach arbitrary porperties intended for use either by the charting components themselves or by user event listeners.

A number of attributes (referred to as the canonical attributes) are predefined by the charting components, with typesafe accessor methods defined in this interface which should be called in preference to the generic setChartAttribute(), getChartAttribute() functions.

Field Summary

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

Method Summary

java.lang.Object	getChartAttribute(java.lang.String key) Returns the named attribute value.
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	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	setChartAttribute(java.lang.String key, java.lang.Object value) Set an arbitrary named attribute to an attribute value.
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	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.

Field Detail

hello

public static final java.lang.String hello

See Also:

Constant Field Values

CLOSE

public static final java.lang.String CLOSE

See Also:

Constant Field Values

EXPLODED_RADIUS

public static final java.lang.String EXPLODED_RADIUS

See Also:

Constant Field Values

HIGH

public static final java.lang.String HIGH

See Also:

Constant Field Values

INNER_RADIUS

public static final java.lang.String INNER_RADIUS

See Also:

Constant Field Values

LEGEND_CAPTION

public static final java.lang.String LEGEND_CAPTION

See Also:

Constant Field Values

LEGEND_CAPTION_STYLE_CLASS

public static final java.lang.String LEGEND_CAPTION_STYLE_CLASS

See Also:

Constant Field Values

LOW

public static final java.lang.String LOW

See Also:

Constant Field Values

MARKER_BULLET_STYLE_CLASS

public static final java.lang.String MARKER_BULLET_STYLE_CLASS

See Also:

Constant Field Values

MARKER_BULLET_SIZE

public static final java.lang.String MARKER_BULLET_SIZE

See Also:

Constant Field Values

MARKER_BULLET_TYPE

public static final java.lang.String MARKER_BULLET_TYPE

See Also:

Constant Field Values

MARKER_BULLET_VISIBLE

public static final java.lang.String MARKER_BULLET_VISIBLE

See Also:

Constant Field Values

MARKER_CAPTION

public static final java.lang.String MARKER_CAPTION

See Also:

Constant Field Values

MARKER_CAPTION_STYLE_CLASS

public static final java.lang.String MARKER_CAPTION_STYLE_CLASS

See Also:

Constant Field Values

MARKER_CAPTION_VISIBLE

public static final java.lang.String MARKER_CAPTION_VISIBLE

See Also:

Constant Field Values

OPEN

public static final java.lang.String OPEN

See Also:

Constant Field Values

RADIUS

public static final java.lang.String RADIUS

See Also:

Constant Field Values

SHAPE_TYPE

public static final java.lang.String SHAPE_TYPE

See Also:

Constant Field Values

START_ANGLE

public static final java.lang.String START_ANGLE

See Also:

Constant Field Values

TOOLTIP_CAPTION

public static final java.lang.String TOOLTIP_CAPTION

See Also:

Constant Field Values

VALUE

public static final java.lang.String VALUE

See Also:

Constant Field Values

CLUSTER_WIDTH

public static final java.lang.String CLUSTER_WIDTH

See Also:

Constant Field Values

COLUMN_WIDTH

public static final java.lang.String COLUMN_WIDTH

See Also:

Constant Field Values

DATA_STYLE_CLASS

public static final java.lang.String DATA_STYLE_CLASS

See Also:

Constant Field Values

Method Detail

getClose

public java.lang.Number getClose()

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

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.

Parameters:

close -

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

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

Parameters:

clusterWidth -

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.

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.

Parameters:

columnWidth -

getDataStyleClass

public java.lang.String getDataStyleClass()

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

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.

Parameters:

dataStyleClass -

getExplodedRadius

public java.lang.Number getExplodedRadius()

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

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.

Parameters:

explodedRadius -

getHigh

public java.lang.Number getHigh()

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

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.

Parameters:

high -

getInnerRadius

public java.lang.Number getInnerRadius()

Returns the percentage of available space used for donut holes.

Returns:

java.lang.Number

setInnerRadius

public void setInnerRadius(java.lang.Number innerRadius)

Sets the percentage of available space used for donut holes.

Parameters:

innerRadius -

getLegendCaption

public java.lang.String getLegendCaption()

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

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.

Parameters:

legendCaption -

getLegendCaptionStyleClass

public java.lang.String getLegendCaptionStyleClass()

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

Returns:

java.lang.String

setLegendCaptionStyleClass

public void setLegendCaptionStyleClass(java.lang.String legendCaptionStyleClass)

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

Parameters:

legendCaptionStyleClass -

getLow

public java.lang.Number getLow()

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

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.

Parameters:

low -

getMarkerBulletSize

public java.lang.Number getMarkerBulletSize()

Returns the marker size (in pixels).

Returns:

java.lang.Number

setMarkerBulletSize

public void setMarkerBulletSize(java.lang.Number markerBulletSize)

Sets the marker size (in pixels).

Parameters:

markerBulletSize -

getMarkerBulletStyleClass

public java.lang.String getMarkerBulletStyleClass()

Returns the CSS style class applied to datapoint bullets.

Returns:

java.lang.String

setMarkerBulletStyleClass

public void setMarkerBulletStyleClass(java.lang.String markerBulletStyleClass)

Sets the CSS style class applied to datapoint bullets.

Parameters:

markerBulletStyleClass -

getMarkerBulletType

public java.lang.String getMarkerBulletType()

Returns the datapoint bullet shape.

Returns:

com.infragistics.faces.chart.enumeration.BulletType

setMarkerBulletType

public void setMarkerBulletType(java.lang.String markerBulletType)

Sets the datapoint bullet shape.

Parameters:

markerBulletType -

getMarkerBulletVisible

public java.lang.Boolean getMarkerBulletVisible()

Returns the datapoint bullet visibility flag.

Returns:

java.lang.Boolean

setMarkerBulletVisible

public void setMarkerBulletVisible(java.lang.Boolean markerBulletVisible)

Sets the datapoint bullet visibility flag.

Parameters:

markerBulletVisible -

getMarkerCaption

public java.lang.String getMarkerCaption()

Returns the datapoint label string.

Returns:

java.lang.String

setMarkerCaption

public void setMarkerCaption(java.lang.String markerCaption)

Sets the datapoint label string.

Parameters:

markerCaption -

getMarkerCaptionStyleClass

public java.lang.String getMarkerCaptionStyleClass()

Returns the CSS style class applied to datapoint labels.

Returns:

java.lang.String

setMarkerCaptionStyleClass

public void setMarkerCaptionStyleClass(java.lang.String markerCaptionStyleClass)

Sets the CSS style class applied to datapoint labels.

Parameters:

markerCaptionStyleClass -

getMarkerCaptionVisible

public java.lang.Boolean getMarkerCaptionVisible()

Returns the datapoint label string visibility flag.

Returns:

java.lang.Boolean

setMarkerCaptionVisible

public void setMarkerCaptionVisible(java.lang.Boolean markerCaptionVisible)

Sets the datapoint label string visibility flag.

Parameters:

markerCaptionVisible -

getOpen

public java.lang.Number getOpen()

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

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.

Parameters:

open -

getRadius

public java.lang.Number getRadius()

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

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.

Parameters:

radius -

getShapeType

public java.lang.String getShapeType()

Returns the shape applied to datapoints and series.

Returns:

com.infragistics.faces.chart.enumeration.ShapeType

setShapeType

public void setShapeType(java.lang.String shapeType)

Sets the shape applied to datapoints and series.

Parameters:

shapeType -

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.

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.

Parameters:

startAngle -

getTooltipCaption

public java.lang.String getTooltipCaption()

Returns the tooltip string for datapoints and series.

Returns:

java.lang.String

setTooltipCaption

public void setTooltipCaption(java.lang.String tooltipCaption)

Sets the tooltip string for datapoints and series.

Parameters:

tooltipCaption -

getValue

public java.lang.Number getValue()

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

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.

Parameters:

value -

setChartAttribute

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

Set an arbitrary named attribute to an attribute value.

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.

getChartAttribute

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

Returns the named attribute value.

Parameters:

key - the attribute name. may not be null.

Returns:

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