(Adobe® Flex™ Charting components only)
Packagemx.charts.chartClasses
Interfacepublic interface IAxisRenderer extends IUIComponent, IFlexDisplayObject, IBitmapDrawable, IEventDispatcher
ImplementorsAxisRenderer

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
 Inheritedalpha : Number
The transparency of this object.
IFlexDisplayObject
  axis : IAxis
The axis object associated with this renderer.
IAxisRenderer
 InheritedbaselinePosition : Number
Determines the baseline y-coordinate of the first line of text of the component.
IUIComponent
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player caches an internal bitmap representation of the object.
IUIComponent
 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
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxWidth : Number
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinHeight : Number
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinWidth : Number
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
 InheritedfocusPane : Sprite
A single Sprite object that is shared among components and used as an overlay for drawing focus.
IUIComponent
  gutters : Rectangle
The distance between the axisRenderer and the sides of the surrounding chart.
IAxisRenderer
 Inheritedheight : Number
The height of this object, in pixels.
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
 Inheritedmask : DisplayObject
The DisplayObject used to mask this object so that only part of it is actually drawn.
IFlexDisplayObject
 InheritedmaxHeight : Number
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmaxWidth : Number
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmeasuredHeight : Number
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
The measured width of this object.
IFlexDisplayObject
 InheritedminHeight : Number
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
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
IUIComponent
 Inheritedname : String
The instance name of this object.
IFlexDisplayObject
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
IUIComponent
  otherAxes : Array
[write-only] An Array of axes.
IAxisRenderer
 Inheritedowner : DisplayObjectContainer
Your owner is usually your parent, however If you are a popup subcomponent, your owner will be the component that popped you up.
IUIComponent
 Inheritedparent : DisplayObjectContainer
The parent of this object.
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
 InheritedscaleX : Number
The horizontal scaling factor for this object.
IFlexDisplayObject
 InheritedscaleY : Number
The vertical scaling factor for this object.
IFlexDisplayObject
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the surface of the component.
IUIComponent
 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
 InheritedtweeningProperties : Array
Used by EffectManager.
IUIComponent
 Inheritedvisible : Boolean
A flag that indicates whether this object is visible.
IFlexDisplayObject
 Inheritedwidth : Number
The width of this object, in pixels.
IFlexDisplayObject
 Inheritedx : Number
The horizontal position of this object relative to its parent, in pixel coordinates.
IFlexDisplayObject
 Inheritedy : Number
The vertical position of this object relative to its parent, in pixel coordinates.
IFlexDisplayObject
Public Methods
 MethodDefined by
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
IEventDispatcher
  
adjustGutters(workingGutters:Rectangle, adjustable:Object):Rectangle
Adjusts its layout to accomodate the gutters passed in.
IAxisRenderer
  
Called by the enclosing chart to indicate that the current state of the chart has changed.
IAxisRenderer
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
 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
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
 Inherited
Initialize the object.
IUIComponent
 Inherited
Moves this object to the specified x and y coordinates.
IFlexDisplayObject
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
IUIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
IUIComponent
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
 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
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Property detail
axisproperty
axis:IAxis  [read-write]

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  [read-write]

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  [read-write]

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  [read-write]

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]

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]

An Array of axes.

Implementation
    public function set otherAxes(value:Array):void
placementproperty 
placement:String  [read-write]

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]

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

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 (i.e., larger) but not outward (smaller). The renderer should return the gutters plus any adjustments made.

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
chartStateChanged()method 
public function chartStateChanged(oldState:uint, v:uint):void

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.




 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/charts/chartClasses/IAxisRenderer.html