com.infragistics.faces.chart.component
Class DataPoint

java.lang.Object
  extended bycom.infragistics.faces.shared.component.ModelComponent
      extended bycom.infragistics.faces.chart.component.DataPoint
All Implemented Interfaces:
IChartAttributes, java.io.Serializable

public class DataPoint
extends ModelComponent
implements IChartAttributes

Defines an individual datapoint in a series

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
DataPoint()
           
 
Method Summary
 java.lang.Object getChartAttribute(java.lang.String key)
          Returns the named attribute value.
 java.util.Map getChartAttributes()
          Returns the map of attribute names to attribute values.
 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 value)
          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 value)
          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 value)
          Sets the CSS style class that is applied to data points or series.
 void setExplodedRadius(java.lang.Number value)
          Sets the percentage of available space used to offset pie and donut segments.
 void setHigh(java.lang.Number value)
          Sets the numerical "high" value.<p> The high value is used by range, candlestick and OHLC charts.
 void setInnerRadius(java.lang.Number value)
          Sets the percentage of available space used for donut holes.
 void setLegendCaption(java.lang.String value)
          Sets the legend label for data points and series in automatic legend fill mode.
 void setLegendCaptionStyleClass(java.lang.String value)
          Sets the CSS style class applied to automatically generated legend labels.
 void setLow(java.lang.Number value)
          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 value)
          Sets the CSS style class applied to datapoint bullets.
 void setMarkerBulletType(java.lang.String value)
          Sets the datapoint bullet shape.
 void setMarkerBulletVisible(java.lang.Boolean value)
          Sets the datapoint bullet visibility flag.
 void setMarkerCaption(java.lang.String value)
          Sets the datapoint label string.
 void setMarkerCaptionStyleClass(java.lang.String value)
          Sets the CSS style class applied to datapoint labels.
 void setMarkerCaptionVisible(java.lang.Boolean value)
          Sets the datapoint label string visibility flag.
 void setOpen(java.lang.Number value)
          Sets the numerical "open" value<p> The open value is used by candlestick and OHLC charts.
 void setRadius(java.lang.Number value)
          Sets the percentage of available space used to create pie and donut segments.
 void setShapeType(java.lang.String value)
          Sets the shape applied to datapoints and series.
 void setStartAngle(java.lang.Number value)
          Sets the clockwise angle in degrees from twelve o'clock for the zero value in pie and dount charts.
 void setTooltipCaption(java.lang.String value)
          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

DataPoint

public DataPoint()
Method Detail

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()
Description copied from interface: IChartAttributes
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)
Description copied from interface: IChartAttributes
Sets the numerical "close" value.<p> The close value is used by candlestick and OHLC charts.

Specified by:
setClose in interface IChartAttributes
Parameters:
close -

getClusterWidth

public java.lang.Number getClusterWidth()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
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:
value -

getColumnWidth

public java.lang.Number getColumnWidth()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
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:
value -

getDataStyleClass

public java.lang.String getDataStyleClass()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the CSS style class that is applied to data points or series.

Specified by:
setDataStyleClass in interface IChartAttributes
Parameters:
value -

getExplodedRadius

public java.lang.Number getExplodedRadius()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the percentage of available space used to offset pie and donut segments.

Specified by:
setExplodedRadius in interface IChartAttributes
Parameters:
value -

getHigh

public java.lang.Number getHigh()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the numerical "high" value.<p> The high value is used by range, candlestick and OHLC charts.

Specified by:
setHigh in interface IChartAttributes
Parameters:
value -

getInnerRadius

public java.lang.Number getInnerRadius()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the percentage of available space used for donut holes.

Specified by:
setInnerRadius in interface IChartAttributes
Parameters:
value -

getLegendCaption

public java.lang.String getLegendCaption()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the legend label for data points and series in automatic legend fill mode.

Specified by:
setLegendCaption in interface IChartAttributes
Parameters:
value -

getLegendCaptionStyleClass

public java.lang.String getLegendCaptionStyleClass()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the CSS style class applied to automatically generated legend labels.

Specified by:
setLegendCaptionStyleClass in interface IChartAttributes
Parameters:
value -

getLow

public java.lang.Number getLow()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the numerical "low" value.<p> The low value is used by range, candlestick and OHLC charts.

Specified by:
setLow in interface IChartAttributes
Parameters:
value -

getMarkerBulletStyleClass

public java.lang.String getMarkerBulletStyleClass()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the CSS style class applied to datapoint bullets.

Specified by:
setMarkerBulletStyleClass in interface IChartAttributes
Parameters:
value -

getMarkerBulletSize

public java.lang.Number getMarkerBulletSize()
Description copied from interface: IChartAttributes
Returns the marker size (in pixels).

Specified by:
getMarkerBulletSize in interface IChartAttributes
Returns:
java.lang.Number

setMarkerBulletSize

public void setMarkerBulletSize(java.lang.Number markerBulletSize)
Description copied from interface: IChartAttributes
Sets the marker size (in pixels).

Specified by:
setMarkerBulletSize in interface IChartAttributes
Parameters:
markerBulletSize -

getMarkerBulletType

public java.lang.String getMarkerBulletType()
Description copied from interface: IChartAttributes
Returns the datapoint bullet shape.

Specified by:
getMarkerBulletType in interface IChartAttributes
Returns:
com.infragistics.faces.chart.enumeration.BulletType

setMarkerBulletType

public void setMarkerBulletType(java.lang.String value)
Description copied from interface: IChartAttributes
Sets the datapoint bullet shape.

Specified by:
setMarkerBulletType in interface IChartAttributes
Parameters:
value -

getMarkerBulletVisible

public java.lang.Boolean getMarkerBulletVisible()
Description copied from interface: IChartAttributes
Returns the datapoint bullet visibility flag.

Specified by:
getMarkerBulletVisible in interface IChartAttributes
Returns:
java.lang.Boolean

setMarkerBulletVisible

public void setMarkerBulletVisible(java.lang.Boolean value)
Description copied from interface: IChartAttributes
Sets the datapoint bullet visibility flag.

Specified by:
setMarkerBulletVisible in interface IChartAttributes
Parameters:
value -

getMarkerCaption

public java.lang.String getMarkerCaption()
Description copied from interface: IChartAttributes
Returns the datapoint label string.

Specified by:
getMarkerCaption in interface IChartAttributes
Returns:
java.lang.String

setMarkerCaption

public void setMarkerCaption(java.lang.String value)
Description copied from interface: IChartAttributes
Sets the datapoint label string.

Specified by:
setMarkerCaption in interface IChartAttributes
Parameters:
value -

getMarkerCaptionStyleClass

public java.lang.String getMarkerCaptionStyleClass()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the CSS style class applied to datapoint labels.

Specified by:
setMarkerCaptionStyleClass in interface IChartAttributes
Parameters:
value -

getMarkerCaptionVisible

public java.lang.Boolean getMarkerCaptionVisible()
Description copied from interface: IChartAttributes
Returns the datapoint label string visibility flag.

Specified by:
getMarkerCaptionVisible in interface IChartAttributes
Returns:
java.lang.Boolean

setMarkerCaptionVisible

public void setMarkerCaptionVisible(java.lang.Boolean value)
Description copied from interface: IChartAttributes
Sets the datapoint label string visibility flag.

Specified by:
setMarkerCaptionVisible in interface IChartAttributes
Parameters:
value -

getOpen

public java.lang.Number getOpen()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the numerical "open" value<p> The open value is used by candlestick and OHLC charts.

Specified by:
setOpen in interface IChartAttributes
Parameters:
value -

getRadius

public java.lang.Number getRadius()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the percentage of available space used to create pie and donut segments.

Specified by:
setRadius in interface IChartAttributes
Parameters:
value -

getShapeType

public java.lang.String getShapeType()
Description copied from interface: IChartAttributes
Returns the shape applied to datapoints and series.

Specified by:
getShapeType in interface IChartAttributes
Returns:
com.infragistics.faces.chart.enumeration.ShapeType

setShapeType

public void setShapeType(java.lang.String value)
Description copied from interface: IChartAttributes
Sets the shape applied to datapoints and series.

Specified by:
setShapeType in interface IChartAttributes
Parameters:
value -

getStartAngle

public java.lang.Number getStartAngle()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
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:
value -

getTooltipCaption

public java.lang.String getTooltipCaption()
Description copied from interface: IChartAttributes
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 value)
Description copied from interface: IChartAttributes
Sets the tooltip string for datapoints and series.

Specified by:
setTooltipCaption in interface IChartAttributes
Parameters:
value -

getValue

public java.lang.Number getValue()
Description copied from interface: IChartAttributes
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)
Description copied from interface: IChartAttributes
Sets the numerical "value" value.<p> The value is used by column, area and line charts.

Specified by:
setValue in interface IChartAttributes
Parameters:
value -

getChartAttributes

public java.util.Map getChartAttributes()
Returns the map of attribute names to attribute values. The map will not be created if the datapoint has no defined chart attributes.

Returns: