Packagecom.yahoo.astra.fl.charts.axes
Classpublic class DefaultAxisRenderer
InheritanceDefaultAxisRenderer Inheritance fl.core.UIComponent
ImplementsICartesianAxisRenderer

The default axis renderer for a cartesian chart.

See also

com.yahoo.astra.fl.charts.CartesianChart


Public Properties
 PropertyDefined by
  contentBounds : Rectangle
[read-only] Represents the area where content should be drawn within the axis.
DefaultAxisRenderer
  length : Number
[read-only] The total length of the axis renderer, in pixels.
DefaultAxisRenderer
  majorUnitSetByUser : Boolean
Indicates whether the major unit is user-defined or generated by the axis.
DefaultAxisRenderer
  minorTicks : Array
An Array of AxisData objects specifying the positions of the minor ticks.
DefaultAxisRenderer
  orientation : String
Determines if the axis is displayed vertically or horizontally.
DefaultAxisRenderer
  outerTickOffset : Number
DefaultAxisRenderer
  ticks : Array
An Array of AxisData objects specifying the positions of the ticks.
DefaultAxisRenderer
  title : String
The title text to display on the axis.
DefaultAxisRenderer
Public Methods
 MethodDefined by
  
DefaultAxisRenderer(orientation:String)
Constructor.
DefaultAxisRenderer
  
[static]
DefaultAxisRenderer
  
updateAxis():void
Calculates the contentBounds value for the axis renderer.
DefaultAxisRenderer
Styles
 StyleDescriptionDefined by
  
axisColor
Type: uint
The line color for the axis. The default value is #888a85.
DefaultAxisRenderer
  
axisWeight
Type: int
The line weight, in pixels, for the axis. The default value is 1.
DefaultAxisRenderer
  
hideOverlappingLabels
Type: Boolean
If true, labels that overlap previously drawn labels on the axis will be hidden. The first and last labels on the axis will always be drawn. The default value is true.
DefaultAxisRenderer
  
labelDistance
Type: Number
The distance, in pixels, between a label and the axis. The default value is 2.
DefaultAxisRenderer
  
labelRotation
Type: Number
The angle, in degrees, of the labels on the axis. May be a value between -90 and 90. The default value is 0.
DefaultAxisRenderer
  
minorTickColor
Type: uint
The line color for the minor ticks on the axis. The default value is #888a85.
DefaultAxisRenderer
  
minorTickLength
Type: Number
The length of the minor ticks on the axis. The default value is 3.
DefaultAxisRenderer
  
minorTickPosition
Type: String
The position of the minor ticks on the axis. The default value is "outside".
DefaultAxisRenderer
  
minorTickWeight
Type: int
The line weight, in pixels, for the minor ticks on the axis. The default value is 1.
DefaultAxisRenderer
  
showAxis
Type: Boolean
If false, the axis is not drawn. Titles, labels, ticks, and grid lines may still be drawn, however, so you must specifically hide each item if nothing should be drawn. The default value is true.
DefaultAxisRenderer
  
showLabels
Type: Boolean
If true, labels will be displayed on the axis. The default value is true.
DefaultAxisRenderer
  
showMinorTicks
Type: Boolean
If true, ticks will be displayed on the axis at minor positions. The default value is true.
DefaultAxisRenderer
  
showTicks
Type: Boolean
If true, ticks will be displayed on the axis. The default value is true.
DefaultAxisRenderer
  
showTitle
Type: Boolean
If true, the axis title will be displayed. The default value is 2.
DefaultAxisRenderer
  
tickColor
Type: uint
The line color for the ticks on the axis. The default value is #888a85.
DefaultAxisRenderer
  
tickLength
Type: Number
The length, in pixels, of the ticks on the axis. The default value is 4.
DefaultAxisRenderer
  
tickPosition
Type: String
The position of the ticks on the axis. The default value is "cross".
DefaultAxisRenderer
  
tickWeight
Type: int
The line weight, in pixels, for the ticks on the axis. The default value is 1.
DefaultAxisRenderer
  
titleDistance
Type: Number
The distance, in pixels, between a title and the axis labels. The default value is 2.
DefaultAxisRenderer
  
titleRotation
Type: Number
The angle, in degrees, of the title on the axis. May be a value between -90 and 90. The default value is 0.
DefaultAxisRenderer
  
titleTextFormat
Type: TextFormat
The TextFormat object to use to render the axis title label. The default value is TextFormat("_sans", 11, 0x000000, false, false, false, '', '', TextFormatAlign.LEFT, 0, 0, 0, 0).
DefaultAxisRenderer
Property detail
contentBoundsproperty
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
lengthproperty 
length:Number  [read-only]

The total length of the axis renderer, in pixels.

Implementation
    public function get length():Number
majorUnitSetByUserproperty 
majorUnitSetByUser:Boolean  [read-write]

Indicates whether the major unit is user-defined or generated by the axis.

Implementation
    public function get majorUnitSetByUser():Boolean
    public function set majorUnitSetByUser(value:Boolean):void
minorTicksproperty 
minorTicks:Array  [read-write]

An Array of AxisData objects specifying the positions of the minor ticks.

Implementation
    public function get minorTicks():Array
    public function set minorTicks(value:Array):void
orientationproperty 
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
outerTickOffsetproperty 
outerTickOffset:Number  [read-write]Implementation
    public function get outerTickOffset():Number
    public function set outerTickOffset(value:Number):void
ticksproperty 
ticks:Array  [read-write]

An Array of AxisData objects specifying the positions of the ticks.

Implementation
    public function get ticks():Array
    public function set ticks(value:Array):void
titleproperty 
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
Constructor detail
DefaultAxisRenderer()constructor
public function DefaultAxisRenderer(orientation:String)

Constructor.

Parameters
orientation:String
Method detail
getStyleDefinition()method
public static function getStyleDefinition():Object

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