Packagecom.yahoo.astra.fl.charts.axes
Interfacepublic interface IAxis
SubinterfacesICartesianAxisRenderer, IClusteringAxis, IOriginAxis, IRadialAxisRenderer, IStackingAxis
ImplementorsCategoryAxis, NumericAxis, TimeAxis

Data-only representation of a chart's axis.



Public Properties
 PropertyDefined by
  chart : IChart
The chart in which this axis appears.
IAxis
  labelFunction : Function
A function may be set to determine the text value of the labels.
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
Public Methods
 MethodDefined by
  
updateScale(data:Array):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
Property detail
chartproperty
chart:IChart  [read-write]

The chart in which this axis appears.

Implementation
    public function get chart():IChart
    public function set chart(value:IChart):void
labelFunctionproperty 
labelFunction:Function  [read-write]

A function may be set to determine the text value of the labels.

function labelFunction(value:Object):String

Implementation
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void
rendererproperty 
renderer:IAxisRenderer  [read-write]

The visual renderer associated with this axis.

Implementation
    public function get renderer():IAxisRenderer
    public function set renderer(value:IAxisRenderer):void
reverseproperty 
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
titleproperty 
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
Method detail
updateScale()method
public function updateScale(data:Array):void

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

Parameters
data:Array — The complete dataset that could be drawn on the axis.
valueToLabel()method 
public function valueToLabel(value:Object):String

Converts a value on the axis to formatted label text.

Parameters
value:Object — the value of the item for which a label is needed

Returns
String — the formatted label text
valueToLocal()method 
public function valueToLocal(value:Object):Number

Calculates the position of a data point along the axis.

Parameters
value:Object — The data used to determine the position

Returns
Number — The display position in pixels on the axis