YUI AS Component Documentation |
Interface ICartesianAxisRenderer

Package | com.yahoo.astra.fl.charts.axes
Interface | public interface ICartesianAxisRenderer extends IAxisRenderer
Implementors | DefaultAxisRenderer, HorizontalAxisRenderer, VerticalAxisRenderer

Interface for a cartesian chart's axis renderers.

See also

com.yahoo.astra.fl.charts.CartesianChart

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | contentBounds : Rectangle [read-only] Represents the area where content should be drawn within the axis. | ICartesianAxisRenderer
|  | length : Number The total length of the axis renderer, in pixels. | IAxisRenderer
|  | majorUnitSetByUser : Boolean Indicates whether the user explicitly set a major unit for the axis of this renderer. | ICartesianAxisRenderer
|  | minorTicks : Array An Array of AxisData objects specifying the positions of the minor ticks. | IAxisRenderer
|  | orientation : String Determines if the axis is displayed vertically or horizontally. | ICartesianAxisRenderer
|  | outerTickOffset : Number Indicates the number of pixels of an outer tick. | ICartesianAxisRenderer
|  | position : String Indicates alignment of axis | ICartesianAxisRenderer
|  | ticks : Array An Array of AxisData objects specifying the positions of the ticks. | IAxisRenderer
|  | title : String The title text to display on the axis. | ICartesianAxisRenderer

Public Methods

| Method | Defined by
--- | --- | ---
|  | updateAxis():void Calculates the `contentBounds` value for the axis renderer. | ICartesianAxisRenderer

Property detail

contentBounds | property

`contentBounds:Rectangle` [read-only]

Represents the area where content should be drawn within the axis. This value is used to determine the containing chart's own `contentBounds` property.

Implementation
`public function get contentBounds():Rectangle`

majorUnitSetByUser | property |

`majorUnitSetByUser:Boolean` [read-write]

Indicates whether the user explicitly set a major unit for the axis of this renderer.

Implementation
`public function get majorUnitSetByUser():Boolean`
`public function set majorUnitSetByUser(value:Boolean):void`

orientation | property |

`orientation:String` [read-write]

Determines if the axis is displayed vertically or horizontally.

Implementation
`public function get orientation():String`
`public function set orientation(value:String):void`

See also

com.yahoo.astra.fl.charts.axes.AxisOrientation

outerTickOffset | property |

`outerTickOffset:Number` [read-write]

Indicates the number of pixels of an outer tick.

Implementation
`public function get outerTickOffset():Number`
`public function set outerTickOffset(value:Number):void`

position | property |

`position:String` [read-write]

Indicates alignment of axis

Implementation
`public function get position():String`
`public function set position(value:String):void`

title | property |

`title:String` [read-write]

The title text to display on the axis.

Implementation
`public function get title():String`
`public function set title(value:String):void`
Method detail

updateAxis | () | method

`public function updateAxis():void`

Calculates the `contentBounds` value for the axis renderer. Seperating this function from the draw method optimizes processing time, and it allows the chart to synchronize its axes.