Packagecom.yahoo.astra.fl.charts.axes
Classpublic class BaseAxis
SubclassesCategoryAxis, NumericAxis, TimeAxis

Implements some of the most common axis functionality to prevent duplicate code in IAxis implementations.

This class is not meant to be instantiated directly! It is an abstract base class.



Public Properties
 PropertyDefined by
  chart : IChart
The chart in which this axis appears.
BaseAxis
  dataProvider : Array
Data provider for the axis
BaseAxis
  labelFunction : Function
BaseAxis
  labelSpacing : Number
The space, in pixels, between labels on an axis.
BaseAxis
  maxLabelHeight : Number
Gets or sets the maximum height of a label
BaseAxis
  maxLabelWidth : Number
Gets or sets the maximum width of a label
BaseAxis
  renderer : IAxisRenderer
The visual renderer applied to this axis.
BaseAxis
  reverse : Boolean
Sets the direction of the labels and other visual objects along the axis.
BaseAxis
  title : String
The text that will appear next to the axis to indicate information about the data that it displays.
BaseAxis
Public Methods
 MethodDefined by
  
Constructor.
BaseAxis
  
valueToLabel(value:Object):String
Converts a value on the axis to formatted label text.
BaseAxis
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
dataProviderproperty 
dataProvider:Array  [read-write]

Data provider for the axis

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

Implementation
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void
labelSpacingproperty 
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
maxLabelHeightproperty 
maxLabelHeight:Number  [read-write]

Gets or sets the maximum height of a label

Implementation
    public function get maxLabelHeight():Number
    public function set maxLabelHeight(value:Number):void
maxLabelWidthproperty 
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
rendererproperty 
renderer:IAxisRenderer  [read-write]

The visual renderer applied to 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
Constructor detail
BaseAxis()constructor
public function BaseAxis()

Constructor.

Method detail
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