| Package | com.yahoo.astra.fl.charts.axes |
| Interface | public interface IAxis |
| Subinterfaces | ICartesianAxisRenderer, IClusteringAxis, IOriginAxis, IRadialAxisRenderer, IStackingAxis |
| Implementors | CategoryAxis, NumericAxis, TimeAxis |
| Property | Defined by | ||
|---|---|---|---|
| chart : IChart
The chart in which this axis appears.
| IAxis | ||
| dataProvider : Array
Data used in determining the axis scale
| IAxis | ||
| labelFunction : Function
A function may be set to determine the text value of the labels.
| IAxis | ||
| labelSpacing : Number
The space, in pixels, between labels on an axis.
| IAxis | ||
| maxLabelHeight : Number
Gets or sets the maximum width of a label
| IAxis | ||
| maxLabelWidth : Number
Gets or sets the maximum width of a label
| IAxis | ||
| renderer : IAxisRenderer
The visual renderer associated with this axis.
| IAxis | ||
| reverse : Boolean
Sets the direction of the labels and other visual objects along the axis.
| IAxis | ||
| title : String
The text that will appear next to the axis to indicate information
about the data that it displays.
| IAxis | ||
| Method | Defined by | ||
|---|---|---|---|
|
getMaxLabel():String
Returns the maximum string length of a label on the axis.
| IAxis | ||
|
updateScale():void
Determines the axis scale based on the input data set.
| IAxis | ||
|
valueToLabel(value:Object):String
Converts a value on the axis to formatted label text.
| IAxis | ||
|
valueToLocal(value:Object):Number
Calculates the position of a data point along the axis.
| IAxis | ||
| chart | property |
chart:IChart [read-write]The chart in which this axis appears.
Implementation public function get chart():IChart
public function set chart(value:IChart):void
| dataProvider | property |
dataProvider:Array [read-write]Data used in determining the axis scale
Implementation public function get dataProvider():Array
public function set dataProvider(value:Array):void
| labelFunction | property |
labelFunction:Function [read-write]A function may be set to determine the text value of the labels.
function labelFunction(value:Object):StringImplementation
public function get labelFunction():Function
public function set labelFunction(value:Function):void
| labelSpacing | property |
labelSpacing:Number [read-write]The space, in pixels, between labels on an axis.
Implementation public function get labelSpacing():Number
public function set labelSpacing(value:Number):void
| maxLabelHeight | property |
maxLabelHeight:Number [read-write]Gets or sets the maximum width of a label
Implementation public function get maxLabelHeight():Number
public function set maxLabelHeight(value:Number):void
| maxLabelWidth | property |
maxLabelWidth:Number [read-write]Gets or sets the maximum width of a label
Implementation public function get maxLabelWidth():Number
public function set maxLabelWidth(value:Number):void
| renderer | property |
renderer:IAxisRenderer [read-write]The visual renderer associated with this axis.
Implementation public function get renderer():IAxisRenderer
public function set renderer(value:IAxisRenderer):void
| reverse | property |
reverse:Boolean [read-write]Sets the direction of the labels and other visual objects along the axis. By default, vertical axes draw objects from bottom to top, and horizontal axes draw objects from left to right.
Implementation public function get reverse():Boolean
public function set reverse(value:Boolean):void
| title | property |
title:String [read-write]The text that will appear next to the axis to indicate information about the data that it displays.
Implementation public function get title():String
public function set title(value:String):void
| getMaxLabel | () | method |
public function getMaxLabel():StringReturns the maximum string length of a label on the axis.
ReturnsString — the formatted label
|
| updateScale | () | method |
public function updateScale():voidDetermines the axis scale based on the input data set. Seperating this function from the draw method optimizes processing time, and it allows the chart to synchronize its axes.
| valueToLabel | () | method |
public function valueToLabel(value:Object):StringConverts a value on the axis to formatted label text.
Parametersvalue:Object — the value of the item for which a label is needed
|
String — the formatted label text
|
| valueToLocal | () | method |
public function valueToLocal(value:Object):NumberCalculates the position of a data point along the axis.
Parametersvalue:Object — The data used to determine the position
|
Number — The display position in pixels on the axis
|