| Package | com.yahoo.astra.fl.charts.series |
| Class | public class PieSeries |
| Inheritance | PieSeries  Series fl.core.UIComponent |
| Implements | ICategorySeries |
| Property | Defined by | ||
|---|---|---|---|
| categoryField : String
The field used to access categories for this series.
| PieSeries | ||
| categoryNames : Array
The names of the categories displayed on the category axis.
| PieSeries | ||
 | chart : Object | Series | |
| dataField : String
The field used to access data for this series.
| PieSeries | ||
| dataProvider : Object | Series | |
| displayName : String | Series | |
| itemRenderer : Object
The class used to instantiate item renderers.
| Series | |
| labelFunction : Function
A function may be set to determine the text value of the labels.
| PieSeries | ||
| length : int | Series | |
| Method | Defined by | ||
|---|---|---|---|
|
PieSeries(data:Object = null)
Constructor.
| PieSeries | ||
|
Creates a copy of the ISeries object.
| PieSeries | ||
|
createLegendItemData():Array
Creates an Array of LegendItemData objects to pass to the chart's legend.
| PieSeries | ||
|
getStyleDefinition():Object
[static]
| PieSeries | ||
|
itemRendererToIndex(renderer:ISeriesItemRenderer):int
| Series | |
|
itemToCategory(item:Object, index:int):String
Converts an item to the category in which it is displayed.
| PieSeries | ||
|
itemToData(item:Object):Number
Converts an item to it's value.
| PieSeries | ||
|
itemToItemRenderer(item:Object):ISeriesItemRenderer
| Series | |
|
itemToPercentage(item:Object):Number
Converts an item's value to its percentage equivilent.
| PieSeries | ||
| Method | Defined by | ||
|---|---|---|---|
|
copyStylesToRenderer(child:ISeriesItemRenderer, styleMap:Object):void
Copies a styles from the series to a child through a style map.
| PieSeries | ||
|
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 | |
| Style | Description | Defined by | ||
|---|---|---|---|---|
| Type: int The duration for animations that occur on data changes. | Series | ||
| Type: Function The easing function for animations that occur on data changes. | Series | ||
| Type: Boolean If true, data changes will be displayed with animations. | Series | ||
| Type: Number The alpha value from 0.0 to 1.0 to use for drawing the border of markers. | Series | ||
| Type: uint The border color used by programatic skins in this series. | Series | ||
| Type: Number The alpha value from 0.0 to 1.0 to use for drawing the fills of markers. | Series | ||
| Type: uint The base color used by objects displayed in this series. | Series | ||
|
fillColors
| Type: Array The colors of the markers in this series. The default value is [0x729fcf, 0xfcaf3e, 0x73d216, 0xfce94f, 0xad7fa8, 0x3465a4]. | PieSeries | ||
|
hideOverlappingLabels
| Type: Boolean If true, marker labels that overlap previously-created labels will be hidden to improve readability. The default value is true. | PieSeries | ||
| Type: Number The alpha value from 0.0 to 1.0 to use for drawing the markers. | Series | ||
| Type: Number The size, in pixels, of each marker. | Series | ||
| Type: Class The Class used to instantiate each marker's skin. | Series | ||
|
showLabels
| Type: Boolean If true, a label is displayed on each marker. The label text is created with the labelFunction property of the series. The default label function sets the label to the percentage value of the item. The default value is false. | PieSeries | ||
| categoryField | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescategoryField:String [read-write]The field used to access categories for this series.
Implementation public function get categoryField():String
public function set categoryField(value:String):void
| categoryNames | property |
categoryNames:Array [read-write]The names of the categories displayed on the category axis. If the chart does not have a category axis, this value will be ignored.
Implementation public function get categoryNames():Array
public function set categoryNames(value:Array):void
| dataField | property |
dataField:String [read-write]The field used to access data for this series.
Implementation public function get dataField():String
public function set dataField(value:String):void
| labelFunction | property |
labelFunction:Function [read-write]A function may be set to determine the text value of the labels.
function labelFunction(item:Object):StringImplementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void
| PieSeries | () | constructor |
public function PieSeries(data:Object = null)Constructor.
Parametersdata:Object (default = null) |
| clone | () | method |
public override function clone():ISeriesCreates a copy of the ISeries object.
ReturnsISeries —
a new ISeries object
|
| copyStylesToRenderer | () | method |
protected function copyStylesToRenderer(child:ISeriesItemRenderer, styleMap:Object):voidCopies a styles from the series to a child through a style map.
Parameterschild:ISeriesItemRenderer |
|
styleMap:Object |
See also
| createLegendItemData | () | method |
public function createLegendItemData():ArrayCreates an Array of LegendItemData objects to pass to the chart's legend.
ReturnsArray |
| getStyleDefinition | () | method |
public static function getStyleDefinition():ObjectReturns
Object |
| itemToCategory | () | method |
public function itemToCategory(item:Object, index:int):StringConverts an item to the category in which it is displayed.
Parametersitem:Object |
|
index:int |
String |
| itemToData | () | method |
public function itemToData(item:Object):NumberConverts an item to it's value.
Parametersitem:Object |
Number |
| itemToPercentage | () | method |
public function itemToPercentage(item:Object):NumberConverts an item's value to its percentage equivilent.
Parametersitem:Object |
Number |