Packagecom.yahoo.astra.fl.charts.axes
Classpublic class CategoryAxis
InheritanceCategoryAxis Inheritance BaseAxis
ImplementsIAxis, IClusteringAxis

An axis type representing a set of categories.



Public Properties
 PropertyDefined by
  categoryNames : Array
The category labels to display along the axis.
CategoryAxis
 Inheritedchart : IChart
The chart in which this axis appears.
BaseAxis
  clusterCount : int
[read-only] The number of clusters available on the axis.
CategoryAxis
 InheritedlabelFunction : Function
BaseAxis
 Inheritedrenderer : IAxisRenderer
The visual renderer applied to this axis.
BaseAxis
 Inheritedreverse : Boolean
Sets the direction of the labels and other visual objects along the axis.
BaseAxis
 Inheritedtitle : 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.
CategoryAxis
  
updateScale(data:Array):void
Determines the axis scale based on the input data set.
CategoryAxis
 Inherited
valueToLabel(value:Object):String
Converts a value on the axis to formatted label text.
BaseAxis
  
valueToLocal(value:Object):Number
Calculates the position of a data point along the axis.
CategoryAxis
Property detail
categoryNamesproperty
categoryNames:Array  [read-write]

The category labels to display along the axis.

Implementation
    public function get categoryNames():Array
    public function set categoryNames(value:Array):void
clusterCountproperty 
clusterCount:int  [read-only]

The number of clusters available on the axis. In the case of the CategoryAxis, this is the number of category names displayed on the axis.

Implementation
    public function get clusterCount():int
Constructor detail
CategoryAxis()constructor
public function CategoryAxis()

Constructor.

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