Packagemx.charts.chartClasses
Interfacepublic interface IAxisRenderer extends IUIComponent, IFlexDisplayObject, flash.display.IBitmapDrawable, flash.events.IEventDispatcher
Implementors AxisRenderer

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

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.

See also

mx.charts.CategoryAxis
mx.charts.LinearAxis


Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
IFlexDisplayObject
 Inheritedalpha : Number
IFlexDisplayObject
  axis : IAxis
The axis object associated with this renderer.
IAxisRenderer
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
IUIComponent
 InheritedblendMode : String
IFlexDisplayObject
 InheritedcacheAsBitmap : Boolean
IFlexDisplayObject
 Inheriteddocument : Object
A reference to the document object associated with this component.
IUIComponent
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
IUIComponent
 InheritedexplicitHeight : Number
The explicitly specified height for the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxHeight : Number
[read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinHeight : Number
[read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinWidth : Number
[read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitWidth : Number
The explicitly specified width for the component, in pixels, as the component's coordinates.
IUIComponent
 Inheritedfilters : Array
IFlexDisplayObject
 InheritedfocusPane : Sprite
A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator.
IUIComponent
  gutters : Rectangle
The distance between the axisRenderer and the sides of the surrounding chart.
IAxisRenderer
 Inheritedheight : Number
IFlexDisplayObject
  heightLimit : Number
The maximum amount of space, in pixels, that an axis renderer will take from a chart.
IAxisRenderer
  horizontal : Boolean
true if the axis renderer is being used as a horizontal axis.
IAxisRenderer
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
IUIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
IUIComponent
 InheritedloaderInfo : LoaderInfo
[read-only]
IFlexDisplayObject
 Inheritedmask : DisplayObject
IFlexDisplayObject
 InheritedmaxHeight : Number
[read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmeasuredHeight : Number
[read-only] The measured height of this object.
IFlexDisplayObject
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
IUIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
IUIComponent
 InheritedmeasuredWidth : Number
[read-only] The measured width of this object.
IFlexDisplayObject
 InheritedminHeight : Number
[read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
  minorTicks : Array
[read-only] Contains an array that specifies where Flex draws the minor tick marks along the axis.
IAxisRenderer
 InheritedminWidth : Number
[read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmouseX : Number
[read-only]
IFlexDisplayObject
 InheritedmouseY : Number
[read-only]
IFlexDisplayObject
 Inheritedname : String
IFlexDisplayObject
 InheritedopaqueBackground : Object
IFlexDisplayObject
  otherAxes : Array
[write-only] An Array of axes.
IAxisRenderer
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
IUIComponent
 Inheritedparent : DisplayObjectContainer
[read-only]
IFlexDisplayObject
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
IUIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
IUIComponent
  placement : String
The side of the chart the axisRenderer will appear on.
IAxisRenderer
 Inheritedroot : DisplayObject
[read-only]
IFlexDisplayObject
 Inheritedrotation : Number
IFlexDisplayObject
 Inheritedscale9Grid : Rectangle
IFlexDisplayObject
 InheritedscaleX : Number
IFlexDisplayObject
 InheritedscaleY : Number
IFlexDisplayObject
 InheritedscrollRect : Rectangle
IFlexDisplayObject
 Inheritedstage : Stage
[read-only]
IFlexDisplayObject
 InheritedsystemManager : ISystemManager
A reference to the SystemManager object for this component.
IUIComponent
  ticks : Array
[read-only] Contains an array that specifies where Flex draws the tick marks along the axis.
IAxisRenderer
 Inheritedtransform : Transform
IFlexDisplayObject
 InheritedtweeningProperties : Array
Used by EffectManager.
IUIComponent
 Inheritedvisible : Boolean
IFlexDisplayObject
 Inheritedwidth : Number
IFlexDisplayObject
 Inheritedx : Number
IFlexDisplayObject
 Inheritedy : Number
IFlexDisplayObject
Public Methods
 MethodDefined By
  
adjustGutters(workingGutters:Rectangle, adjustable:Object):Rectangle
Adjusts its layout to accomodate the gutters passed in.
IAxisRenderer
  
chartStateChanged(oldState:uint, v:uint):void
Called by the enclosing chart to indicate that the current state of the chart has changed.
IAxisRenderer
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
IFlexDisplayObject
 Inherited
A convenience method for determining whether to use the explicit or measured height
IUIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
IUIComponent
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
IFlexDisplayObject
 Inherited
globalToLocal(point:Point):Point
IFlexDisplayObject
 Inherited
hitTestObject(obj:DisplayObject):Boolean
IFlexDisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
IFlexDisplayObject
 Inherited
initialize():void
Initialize the object.
IUIComponent
 Inherited
localToGlobal(point:Point):Point
IFlexDisplayObject
 Inherited
move(x:Number, y:Number):void
Moves this object to the specified x and y coordinates.
IFlexDisplayObject
 Inherited
owns(displayObject:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
IUIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
IUIComponent
 Inherited
setActualSize(newWidth:Number, newHeight:Number):void
Sets the actual size of this object.
IFlexDisplayObject
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
IUIComponent
Property Detail
axisproperty
axis:IAxis

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The axis object associated with this renderer. This property is managed by the enclosing chart, and should not be explicitly set.


Implementation
    public function get axis():IAxis
    public function set axis(value:IAxis):void
guttersproperty 
gutters:Rectangle

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The distance between the axisRenderer and the sides of the surrounding chart. This property is assigned automatically by the chart, and should not be assigned directly.


Implementation
    public function get gutters():Rectangle
    public function set gutters(value:Rectangle):void
heightLimitproperty 
heightLimit:Number

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The maximum amount of space, in pixels, that an axis renderer will take from a chart. Axis Renderers by default will take up as much space in the chart as necessary to render all of their labels at full size. If heightLimit is set, an AxisRenderer will resort to reducing the labels in size in order to guarantee the total size of the axis is less than heightLimit.


Implementation
    public function get heightLimit():Number
    public function set heightLimit(value:Number):void
horizontalproperty 
horizontal:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

true if the axis renderer is being used as a horizontal axis. This property is managed by the enclosing CartesianChart, and should not be set directly.


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

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Contains an array that specifies where Flex draws the minor tick marks along the axis. Each array element contains a value between 0 and 1.


Implementation
    public function get minorTicks():Array
otherAxesproperty 
otherAxes:Array  [write-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

An Array of axes.


Implementation
    public function set otherAxes(value:Array):void
placementproperty 
placement:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The side of the chart the axisRenderer will appear on. Legal values are "left" and "right" for vertical axis renderers and "top" and "bottom" for horizontal axis renderers. By default, primary axes are placed on the left and top, and secondary axes are placed on the right and bottom. CartesianCharts automatically guarantee that secondary axes are placed opposite primary axes; if you explicitly place a primary vertical axis on the right, for example, the secondary vertical axis is swapped to the left.


Implementation
    public function get placement():String
    public function set placement(value:String):void
ticksproperty 
ticks:Array  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Contains an array that specifies where Flex draws the tick marks along the axis. Each array element contains a value between 0 and 1.


Implementation
    public function get ticks():Array
Method Detail
adjustGutters()method
public function adjustGutters(workingGutters:Rectangle, adjustable:Object):Rectangle

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Adjusts its layout to accomodate the gutters passed in. This method is called by the enclosing chart to determine the size of the gutters and the corresponding data area. This method provides the AxisRenderer with an opportunity to calculate layout based on the new gutters, and to adjust them if necessary. If a given gutter is adjustable, an axis renderer can optionally adjust the gutters inward (make the gutter larger) but not outward (make the gutter smaller).

Parameters

workingGutters:Rectangle — Defines the gutters to adjust.
 
adjustable:Object — Consists of four Boolean properties (left=true/false, top=true/false, right=true/false, and bottom=true/false) that indicate whether the axis renderer can optionally adjust each of the gutters further.

Returns
Rectangle — A rectangle that defines the dimensions of the gutters, including the adjustments.
chartStateChanged()method 
public function chartStateChanged(oldState:uint, v:uint):void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Called by the enclosing chart to indicate that the current state of the chart has changed. Implementing elements should respond to this method in order to synchronize changes to the data displayed by the element.

Parameters

oldState:uint — An integer representing the previous state.
 
v:uint — An integer representing the new state.