Packagexp.charting
Classpublic class Axis
InheritanceAxis Inheritance ChartStyleClient Inheritance ChartDisplayElement Inheritance ProgrammaticSkin Inheritance mx.core.FlexSprite
ImplementsIAxis
SubclassesCategoryAxis, DateTimeAxis, LinearAxis

You use the Axis class to describe the horizontal and vertical chartAxes of a chart. An axis is responsible for rendering the labels, tick marks, grid and title along its length.

Axis objects inherit some of their visual properties from the enclosing chart object. The text format of the labels and title defaults to the CSS text properties of the axis. You can control the formatting of the axis title separately by specifying a axisTitleStyleName, either on the Axis or on the enclosing chart.

When positioning and sizing labels, the Axis takes a minimum amount of the chart's available space. If labels take too much space, then the Axis hides, staggers, roatates or scales them. However, the Axis does not scale the labels to too small of a point size. To increase readability, the Axis chooses one of the following layout methods based on the one that requires the least scaling:

The Axis adjusts the boundaries of the chart's data area to ensure that it can draw the labels without pushing outside of the boundaries.

MXML Syntaxexpanded Hide MXML Syntax

The <xpc:Axis> tag inherits all the properties of its parent classes, and adds the following properties:

  <xpc:Axis
    Properties
    length="Number"
    placement="right|left|bottom|top"
     
    Styles
    axisStroke="No default"
    canHideLabels="true|false"
    canStagger="true|false"
    canScale="true|false"
    canRotate="true|false"
    labelGap="3"
    labelRotation="No default"
    minorTickLength="Default depends on axis"
    minorTickPlacement="none|inside|outside|cross"
    minorTickStroke="No default"
    showLabels="true|false"
    showLine="true|false"
    tickLength="Default depends on axis"
    tickPlacement="inside|outside|cross|none"
    tickStroke="No default"
  />

Default MXML Propertymarkers


Public Properties
 PropertyDefined by
  axisLabelFormat : String
The format sting to format values into axis labels
Axis
  axisLabelFunction : Function
The user custom function to format values into axis labels
Axis
  axisMode : int
Axis
  axisOffset : int = 0
Axis
  baseAtZero : Boolean
Used to set the minimum value of a numerical axis to zero even if the data minimum value does not start at zero.
Axis
  categoryField : String
The catgeory field
Axis
 Inheritedchart : IChartArea
ChartDisplayElement
 InheritedchartDesc : ChartDesc
ChartDisplayElement
 InheritedchartParent : IChart
ChartDisplayElement
 InheritedclassName : String
ChartStyleClient
  data : Array
The array of data for this axis
Axis
  dataLabelFormat : String
The format sting to format values into point labels
Axis
  dataLabelFunction : Function
The user custom function to format values into point labels
Axis
  dataProvider : Object
The source of the chart items.
Axis
  dataType : String = "String"
The type of data this axis represents Used to help in formatting the values for display
Axis
  displayName : String
The name or title to display in dataTips/dataLabels
Axis
 Inheritedheight : Number
ProgrammaticSkin
  index : int
Axis index
Axis
 InheritedinheritingStyles : Object
ChartStyleClient
 Inheritedinitialized : Boolean
ProgrammaticSkin
  interval : Number
Specifies the interval of major tick marks, labels and gridlines on the selected axis
Axis
  intervalCount : Number
num of labels displayed
Axis
  isHorizontal : Boolean
[read-only] Is the axis displayed horizontally If false the axis is being displayed vertically
Axis
 InheritedisSubChart : Boolean
ChartDisplayElement
  length : Number
[read-only] The length of the axis in pixels
Axis
  markers : Array
Axis
  maxDataValue : Number
[read-only] The max value of the data
Axis
  maxValue : Number
The max value of the axis
Axis
 InheritedmeasuredHeight : Number
The measured height of this object.
ChartDisplayElement
 InheritedmeasuredWidth : Number
The measured width of this object.
ChartDisplayElement
  minDataValue : Number
[read-only] The min value of the data
Axis
  minorIntervalCount : int = 1
Specifies the number of minor tick marks and minor gridlines (if they are displayed) on the selected axis between major ticks
Axis
  minValue : Number
The max value of the axis
Axis
 InheritednestLevel : int
ProgrammaticSkin
 InheritednonInheritingStyles : Object
ChartStyleClient
 Inheritedparent : DisplayObjectContainer
ChartDisplayElement
  parseFormat : String
The format sting to parse data into values
Axis
  parseFunction : Function
The user custom function to parse data into values
Axis
  placement : String
lacement of axis left/right/top/bottom
Axis
  prefix : String = ""
last label prefix
Axis
 InheritedprocessedDescriptors : Boolean
ProgrammaticSkin
  range : Number
[read-only] The axis range
Axis
 InheritedstyleDeclaration : CSSStyleDeclaration
ChartStyleClient
 InheritedstyleName : Object
ChartStyleClient
  suffix : String = ""
last label suffix
Axis
  ticks : Array
array of axis tick descriptors
Axis
  title : String
The name or title to display along the axis
Axis
  type : String
The axis type "x" or "y"
Axis
 InheritedupdateCompletePendingFlag : Boolean
ProgrammaticSkin
 Inheritedwidth : Number
ProgrammaticSkin
Protected Properties
 PropertyDefined by
  axisBackground : Shape
Axis
  axisChanged : Boolean = false
Axis
  _axisDataProvider : ICollectionView
Axis
  axisLabelFormatter : IDataFormatter
Axis
  axisLabels : Sprite
Axis
  _axisMode : int = 1
are labels displayed on the boundaries (NO_PAD_AXIS - 1) or within the boundaries (PAD_AXIS - 0)
Axis
  axisStyleChanged : Boolean = true
Axis
  axisStyles : Object
Axis
  axisValueType : String = "catgeory"
The type of axis values catgeory or value
Axis
  _baseAtZero : Boolean = true
Axis
  _canHideLabels : Boolean
Axis
  _canRotateLabels : Boolean
Axis
  _canScaleLabels : Boolean
Axis
  _canStaggerLabels : Boolean
Axis
  _categoryField : String
Axis
  changedStyles : Object
Axis
  _chartDataProvider : ICollectionView
Axis
 InheritedchildList : Array
ChartStyleClient
  _data : Array
Axis
  _dataLabelFormat : String
Axis
  dataLabelFormatter : IDataFormatter
Axis
  _dataLabelFunction : Function
Axis
  _dataProvider : ICollectionView
Axis
  dataProviderChanged : Boolean = false
Axis
 Inherited_deferLayout : Boolean = false
ProgrammaticSkin
  _explicitInterval : Number = NaN
Axis
  _explicitIntervalCount : Number
Axis
  _explicitMaxValue : Number = NaN
Axis
  _explicitMinValue : Number = NaN
Axis
  gridBackground : Shape
Axis
  gridForeground : Shape
Axis
  _interval : Number = 0
Axis
  _intervalCount : Number = 0
Axis
 InheritedinvalidateDisplayListFlag : Boolean = false
ProgrammaticSkin
 InheritedinvalidatePropertiesFlag : Boolean = false
ProgrammaticSkin
 InheritedinvalidateSizeFlag : Boolean = false
ProgrammaticSkin
  _labelFormat : String
Axis
  _labelFunction : Function
Axis
  _labelGap : int
Axis
  labelHSpace : int = 0
The amount of horizontal space to reserve for each label
Axis
  _labelRotation : int
Axis
  _labelScale : Number = 1
The scale of a label
Axis
  labelsChanged : Boolean = false
Axis
  labelStyleChanged : Boolean = true
Axis
  labelStyles : Object
Axis
  labelVSpace : int = 0
The amount of vertical space to reserve for each label
Axis
  _markers : Array
Axis
  _maxDataValue : Number = NaN
Axis
  _maxValue : Number = -Infinity
Axis
  _minDataValue : Number = NaN
Axis
  _minValue : Number = Infinity
Axis
  nullStroke : IStroke
[static]
Axis
 Inheritedowner : Object
ChartStyleClient
 Inherited_parent : DisplayObjectContainer
ChartDisplayElement
  _parseFormat : String
Axis
  parseFormatter : IDataFormatter
Axis
  _parseFunction : Function
Axis
  series : Array
The series object who have registered with this axis
Axis
  _showLabels : Boolean
Axis
 InheritedsizeChanged : Boolean = false
ProgrammaticSkin
 InheritedstyleParent : IStyleClient
ChartStyleClient
 InheritedstylesInitialized : Boolean = false
ChartStyleClient
 InheritedtextFieldList : Array
ChartStyleClient
Public Methods
 MethodDefined by
  
Axis()
Constructor create a new Axis instance
Axis
  
addSeries(series:IAxisSeries):void
Adds a series to this axis Called by a a series to register itself with the axis
Axis
 Inherited
clearStyle(styleProp:String):void
ChartStyleClient
  
decodeField(items:Array, inputField:String, outputField:String):void
Decode the value of a field in an array of items
Axis
  
decodeValue(value:*):Number
Decode a single value into a number
Axis
 Inherited
determineTextFormatFromStyles():UITextFormat
ChartStyleClient
  
formatAxisLabel(value:*):String
Axis
  
formatAxisValue(value:*):String
Format a value for display on the axis
Axis
  
formatDataLabel(value:*):String
Axis
  
formatDataValue(value:*):String
Format a value for display in a DataTip
Axis
 Inherited
getClassStyleDeclarations():Array
ChartStyleClient
  
getDataLabelFormatter():IDataFormatter
Axis
  
getOrigin():Number
Axis
  
getScreenPosition(value:Number):Number
Returns the screen position of a given data value or index
Axis
 Inherited
getStyle(styleProp:String):*
ChartStyleClient
 Inherited
initElement(chart:IChartArea):void
ChartDisplayElement
  
invalidateAxis():void
Axis
 Inherited
invalidateDisplayList():void
ProgrammaticSkin
 Inherited
invalidateProperties():void
ProgrammaticSkin
 Inherited
invalidateSize():void
ProgrammaticSkin
 Inherited
move(x:Number, y:Number):void
Moves this object to the specified x and y coordinates.
ProgrammaticSkin
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
ChartStyleClient
 Inherited
parentChanged(p:DisplayObjectContainer):void
ChartStyleClient
 Inherited
regenerateStyleCache(recursive:Boolean):void
ChartStyleClient
 Inherited
registerEffects(effects:Array):void
ChartStyleClient
  
resetRange():void
Prepares the selected axis for new data by resetting scale values
Axis
  
seriesDataChangedHandler(e:Event):void
Called by a Series to notify its underlying data has changed
Axis
 Inherited
setActualSize(newWidth:Number, newHeight:Number):void
Sets the height and width of this object.
ProgrammaticSkin
 Inherited
setStyle(styleProp:String, newValue:*):void
ChartStyleClient
  
styleChanged(styleProp:String):void
Axis
  
toScreen(items:Array, inputField:String, outputField:String, dimensionSize:int):void
Converts data value to screen coordinates
Axis
  
updateAxisData(cursor:IViewCursor):void
Load the data from the cursor
Axis
 Inherited
validateDisplayList():void
ChartDisplayElement
 Inherited
validateNow():void
Validate and update the properties and layout of this object and redraw it, if necessary.
ProgrammaticSkin
 Inherited
validateProperties():void
ProgrammaticSkin
 Inherited
validateSize(recursive:Boolean = false):void
ChartDisplayElement
Protected Methods
 MethodDefined by
 Inherited
activate():void
ChartDisplayElement
 Inherited
addedHandler(e:Event):void
ChartDisplayElement
  
adjustScale():void
Axis
  
calcInterval():void
Axis
  
calcRange():Boolean
Calculates the max,min,interval and interval count as required.
Axis
  
commitProperties():void
Axis
 Inherited
createChildren():void
ChartDisplayElement
 Inherited
deactivate():void
ChartDisplayElement
 Inherited
deferLayout(state:Boolean):void
ProgrammaticSkin
  
drawAxis(unscaledWidth:Number, unscaledHeight:Number):void
Draw the axis
Axis
  
getAxisLabelFormatter():IDataFormatter
Axis
  
getDataMax():Number
Axis
  
getDataMin():Number
Axis
  
getDataType(value:*):String
Returns the type of data represented by value
Axis
  
getFormatter(type:String):IDataFormatter
Axis
  
getIntervals():Array
Return and array of interval or tick points
Axis
 Inherited
getParent():DisplayObjectContainer
ChartDisplayElement
  
getParseFormatter():IDataFormatter
Axis
  
getSeriesMax():Number
Axis
  
getSeriesMin():Number
Axis
  
getStyleProperties():void
Axis
 Inherited
initHierarchy():void
ChartDisplayElement
  
initialize():void
Axis
 Inherited
initializeStyles():void
ChartStyleClient
 Inherited
initTextFields():void
ChartStyleClient
  
invalidateFormatters():void
Axis
  
invalidateLabels():void
Axis
  
invalidateRange():void
Axis
 Inherited
measure():void
ProgrammaticSkin
 Inherited
nestLevelChanged():void
ProgrammaticSkin
 Inherited
notifyTextFieldStyleChange(styleProp:String):void
ChartStyleClient
 Inherited
plotSizeChangedHandler(e:Event):void
ChartDisplayElement
 Inherited
removedHandler(e:Event):void
ChartDisplayElement
  
setAxisLabels(data:Array):void
Set the label string into the array of AxisItems
Axis
  
setAxisTicks(data:Array, majorInterval:int, stagger:int):void
Set the isTick and disposition properties into the array of AxisItems
Axis
  
setChartDataProvider(value:Object):void
Axis
  
setDataProvider(value:ICollectionView):void
Axis
  
setIntervals(length:Number):void
Create the axis labels
Axis
  
setIntervalSpacing(data:Array):void
Sets the position value into the array of AxisItems
Axis
  
setLabelFormats():void
Sets the label format strings Called before the AxisItems are generated to allow subclasses to adjust the format strings before they are used
Axis
  
setLabelSpace():void
Axis
  
updateAxisConfig():void
Axis
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draw the axis
Axis
  
updateStyleProperties():void
Axis
  
validateRange():Boolean
Ensures the axis min/max and interval are correct This is called during the commit stage It presumes that any dependent properties have been updated by this stage
Axis
Styles
 StyleDescriptionDefined by
  
axisStroke
Type: mx.graphics.IStroke   CSS Inheritance: no
Specifies the line style for the origin. Use the Stroke class to define the properties as a child tag in MXML, or create a Stroke object in ActionScript. 		Axis
  
axisTitleStyleName
Type: String   CSS Inheritance: yes
The name of the CSS class selector to use when formatting the axis title. 		Axis
  
backgroundAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. Valid values range from 0.0 to 1.0. The default value is 1.0.		Axis
  
backgroundColor
Type: uint   Format: Color   CSS Inheritance: no
Background color of a component. You can have both a backgroundColor and a backgroundImage set. Some components do not have a background. The DataGrid control ignores this style. The default value is undefined, which means it is not set. If both this style and the backgroundImage style are undefined, the component has a transparent background.

For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color.

The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows: 

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

Axis
  
backgroundDisabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Background color of the component when it is disabled. The global default value is undefined. The default value for List controls is 0xDDDDDD (light gray). If a container is disabled, the background is dimmed, and the degree of dimming is controlled by the disabledOverlayAlpha style. 		Axis
  
backgroundImage
Type: Object   Format: File   CSS Inheritance: no
Background image of a component. This can be an absolute or relative URL or class. You can either have both a backgroundColor and a backgroundImage set at the same time. The background image is displayed on top of the background color. The default value is undefined, meaning "not set". If this style and the backgroundColor style are undefined, the component has a transparent background.

The default skins of most Flex controls are partially transparent. As a result, the background image of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows: 

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

Axis
  
backgroundSize
Type: String   CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes. A value of "100%" stretches the image to fit the entire component. To specify a percentage value, you must include the percent sign (%). The default value is "auto", which maintains the original size of the image. 		Axis
  
borderAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the borderColor property. Valid values range from 0.0 to 1.0. The default value is 1.0.		Axis
  
borderColor
Type: uint   Format: Color   CSS Inheritance: no
Color of the border. The default value depends on the component class; if not overridden for the class, the default value is 0xB7BABC. 		Axis
  
borderSides
Type: String   CSS Inheritance: no
Bounding box sides. A space-delimited String that specifies the sides of the border to show. The String can contain "left", "top", "right", and "bottom" in any order. The default value is "left top right bottom", which shows all four sides. This style is only used when borderStyle is "solid". 		Axis
  
borderSkin
Type: Class   CSS Inheritance: no
The border skin of the component. The default value is mx.skins.halo.HaloBorder.		Axis
  
borderStyle
Type: String   CSS Inheritance: no
Bounding box style. The possible values are "none", "solid", "inset", and "outset". The default value depends on the component class; if not overridden for the class, the default value is "inset". The default value for most Containers is "none". 		Axis
  
borderThickness
Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness. Only used when borderStyle is set to "solid". The default value is 1.		Axis
  
canHideLabels
Type: Boolean   CSS Inheritance: no
Specifies whether to hide labels as necessary to lay out correctly. Use this setting to minimize the space required for the labels. The default value is true, which hides the labels.

Set to true to cause the AxisRenderer to hide overlapping labels when rendering.

Axis
  
canRotateLabels
Type: Boolean   CSS Inheritance: no
Specifies whether to scale labels as necessary to lay out correctly. Use this setting to minimize the space required for the labels. The default value is false, which scales the labels.

Set to true to cause the AxisRenderer to roatet overlapping labels when rendering.

Axis
  
canScaleLabels
Type: Boolean   CSS Inheritance: no
Specifies whether to scale labels as necessary to lay out correctly. Use this setting to minimize the space required for the labels. The default value is false, which scales the labels.

Set to true to cause the AxisRenderer to scale overlapping labels when rendering.

Axis
  
canStaggerLabels
Type: Boolean   CSS Inheritance: no
Specifies whether to stagger labels on two label rows as necessary to lay out correctly. Use this setting to minimize the space required for the labels. The default value is true, which staggers the labels.

Set to true to cause the AxisRenderer to stagger overlapping labels when rendering.

Axis
  
cornerRadius
Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners. The default value depends on the component class; if not overriden for the class, the default value is 0. The default value for ApplicationControlBar is 5. 		Axis
  
dropShadowColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow. The default value is 0x000000.		Axis
  
dropShadowEnabled
Type: Boolean   CSS Inheritance: no
Boolean property that specifies whether the component has a visible drop shadow. This style is used with borderStyle="solid". The default value is false.

Note: For drop shadows to appear on containers, set backgroundColor or backgroundImage properties. Otherwise, the shadow appears behind the container because the default background of a container is transparent.

Axis
  
gridAlternateFill
Type: mx.graphics.IFill   CSS Inheritance: no
Specifies the fill pattern for alternating bands not defined by the fill property. Use the IFill class to define the properties of the fill as a child tag in MXML, or create an IFill object in ActionScript. Set to null to not fill the bands. The default value is null. 		Axis
  
gridBandsDirection
Type: String   CSS Inheritance: no
Specifies the direction of the grid background. Allowable values are horizontal, vertical. The default value is horizontal. 		Axis
  
gridChangeCount
Type: int   CSS Inheritance: no
Specifies the number of tick marks between grid lines. Set the ChangeCount property to 3 to draw a grid line at every third tick mark along the axis. The fill style alternates at each grid line, so a larger horizontalChangeCount value results in large alternating bands. The defaults value is 1. 		Axis
  
gridFill
Type: mx.graphics.IFill   CSS Inheritance: no
Specifies the fill pattern for every other horizontal band created by the grid lines. Use the IFill class to define the properties of the fill as a child tag in MXML, or create a IFill object in ActionScript. Set to null to not fill the bands. The default value is null. 		Axis
  
gridStroke
Type: mx.graphics.IStroke   CSS Inheritance: no
Specifies the line style for grid lines. Use the Stroke class to define the properties as a child tag in MXML, or create a Stroke object in ActionScript. 		Axis
  
labelRotation
Type: Number   CSS Inheritance: no
Specifies the label rotation. If the labels are rendered with device fonts, the labels are always drawn horizontally, you must use embed fonts to rotate labels. If the style canRotateLabels is true, the Axis determines an optimal angle to render the labels in the smallest area without overlapping. This style lets you explicilty set the rotation 		Axis
  
minorTickLength
Type: Number   Format: Length   CSS Inheritance: no
Specifies the length of the minor tick marks on the axis, in pixels. The default value is 0.		Axis
  
minorTickPlacement
Type: String   CSS Inheritance: no
Specifies where to draw the minor tick marks. Options are:
  • "inside" - Draw minor tick marks inside the data area.
  • "outside" - Draw minor tick marks in the label area.
  • "cross" - Draw minor tick marks across the axis.
  • "none" - Draw no minor tick marks.
Axis
  
minorTickStroke
Type: mx.graphics.IStroke   CSS Inheritance: no
Specifies the characteristics of the minor tick marks on the axis. This style must be an instance of the Stroke class. 		Axis
  
originStroke
Type: mx.graphics.IStroke   CSS Inheritance: no
Specifies the line style for the origin. Use the Stroke class to define the properties as a child tag in MXML, or create a Stroke object in ActionScript. 		Axis
  
paddingBottom
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's right border and the right edge of its content area.

The default value is 0.

Axis
  
paddingLeft
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's left border and the left edge of its content area.

The default value is 0.

Axis
  
paddingRight
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's right border and the right edge of its content area.

The default value is 0.

Axis
  
paddingTop
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's left border and the left edge of its content area.

The default value is 0.

Axis
  
shadowDirection
Type: String   CSS Inheritance: no
Direction of the drop shadow. Possible values are "left", "center", and "right". The default value is "center".		Axis
  
shadowDistance
Type: Number   Format: Length   CSS Inheritance: no
Distance of the drop shadow. If the property is set to a negative value, the shadow appears above the component. The default value is 2.		Axis
  
showGridBands
Type: Boolean   CSS Inheritance: no
Specifies whether to display the axis grid background. The default value is true.		Axis
  
showGridLines
Type: Boolean   CSS Inheritance: no
Specifies whether to display the axis grid lines. The default value is true.		Axis
  
showLabels
Type: Boolean   CSS Inheritance: no
Specifies whether labels should appear along the axis. The default value is true.		Axis
  
showLine
Type: Boolean   CSS Inheritance: no
Specifies whether to display the axis. The default value is true.		Axis
  
showOrigin
Type: Boolean   CSS Inheritance: no
Determines whether to draw the origin. If true, and the origin falls within the chart bounds, the grid lines draw it using the originStroke style. For ColumnChart, LineChart, PlotChart, BubbleChart, and AreaChart controls, the default value is true. For BarChart controls, the default value is false. This property does not apply to PolarChart controls. 		Axis
  
tickLength
Type: Number   Format: Length   CSS Inheritance: no
Specifies the length of the tick marks on the axis, in pixels. The default value is 3.		Axis
  
tickPlacement
Type: String   CSS Inheritance: no
Specifies where to draw the tick marks. Options are:
  • "inside" - Draw tick marks inside the data area.
  • "outside" - Draw tick marks in the label area.
  • "cross" - Draw tick marks across the axis.
  • "none" - Draw no tick marks.
Axis
  
tickStroke
Type: mx.graphics.IStroke   CSS Inheritance: no
Specifies the characteristics of the tick marks on the axis. This style must be an instance of the Stroke class. 		Axis
Public Constants
 ConstantDefined by
  AXIS_PLACEMENT_BOTTOM : String = "bottom"
[static] The constant for the type of tick - inside the axis
Axis
  AXIS_PLACEMENT_LEFT : String = "left"
[static] The constant for the type of tick - cross the axis
Axis
  AXIS_PLACEMENT_RIGHT : String = "right"
[static] The constant for the type of tick - no tick mark
Axis
  AXIS_PLACEMENT_TOP : String = "top"
[static] The constant for the type of tick - outside the axis
Axis
  AXIS_VALUE_TYPE_CATEGORY : String = "catgeory"
[static] Constant for the axisValueType property for an axis which represents values as categories
Axis
  AXIS_VALUE_TYPE_VALUE : String = "value"
[static] Constant for the axisValueType property for an axis which represents values as values
Axis
  AXISX : String = "x"
[static] Constant for the axis type property for a x axis
Axis
  AXISY : String = "y"
[static] Constant for the axis type property for a y axis
Axis
  NO_PAD_AXIS : int = 1
[static] Constant for the axis mode property Usually catgeories and values start at the beginning of the axis and end at the end of the axis.
Axis
  PAD_AXIS : int = 0
[static] Constant for the axis mode property.
Axis
  TICK_PLACEMENT_CROSS : String = "cross"
[static] The constant for the type of tick - cross the axis
Axis
  TICK_PLACEMENT_INSIDE : String = "inside"
[static] The constant for the type of tick - inside the axis
Axis
  TICK_PLACEMENT_NONE : String = "none"
[static] The constant for the type of tick - no tick mark
Axis
  TICK_PLACEMENT_OUTSIDE : String = "outside"
[static] The constant for the type of tick - outside the axis
Axis
Protected Constants
 ConstantDefined by
 InheritedNESTLEVEL_AXIS : int = 10000
[static]
ChartDisplayElement
 InheritedNESTLEVEL_AXISSET : int = 10001
[static]
ChartDisplayElement
 InheritedNESTLEVEL_LABELS : int = 10002
[static]
ChartDisplayElement
 InheritedNESTLEVEL_SERIES : int = 1000
[static]
ChartDisplayElement
 InheritedNESTLEVEL_SERIESSET : int = 1001
[static]
ChartDisplayElement
Property detail
axisBackgroundproperty
protected var axisBackground:Shape
axisChangedproperty 
protected var axisChanged:Boolean = false
_axisDataProviderproperty 
protected var _axisDataProvider:ICollectionView
axisLabelFormatproperty 
axisLabelFormat:String  [read-write]

The format sting to format values into axis labels

Implementation
    public function get axisLabelFormat():String
    public function set axisLabelFormat(value:String):void
axisLabelFormatterproperty 
protected var axisLabelFormatter:IDataFormatter
axisLabelFunctionproperty 
axisLabelFunction:Function  [read-write]

The user custom function to format values into axis labels

Implementation
    public function get axisLabelFunction():Function
    public function set axisLabelFunction(value:Function):void
axisLabelsproperty 
protected var axisLabels:Sprite
_axisModeproperty 
protected var _axisMode:int = 1

are labels displayed on the boundaries (NO_PAD_AXIS - 1) or within the boundaries (PAD_AXIS - 0)

axisModeproperty 
axisMode:int  [read-write]Implementation
    public function get axisMode():int
    public function set axisMode(value:int):void
axisOffsetproperty 
public var axisOffset:int = 0
axisStyleChangedproperty 
protected var axisStyleChanged:Boolean = true
axisStylesproperty 
protected var axisStyles:Object
axisValueTypeproperty 
protected var axisValueType:String = "catgeory"

The type of axis values catgeory or value

_baseAtZeroproperty 
protected var _baseAtZero:Boolean = true
baseAtZeroproperty 
baseAtZero:Boolean  [read-write]

Used to set the minimum value of a numerical axis to zero even if the data minimum value does not start at zero.

Implementation
    public function get baseAtZero():Boolean
    public function set baseAtZero(value:Boolean):void
_canHideLabelsproperty 
protected var _canHideLabels:Boolean
_canRotateLabelsproperty 
protected var _canRotateLabels:Boolean
_canScaleLabelsproperty 
protected var _canScaleLabels:Boolean
_canStaggerLabelsproperty 
protected var _canStaggerLabels:Boolean
_categoryFieldproperty 
protected var _categoryField:String
categoryFieldproperty 
categoryField:String  [read-write]

The catgeory field

Implementation
    public function get categoryField():String
    public function set categoryField(value:String):void
changedStylesproperty 
protected var changedStyles:Object
_chartDataProviderproperty 
protected var _chartDataProvider:ICollectionView
_dataproperty 
protected var _data:Array
dataproperty 
data:Array  [read-write]

The array of data for this axis

Implementation
    public function get data():Array
    public function set data(value:Array):void
_dataLabelFormatproperty 
protected var _dataLabelFormat:String
dataLabelFormatproperty 
dataLabelFormat:String  [read-write]

The format sting to format values into point labels

Implementation
    public function get dataLabelFormat():String
    public function set dataLabelFormat(value:String):void
dataLabelFormatterproperty 
protected var dataLabelFormatter:IDataFormatter
_dataLabelFunctionproperty 
protected var _dataLabelFunction:Function
dataLabelFunctionproperty 
dataLabelFunction:Function  [read-write]

The user custom function to format values into point labels

Implementation
    public function get dataLabelFunction():Function
    public function set dataLabelFunction(value:Function):void
_dataProviderproperty 
protected var _dataProvider:ICollectionView
dataProviderproperty 
dataProvider:Object  [read-write]

The source of the chart items. The data model for items viewed in a chart. The value of this property can be an array or any object that implements the DataProvider API.

Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void
dataProviderChangedproperty 
protected var dataProviderChanged:Boolean = false
dataTypeproperty 
public var dataType:String = "String"

The type of data this axis represents Used to help in formatting the values for display

displayNameproperty 
public var displayName:String

The name or title to display in dataTips/dataLabels

_explicitIntervalproperty 
protected var _explicitInterval:Number = NaN
_explicitIntervalCountproperty 
protected var _explicitIntervalCount:Number
_explicitMaxValueproperty 
protected var _explicitMaxValue:Number = NaN
_explicitMinValueproperty 
protected var _explicitMinValue:Number = NaN
gridBackgroundproperty 
protected var gridBackground:Shape
gridForegroundproperty 
protected var gridForeground:Shape
indexproperty 
index:int  [read-write]

Axis index

Implementation
    public function get index():int
    public function set index(value:int):void
_intervalproperty 
protected var _interval:Number = 0
intervalproperty 
interval:Number  [read-write]

Specifies the interval of major tick marks, labels and gridlines on the selected axis

Implementation
    public function get interval():Number
    public function set interval(value:Number):void
_intervalCountproperty 
protected var _intervalCount:Number = 0
intervalCountproperty 
intervalCount:Number  [read-write]

num of labels displayed

Implementation
    public function get intervalCount():Number
    public function set intervalCount(value:Number):void
isHorizontalproperty 
isHorizontal:Boolean  [read-only]

Is the axis displayed horizontally If false the axis is being displayed vertically

Implementation
    public function get isHorizontal():Boolean
_labelFormatproperty 
protected var _labelFormat:String
_labelFunctionproperty 
protected var _labelFunction:Function
_labelGapproperty 
protected var _labelGap:int
labelHSpaceproperty 
protected var labelHSpace:int = 0

The amount of horizontal space to reserve for each label

_labelRotationproperty 
protected var _labelRotation:int
_labelScaleproperty 
protected var _labelScale:Number = 1

The scale of a label

labelsChangedproperty 
protected var labelsChanged:Boolean = false
labelStyleChangedproperty 
protected var labelStyleChanged:Boolean = true
labelStylesproperty 
protected var labelStyles:Object
labelVSpaceproperty 
protected var labelVSpace:int = 0

The amount of vertical space to reserve for each label

lengthproperty 
length:Number  [read-only]

The length of the axis in pixels

Implementation
    public function get length():Number
_markersproperty 
protected var _markers:Array
markersproperty 
markers:Array  [read-write]Implementation
    public function get markers():Array
    public function set markers(value:Array):void
_maxDataValueproperty 
protected var _maxDataValue:Number = NaN
maxDataValueproperty 
maxDataValue:Number  [read-only]

The max value of the data

Implementation
    public function get maxDataValue():Number
_maxValueproperty 
protected var _maxValue:Number = -Infinity
maxValueproperty 
maxValue:Number  [read-write]

The max value of the axis

Implementation
    public function get maxValue():Number
    public function set maxValue(value:Number):void
_minDataValueproperty 
protected var _minDataValue:Number = NaN
minDataValueproperty 
minDataValue:Number  [read-only]

The min value of the data

Implementation
    public function get minDataValue():Number
minorIntervalCountproperty 
public var minorIntervalCount:int = 1

Specifies the number of minor tick marks and minor gridlines (if they are displayed) on the selected axis between major ticks

_minValueproperty 
protected var _minValue:Number = Infinity
minValueproperty 
minValue:Number  [read-write]

The max value of the axis

Implementation
    public function get minValue():Number
    public function set minValue(value:Number):void
nullStrokeproperty 
protected static var nullStroke:IStroke
_parseFormatproperty 
protected var _parseFormat:String
parseFormatproperty 
parseFormat:String  [read-write]

The format sting to parse data into values

Implementation
    public function get parseFormat():String
    public function set parseFormat(value:String):void
parseFormatterproperty 
protected var parseFormatter:IDataFormatter
_parseFunctionproperty 
protected var _parseFunction:Function
parseFunctionproperty 
parseFunction:Function  [read-write]

The user custom function to parse data into values

Implementation
    public function get parseFunction():Function
    public function set parseFunction(value:Function):void
placementproperty 
placement:String  [read-write]

lacement of axis left/right/top/bottom

Implementation
    public function get placement():String
    public function set placement(value:String):void
prefixproperty 
public var prefix:String = ""

last label prefix

rangeproperty 
range:Number  [read-only]

The axis range

Implementation
    public function get range():Number
seriesproperty 
protected var series:Array

The series object who have registered with this axis

_showLabelsproperty 
protected var _showLabels:Boolean
suffixproperty 
public var suffix:String = ""

last label suffix

ticksproperty 
public var ticks:Array

array of axis tick descriptors

titleproperty 
public var title:String

The name or title to display along the axis

typeproperty 
public var type:String

The axis type "x" or "y"

Constructor detail
Axis()constructor
public function Axis()

Constructor create a new Axis instance

Method detail
addSeries()method
public function addSeries(series:IAxisSeries):void

Adds a series to this axis Called by a a series to register itself with the axis

Parameters
series:IAxisSeries
adjustScale()method 
protected function adjustScale():void
calcInterval()method 
protected function calcInterval():void
calcRange()method 
protected function calcRange():Boolean

Calculates the max,min,interval and interval count as required.

Returns
Boolean — true if the range has changed otherwise false
commitProperties()method 
protected override function commitProperties():void
decodeField()method 
public function decodeField(items:Array, inputField:String, outputField:String):void

Decode the value of a field in an array of items

Parameters
items:Array
 
inputField:String
 
outputField:String
decodeValue()method 
public function decodeValue(value:*):Number

Decode a single value into a number

Parameters
value:*

Returns
Number
drawAxis()method 
protected function drawAxis(unscaledWidth:Number, unscaledHeight:Number):void

Draw the axis

Parameters
unscaledWidth:Number
 
unscaledHeight:Number
formatAxisLabel()method 
public function formatAxisLabel(value:*):StringParameters
value:*

Returns
String
formatAxisValue()method 
public function formatAxisValue(value:*):String

Format a value for display on the axis

Parameters
value:*

Returns
String
formatDataLabel()method 
public function formatDataLabel(value:*):StringParameters
value:*

Returns
String
formatDataValue()method 
public function formatDataValue(value:*):String

Format a value for display in a DataTip

Parameters
value:*

Returns
String
getAxisLabelFormatter()method 
protected function getAxisLabelFormatter():IDataFormatter

Returns
IDataFormatter
getDataLabelFormatter()method 
public function getDataLabelFormatter():IDataFormatter

Returns
IDataFormatter
getDataMax()method 
protected function getDataMax():Number

Returns
Number
getDataMin()method 
protected function getDataMin():Number

Returns
Number
getDataType()method 
protected function getDataType(value:*):String

Returns the type of data represented by value

Parameters
value:*

Returns
String — one of Date, Number, String, XML or Object
getFormatter()method 
protected function getFormatter(type:String):IDataFormatterParameters
type:String

Returns
IDataFormatter
getIntervals()method 
protected function getIntervals():Array

Return and array of interval or tick points

Returns
Array
getOrigin()method 
public function getOrigin():Number

Returns
Number
getParseFormatter()method 
protected function getParseFormatter():IDataFormatter

Returns
IDataFormatter
getScreenPosition()method 
public function getScreenPosition(value:Number):Number

Returns the screen position of a given data value or index

Parameters
value:Number — The value (for a value axis) or index (for a catgeory axis)

Returns
Number — The screen position in pixels for this axis
getSeriesMax()method 
protected function getSeriesMax():Number

Returns
Number
getSeriesMin()method 
protected function getSeriesMin():Number

Returns
Number
getStyleProperties()method 
protected function getStyleProperties():void
initialize()method 
protected override function initialize():void
invalidateAxis()method 
public function invalidateAxis():void
invalidateFormatters()method 
protected function invalidateFormatters():void
invalidateLabels()method 
protected function invalidateLabels():void
invalidateRange()method 
protected function invalidateRange():void
resetRange()method 
public function resetRange():void

Prepares the selected axis for new data by resetting scale values

seriesDataChangedHandler()method 
public function seriesDataChangedHandler(e:Event):void

Called by a Series to notify its underlying data has changed

Parameters
e:Event
setAxisLabels()method 
protected function setAxisLabels(data:Array):void

Set the label string into the array of AxisItems

Parameters
data:Array — The array of AxisItems
setAxisTicks()method 
protected function setAxisTicks(data:Array, majorInterval:int, stagger:int):void

Set the isTick and disposition properties into the array of AxisItems

Parameters
data:Array — The array of AxisItems
 
majorInterval:int
 
stagger:int
setChartDataProvider()method 
protected function setChartDataProvider(value:Object):voidParameters
value:Object
setDataProvider()method 
protected function setDataProvider(value:ICollectionView):voidParameters
value:ICollectionView
setIntervals()method 
protected function setIntervals(length:Number):void

Create the axis labels

Parameters
length:Number
setIntervalSpacing()method 
protected function setIntervalSpacing(data:Array):void

Sets the position value into the array of AxisItems

Parameters
data:Array — The array of AxisItems
setLabelFormats()method 
protected function setLabelFormats():void

Sets the label format strings Called before the AxisItems are generated to allow subclasses to adjust the format strings before they are used

setLabelSpace()method 
protected function setLabelSpace():void
styleChanged()method 
public override function styleChanged(styleProp:String):voidParameters
styleProp:String
toScreen()method 
public function toScreen(items:Array, inputField:String, outputField:String, dimensionSize:int):void

Converts data value to screen coordinates

Parameters
items:Array
 
inputField:String
 
outputField:String
 
dimensionSize:int
updateAxisConfig()method 
protected function updateAxisConfig():void
updateAxisData()method 
public function updateAxisData(cursor:IViewCursor):void

Load the data from the cursor

Parameters
cursor:IViewCursor
updateDisplayList()method 
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Draw the axis

Parameters
unscaledWidth:Number
 
unscaledHeight:Number
updateStyleProperties()method 
protected function updateStyleProperties():void
validateRange()method 
protected function validateRange():Boolean

Ensures the axis min/max and interval are correct This is called during the commit stage It presumes that any dependent properties have been updated by this stage

Returns
Boolean
Constant detail
AXIS_PLACEMENT_BOTTOMconstant
public static const AXIS_PLACEMENT_BOTTOM:String = "bottom"

The constant for the type of tick - inside the axis

AXIS_PLACEMENT_LEFTconstant 
public static const AXIS_PLACEMENT_LEFT:String = "left"

The constant for the type of tick - cross the axis

AXIS_PLACEMENT_RIGHTconstant 
public static const AXIS_PLACEMENT_RIGHT:String = "right"

The constant for the type of tick - no tick mark

AXIS_PLACEMENT_TOPconstant 
public static const AXIS_PLACEMENT_TOP:String = "top"

The constant for the type of tick - outside the axis

AXIS_VALUE_TYPE_CATEGORYconstant 
public static const AXIS_VALUE_TYPE_CATEGORY:String = "catgeory"

Constant for the axisValueType property for an axis which represents values as categories

AXIS_VALUE_TYPE_VALUEconstant 
public static const AXIS_VALUE_TYPE_VALUE:String = "value"

Constant for the axisValueType property for an axis which represents values as values

AXISXconstant 
public static const AXISX:String = "x"

Constant for the axis type property for a x axis

AXISYconstant 
public static const AXISY:String = "y"

Constant for the axis type property for a y axis

NO_PAD_AXISconstant 
public static const NO_PAD_AXIS:int = 1

Constant for the axis mode property Usually catgeories and values start at the beginning of the axis and end at the end of the axis. However certain types which would render outisde the chart bounds need to be padded, like bars for example.

PAD_AXISconstant 
public static const PAD_AXIS:int = 0

Constant for the axis mode property. Usually catgeories and values start at the beginning of the axis and end at the end of the axis. However certain types which would render outisde the chart bounds need to be padded, like bars for example.

TICK_PLACEMENT_CROSSconstant 
public static const TICK_PLACEMENT_CROSS:String = "cross"

The constant for the type of tick - cross the axis

TICK_PLACEMENT_INSIDEconstant 
public static const TICK_PLACEMENT_INSIDE:String = "inside"

The constant for the type of tick - inside the axis

TICK_PLACEMENT_NONEconstant 
public static const TICK_PLACEMENT_NONE:String = "none"

The constant for the type of tick - no tick mark

TICK_PLACEMENT_OUTSIDEconstant 
public static const TICK_PLACEMENT_OUTSIDE:String = "outside"

The constant for the type of tick - outside the axis