| Package | com.yahoo.astra.fl.charts.series |
| Class | public class Series |
| Inheritance | Series fl.core.UIComponent |
| Implements | ISeries |
| Subclasses | CartesianSeries, PieSeries |
Series object
shouldn't be instantiated directly. Instead, a subclass with a concrete
implementation should be used.
| Property | Defined by | ||
|---|---|---|---|
| chart : Object
The chart in which this series appears.
| Series | ||
| dataProvider : Object
The data provider for this series.
| Series | ||
| dataTipFunction : Function
DataTip Function for series
| Series | ||
| displayName : String
The name of the series as it appears to the user.
| Series | ||
| itemRenderer : Object
The class used to instantiate item renderers.
| Series | ||
| legendLabelFunction : Function
If defined, the chart will call the input function to determine the text displayed in
in the chart's legend.
| Series | ||
| length : int [read-only]
The number of items in the series.
| Series | ||
| Method | Defined by | ||
|---|---|---|---|
|
Series(dataProvider:Object = null)
Constructor.
| Series | ||
|
Creates a copy of the ISeries object.
| Series | ||
|
itemRendererToIndex(renderer:ISeriesItemRenderer):int
Returns the index of an item renderer.
| Series | ||
|
Converts an item to its corresponding item renderer.
| Series | ||
| Method | Defined by | ||
|---|---|---|---|
|
invalidateMarker(marker:ISeriesItemRenderer):void
Invalidates a marker (considered new).
| Series | ||
|
isMarkerInvalid(marker:ISeriesItemRenderer):Boolean
Indicates whether special considerations should be taken for a newly created marker.
| Series | ||
|
validateMarker(marker:ISeriesItemRenderer):void
Makes a marker valid.
| Series | ||
| chart | property |
chart:Object [read-write]The chart in which this series appears.
Implementation public function get chart():Object
public function set chart(value:Object):void
| dataProvider | property |
dataProvider:Object [read-write]
The data provider for this series. Accepts Array or XMLList objects.
public function get dataProvider():Object
public function set dataProvider(value:Object):void
| dataTipFunction | property |
dataTipFunction:Function [read-write]DataTip Function for series
Implementation public function get dataTipFunction():Function
public function set dataTipFunction(value:Function):void
| displayName | property |
displayName:String [read-write]The name of the series as it appears to the user.
Implementation public function get displayName():String
public function set displayName(value:String):void
| itemRenderer | property |
itemRenderer:Object [read-write]The class used to instantiate item renderers.
Implementation public function get itemRenderer():Object
public function set itemRenderer(value:Object):void
| legendLabelFunction | property |
legendLabelFunction:Function [read-write]If defined, the chart will call the input function to determine the text displayed in in the chart's legend.
Implementation public function get legendLabelFunction():Function
public function set legendLabelFunction(value:Function):void
| length | property |
length:int [read-only]The number of items in the series.
Implementation public function get length():int
| Series | () | constructor |
public function Series(dataProvider:Object = null)Constructor.
ParametersdataProvider:Object (default = null) |
| clone | () | method |
public function clone():ISeriesCreates a copy of the ISeries object.
ReturnsISeries —
a new ISeries object
|
| invalidateMarker | () | method |
protected function invalidateMarker(marker:ISeriesItemRenderer):voidInvalidates a marker (considered new).
Parametersmarker:ISeriesItemRenderer |
| isMarkerInvalid | () | method |
protected function isMarkerInvalid(marker:ISeriesItemRenderer):BooleanIndicates whether special considerations should be taken for a newly created marker.
Parametersmarker:ISeriesItemRenderer |
Boolean |
| itemRendererToIndex | () | method |
public function itemRendererToIndex(renderer:ISeriesItemRenderer):intReturns the index of an item renderer.
Parametersrenderer:ISeriesItemRenderer — The renderer whose index is to be returned.
|
int — The index of the renderer.
|
| itemToItemRenderer | () | method |
public function itemToItemRenderer(item:Object):ISeriesItemRendererConverts an item to its corresponding item renderer.
Parametersitem:Object — The item from the dataProvider to be converted to a renderer.
|
ISeriesItemRenderer —
The renderer that corresponds to the item.
|
| validateMarker | () | method |
protected function validateMarker(marker:ISeriesItemRenderer):voidMakes a marker valid. To be used by subclasses.
Parametersmarker:ISeriesItemRenderer |