Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.charts.chartClasses 
IChartElement 
Packagemx.charts.chartClasses
Interfacepublic interface IChartElement extends IFlexDisplayObject , IBitmapDrawable , IEventDispatcher

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

IChartElement defines the base set of properties and methods required by a UIComponent to be representable in the data space of a chart. Any component assigned to the series, backgroundElements, or annotationElements Arrays of a chart must implement this interface.



Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
IFlexDisplayObject
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
IFlexDisplayObject
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
IFlexDisplayObject
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
IFlexDisplayObject
  chartDataProvider : Object
[write-only] The data provider assigned to the enclosing chart.
IChartElement
  dataTransform : mx.charts.chartClasses:DataTransform
[write-only] The DataTransform object that the element uses to map between data and screen coordinates.
IChartElement
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
IFlexDisplayObject
 Inheritedheight : Number
Indicates the height of the display object, in pixels.
IFlexDisplayObject
  labelContainer : Sprite
[read-only] The DisplayObject that displays labels rendered by this element.
IChartElement
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
IFlexDisplayObject
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
IFlexDisplayObject
 InheritedmeasuredHeight : Number
[read-only] The measured height of this object.
IFlexDisplayObject
 InheritedmeasuredWidth : Number
[read-only] The measured width of this object.
IFlexDisplayObject
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
IFlexDisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
IFlexDisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
IFlexDisplayObject
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
IFlexDisplayObject
 Inheritedparent : DisplayObjectContainer
[read-only] Indicates the DisplayObjectContainer object that contains this display object.
IFlexDisplayObject
 Inheritedroot : 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
 Inheritedrotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
IFlexDisplayObject
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
IFlexDisplayObject
 InheritedscaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point.
IFlexDisplayObject
 InheritedscaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
IFlexDisplayObject
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
IFlexDisplayObject
 Inheritedstage : Stage
[read-only] The Stage of the display object.
IFlexDisplayObject
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
IFlexDisplayObject
 Inheritedvisible : Boolean
Whether or not the display object is visible.
IFlexDisplayObject
 Inheritedwidth : Number
Indicates the width of the display object, in pixels.
IFlexDisplayObject
 Inheritedx : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
IFlexDisplayObject
 Inheritedy : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
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
  
Called by the enclosing chart to indicate that the current state of the chart has changed.
IChartElement
  
claimStyles(styles:Array, firstAvailable:uint):uint
Called by the chart to allow associated elements to claim style selectors from its chartSeriesStyles Array.
IChartElement
  
collectTransitions(chartState:Number, transitions:Array):void
Called by the enclosing chart to collect any transitions a particular element might play when the chart changes state.
IChartElement
  
describeData(dimension:String, requiredFields:uint):Array
Called by the governing DataTransform to obtain a description of the data represented by this IChartElement.
IChartElement
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
  
Returns a HitData object describing the nearest data point to the coordinates passed to the method.
IChartElement
 Inherited
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
 Inherited
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
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
IFlexDisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
 Inherited
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
 Inherited
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
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
IFlexDisplayObject
  
Indicates to the element that the data mapping of the associated axes has changed.
IChartElement
 Inherited
Moves this object to the specified x and y coordinates.
IFlexDisplayObject
 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
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Property Detail

chartDataProvider

property
chartDataProvider:Object  [write-only]

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

The data provider assigned to the enclosing chart. Element types can choose to inherit the data provider from the enclosing chart if necessary, or allow developers to assign data providers specifically to the element. Not all elements are necessarily driven by a data provider.



Implementation
    public function set chartDataProvider(value:Object):void

dataTransform

property 
dataTransform:mx.charts.chartClasses:DataTransform  [write-only]

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

The DataTransform object that the element uses to map between data and screen coordinates. This property is assigned by the enclosing chart.



Implementation
    public function set dataTransform(value:mx.charts.chartClasses:DataTransform):void

labelContainer

property 
labelContainer:Sprite  [read-only]

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

The DisplayObject that displays labels rendered by this element. In most cases, labels displayed in the data area of a chart are rendered on top of all elements rather than interleaved with the data. If an implementing Element has labels to display, it can place them in a Sprite object and return it as the value of the labelContainer property. Enclosing charts will render labelContainers from all enclosed elements and place them in the data area above all other elements.



Implementation
    public function get labelContainer():Sprite
Method Detail

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.

claimStyles

()method 
public function claimStyles(styles:Array, firstAvailable:uint):uint

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

Called by the chart to allow associated elements to claim style selectors from its chartSeriesStyles Array. Each chart has an associated set of selectors that are implicitly assigned to contained elements that require them. Implementing this function gives an element a chance to 'claim' elements out of that set, as necessary. An element that requires N style selectors claims the values from styles[firstAvailable] to styles[firstAvailable + N - 1].

Parameters

styles:Array — An Array of styles to claim.
 
firstAvailable:uint — The first style selector in the Array to claim.

Returns
uint — The new value for firstAvailable after claiming any styles (for example, firstAvailable + N).

collectTransitions

()method 
public function collectTransitions(chartState:Number, transitions:Array):void

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

Called by the enclosing chart to collect any transitions a particular element might play when the chart changes state. The chart collects transitions from all elements and ensures that they play in parallel. It waits until all transitions have completed before advancing to another state. Implementors should append any necessary transitions to the transitions Array parameter.

Parameters

chartState:Number — The state at which the chart plays the new transitions.
 
transitions:Array — An Array of transition to add to the chart's list of transitions to play.

describeData

()method 
public function describeData(dimension:String, requiredFields:uint):Array

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

Called by the governing DataTransform to obtain a description of the data represented by this IChartElement. Implementors fill out and return an Array of mx.charts.chartClasses.DataDescription objects to guarantee that their data is correctly accounted for by any axes that are autogenerating values from the displayed data (such as minimum, maximum, interval, and unitSize). Most element types return an Array containing a single DataDescription. Aggregate elements, such as BarSet and ColumnSet, might return multiple DataDescription instances that describe the data displayed by their subelements. When called, the implementor describes the data along the axis indicated by the dimension argument. This function might be called for each axis supported by the containing chart.

Parameters

dimension:String — Determines the axis to get data descriptions of.
 
requiredFields:uint — A bitfield that indicates which values of the DataDescription object the particular axis cares about. Implementors can optimize by only calculating the necessary fields.

Returns
Array — An Array containing the DataDescription instances that describe the data that is displayed.

See also

findDataPoints

()method 
public function findDataPoints(x:Number, y:Number, sensitivity2:Number):Array

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

Returns a HitData object describing the nearest data point to the coordinates passed to the method. The x and y arguments should be values in the Element's coordinate system. This method aheres to the limits specified by the sensitivity2 parameter when looking for nearby data points.

Parameters

x:Number — The x coordinate relative to the ChartBase object.
 
y:Number — The y coordinate relative to the ChartBase object.
 
sensitivity2:Number — The maximum distance from the data point that the x/y coordinate location can be.

Returns
Array — A HitData object describing the nearest data point within sensitivity2 pixels.

See also

mappingChanged

()method 
public function mappingChanged():void

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

Indicates to the element that the data mapping of the associated axes has changed. Implementors should dispose of cached data and re-render appropriately. This function is called automatically by the associated DataTransform when necessary.