Packagecom.flexicious.components.charts.axis
Interfacepublic interface IAxis extends flash.events.IEventDispatcher, mx.core.IUIComponent, mx.core.IInvalidating
Implementors HorizontalAxis, VerticalAxis

The IAxis class is an abstract interface for defining label, tick mark, and data positioning properties for a chart axis.

Classes implement this interface to provide range definition functionality.



Public Properties
 PropertyDefined By
  chart : CartesianChart
IAxis
  displayName : String
[read-only] The name of the axis.
IAxis
  labelRotation : Number
The degrees to rotate the label by
IAxis
  labelXOffset : Number
To accomodate various positioning scenarios, the default calculation of the labels can be changed.
IAxis
  labelYOffset : Number
To accomodate various positioning scenarios, the default calculation of the labels can be changed.
IAxis
  rangeGap : Number
Distance between the edge of the dial, and the edge of the range arc as well as the needle tip.
IAxis
  tickEndValue : Number
The numeric value to assicoate with the endAngle.
IAxis
  tickLabelFactory : IFactory
The factory used to instantiate the tick labels.
IAxis
  tickLabelFunction : Function
The label function that determines the label for the tick.
IAxis
  tickLabelPrecision : Number
Precision of the tick labels
IAxis
  tickMajorColor : uint
The color of the major tick Default: white
IAxis
  tickMajorLabelStyleName : String
The style name to apply to the major tick labels Default: tickMajorLabel
IAxis
  tickMajorLength : uint
The length of the major tick Default: 22
IAxis
  tickMajorStartOffset : Number
The start offset at which to being drawing the major tick.
IAxis
  tickMajorStep : Number
The numeric difference between two major ticks.
IAxis
  tickMajorThickness : int
The thickness of the major tick Default: 2
IAxis
  tickMinorColor : uint
The color of the minor tick Default: white
IAxis
  tickMinorLabelStyleName : String
The style name ot apply to the minor tick labels Default: tickMinorLabel
IAxis
  tickMinorLength : uint
The length of the minor tick Default: 16
IAxis
  tickMinorStartOffset : Number
The start offset at which to being drawing the minor tick.
IAxis
  tickMinorStep : Number
The numeric difference between two minor ticks Default: 5
IAxis
  tickMinorThickness : int
The thickness of the minor tick Default: 2
IAxis
  tickShowMajorLabels : Boolean
Whether or not to show major tick labels Default: true
IAxis
  tickShowMinorLabels : Boolean
Whether or not to show values for minor tick labels Default: false
IAxis
  tickStartValue : Number
The numeric value to assicoate with the startAngle.
IAxis
  tickSteps : Array
For custom drawn ticks, where we provide the tick steps.
IAxis
  title : String
[read-only] The text for the title displayed along the axis.
IAxis
Public Methods
 MethodDefined By
  
Rebuilds the axis
IAxis
Property Detail
chartproperty
chart:CartesianChart


Implementation
    public function get chart():CartesianChart
    public function set chart(value:CartesianChart):void
displayNameproperty 
displayName:String  [read-only]

The name of the axis. If set, Flex uses this name to format DataTip controls.


Implementation
    public function get displayName():String
labelRotationproperty 
labelRotation:Number

The degrees to rotate the label by


Implementation
    public function get labelRotation():Number
    public function set labelRotation(value:Number):void
labelXOffsetproperty 
labelXOffset:Number

To accomodate various positioning scenarios, the default calculation of the labels can be changed. This property lets you move the labels by a specific amount to the left or right


Implementation
    public function get labelXOffset():Number
    public function set labelXOffset(value:Number):void
labelYOffsetproperty 
labelYOffset:Number

To accomodate various positioning scenarios, the default calculation of the labels can be changed. This property lets you move the labels by a specific amount to the top or bottom


Implementation
    public function get labelYOffset():Number
    public function set labelYOffset(value:Number):void
rangeGapproperty 
rangeGap:Number

Distance between the edge of the dial, and the edge of the range arc as well as the needle tip.


Implementation
    public function get rangeGap():Number
    public function set rangeGap(value:Number):void
tickEndValueproperty 
tickEndValue:Number

The numeric value to assicoate with the endAngle. In other words, the end of the dial scale.


Implementation
    public function get tickEndValue():Number
    public function set tickEndValue(value:Number):void
tickLabelFactoryproperty 
tickLabelFactory:IFactory

The factory used to instantiate the tick labels. Default: spark.components.Label


Implementation
    public function get tickLabelFactory():IFactory
    public function set tickLabelFactory(value:IFactory):void
tickLabelFunctionproperty 
tickLabelFunction:Function

The label function that determines the label for the tick. Gets the default text that the tick would have gotten, as well as the tick index.


Implementation
    public function get tickLabelFunction():Function
    public function set tickLabelFunction(value:Function):void
tickLabelPrecisionproperty 
tickLabelPrecision:Number

Precision of the tick labels


Implementation
    public function get tickLabelPrecision():Number
    public function set tickLabelPrecision(value:Number):void
tickMajorColorproperty 
tickMajorColor:uint

The color of the major tick Default: white


Implementation
    public function get tickMajorColor():uint
    public function set tickMajorColor(value:uint):void
tickMajorLabelStyleNameproperty 
tickMajorLabelStyleName:String

The style name to apply to the major tick labels Default: tickMajorLabel


Implementation
    public function get tickMajorLabelStyleName():String
    public function set tickMajorLabelStyleName(value:String):void
tickMajorLengthproperty 
tickMajorLength:uint

The length of the major tick Default: 22


Implementation
    public function get tickMajorLength():uint
    public function set tickMajorLength(value:uint):void
tickMajorStartOffsetproperty 
tickMajorStartOffset:Number

The start offset at which to being drawing the major tick. This is the inner position, i.e. towards the center. The distance from the edge of the rangeGap the top of the tick Default: 18


Implementation
    public function get tickMajorStartOffset():Number
    public function set tickMajorStartOffset(value:Number):void
tickMajorStepproperty 
tickMajorStep:Number

The numeric difference between two major ticks. Default: 20


Implementation
    public function get tickMajorStep():Number
    public function set tickMajorStep(value:Number):void
tickMajorThicknessproperty 
tickMajorThickness:int

The thickness of the major tick Default: 2


Implementation
    public function get tickMajorThickness():int
    public function set tickMajorThickness(value:int):void
tickMinorColorproperty 
tickMinorColor:uint

The color of the minor tick Default: white


Implementation
    public function get tickMinorColor():uint
    public function set tickMinorColor(value:uint):void
tickMinorLabelStyleNameproperty 
tickMinorLabelStyleName:String

The style name ot apply to the minor tick labels Default: tickMinorLabel


Implementation
    public function get tickMinorLabelStyleName():String
    public function set tickMinorLabelStyleName(value:String):void
tickMinorLengthproperty 
tickMinorLength:uint

The length of the minor tick Default: 16


Implementation
    public function get tickMinorLength():uint
    public function set tickMinorLength(value:uint):void
tickMinorStartOffsetproperty 
tickMinorStartOffset:Number

The start offset at which to being drawing the minor tick. This is the inner position, i.e. towards the center. The distance from the edge of the rangeGap the top of the tick Default: 11


Implementation
    public function get tickMinorStartOffset():Number
    public function set tickMinorStartOffset(value:Number):void
tickMinorStepproperty 
tickMinorStep:Number

The numeric difference between two minor ticks Default: 5


Implementation
    public function get tickMinorStep():Number
    public function set tickMinorStep(value:Number):void
tickMinorThicknessproperty 
tickMinorThickness:int

The thickness of the minor tick Default: 2


Implementation
    public function get tickMinorThickness():int
    public function set tickMinorThickness(value:int):void
tickShowMajorLabelsproperty 
tickShowMajorLabels:Boolean

Whether or not to show major tick labels Default: true


Implementation
    public function get tickShowMajorLabels():Boolean
    public function set tickShowMajorLabels(value:Boolean):void
tickShowMinorLabelsproperty 
tickShowMinorLabels:Boolean

Whether or not to show values for minor tick labels Default: false


Implementation
    public function get tickShowMinorLabels():Boolean
    public function set tickShowMinorLabels(value:Boolean):void
tickStartValueproperty 
tickStartValue:Number

The numeric value to assicoate with the startAngle. In other words, the beginning of the dial scale.


Implementation
    public function get tickStartValue():Number
    public function set tickStartValue(value:Number):void
tickStepsproperty 
tickSteps:Array

For custom drawn ticks, where we provide the tick steps. Used by horizontal and vertical axes for charts


Implementation
    public function get tickSteps():Array
    public function set tickSteps(value:Array):void
titleproperty 
title:String  [read-only]

The text for the title displayed along the axis.


Implementation
    public function get title():String
Method Detail
invalidateTicks()method
public function invalidateTicks():void

Rebuilds the axis