mx.charts.chartClasses

# IAxisRenderer - AS3 Flex

Package | mx.charts.chartClasses
Interface | public interface IAxisRenderer extends IUIComponent , IFlexDisplayObject , IBitmapDrawable , 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.

Related API Elements

mx.charts.CategoryAxis
mx.charts.LinearAxis

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityProperties : AccessibilityProperties The current accessibility options for this display object. | IFlexDisplayObject
|  | alpha : Number Indicates the alpha transparency value of the object specified. | IFlexDisplayObject
|  | axis : IAxis The axis object associated with this renderer. | IAxisRenderer
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | IUIComponent
|  | blendMode : String A value from the BlendMode class that specifies which blend mode to use. | IFlexDisplayObject
|  | cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object. | IFlexDisplayObject
|  | document : Object A reference to the document object associated with this component. | IUIComponent
|  | enabled : Boolean Whether the component can accept user interaction. | IUIComponent
|  | explicitHeight : Number The explicitly specified height for the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMaxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMaxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMinHeight : Number [read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMinWidth : Number [read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitWidth : Number The explicitly specified width for the component, in pixels, as the component's coordinates. | IUIComponent
|  | filters : Array An indexed array that contains each filter object currently associated with the display object. | IFlexDisplayObject
|  | focusPane : 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
|  | height : Number Indicates the height of the display 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
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | IUIComponent
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | IUIComponent
|  | loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs. | IFlexDisplayObject
|  | mask : DisplayObject The calling display object is masked by the specified mask object. | IFlexDisplayObject
|  | maxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | maxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | measuredHeight : Number [read-only] The measured height of this object. | IFlexDisplayObject
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | IUIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | IUIComponent
|  | measuredWidth : Number [read-only] The measured width of this object. | IFlexDisplayObject
|  | minHeight : 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
|  | minWidth : Number [read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject
|  | mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject
|  | name : String Indicates the instance name of the DisplayObject. | IFlexDisplayObject
|  | opaqueBackground : Object Specifies whether the display object is opaque with a certain background color. | IFlexDisplayObject
|  | otherAxes : Array [write-only] An Array of axes. | IAxisRenderer
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | IUIComponent
|  | parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object. | IFlexDisplayObject
|  | percentHeight : Number Number that specifies the height of a component as a percentage of its parent's size. | IUIComponent
|  | percentWidth : 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
|  | root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. | IFlexDisplayObject
|  | rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | IFlexDisplayObject
|  | scale9Grid : Rectangle The current scaling grid that is in effect. | IFlexDisplayObject
|  | scaleX : Number Indicates the horizontal scale (percentage) of the object as applied from the registration point. | IFlexDisplayObject
|  | scaleY : Number Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | IFlexDisplayObject
|  | scrollRect : Rectangle The scroll rectangle bounds of the display object. | IFlexDisplayObject
|  | stage : Stage [read-only] The Stage of the display object. | IFlexDisplayObject
|  | systemManager : 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
|  | transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | IFlexDisplayObject
|  | tweeningProperties : Array Used by EffectManager. | IUIComponent
|  | visible : Boolean Whether or not the display object is visible. | IFlexDisplayObject
|  | width : Number Indicates the width of the display object, in pixels. | IFlexDisplayObject
|  | x : Number Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. | IFlexDisplayObject
|  | y : Number Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. | IFlexDisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | 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
|  | chartStateChanged(oldState:uint, v:uint):void Called by the enclosing chart to indicate that the current state of the chart has changed. | IAxisRenderer
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | IEventDispatcher
|  | getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. | IFlexDisplayObject
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | IUIComponent
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | IUIComponent
|  | getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes. | IFlexDisplayObject
|  | globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates. | IFlexDisplayObject
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | IEventDispatcher
|  | hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object. | IFlexDisplayObject
|  | hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters. | IFlexDisplayObject
|  | initialize():void Initialize the object. | IUIComponent
|  | localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates. | IFlexDisplayObject
|  | move(x:Number, y:Number):void Moves this object to the specified x and y coordinates. | IFlexDisplayObject
|  | owns(displayObject:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | IUIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | IUIComponent
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | IEventDispatcher
|  | setActualSize(newWidth:Number, newHeight:Number):void Sets the actual size of this object. | IFlexDisplayObject
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | IUIComponent
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher

Property Detail

### axis

property

`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`

### gutters

property

`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`

### heightLimit

property

`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`

### horizontal

property

`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`

### minorTicks

property

`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`

### otherAxes

property

`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`

### placement

property

`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`

### ticks

property

`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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00