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

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
 Inheritedalpha : Number
The transparency of this object.
IFlexDisplayObject
  chartDataProvider : Object
[write-only] The data provider assigned to the enclosing chart.
IChartElement
  dataTransform : DataTransform
[write-only] The DataTransform object that the element uses to map between data and screen coordinates.
IChartElement
 Inheritedheight : Number
The height of this object, in pixels.
IFlexDisplayObject
  labelContainer : Sprite
[read-only] The DisplayObject that displays labels rendered by this element.
IChartElement
 Inheritedmask : DisplayObject
The DisplayObject used to mask this object so that only part of it is actually drawn.
IFlexDisplayObject
 InheritedmeasuredHeight : Number
The measured height of this object.
IFlexDisplayObject
 InheritedmeasuredWidth : Number
The measured width of this object.
IFlexDisplayObject
 Inheritedname : String
The instance name of this object.
IFlexDisplayObject
 Inheritedparent : DisplayObjectContainer
The parent of this object.
IFlexDisplayObject
 InheritedscaleX : Number
The horizontal scaling factor for this object.
IFlexDisplayObject
 InheritedscaleY : Number
The vertical scaling factor for this object.
IFlexDisplayObject
 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
  
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
  
findDataPoints(x:Number, y:Number, sensitivity2:Number):Array
Returns a HitData object describing the nearest data point to the coordinates passed to the method.
IChartElement
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
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
chartDataProviderproperty
chartDataProvider:Object  [write-only]

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
dataTransformproperty 
dataTransform:DataTransform  [write-only]

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:DataTransform):void
labelContainerproperty 
labelContainer:Sprite  [read-only]

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

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

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]. Elements return the new value for firstAvailable after claiming any styles (for example, firstAvailable + N).

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

Returns
uint
collectTransitions()method 
public function 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. 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

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 mutiple 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
findDataPoints()method 
public function findDataPoints(x:Number, y:Number, sensitivity2:Number):Array

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

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

See also

mappingChanged()method 
public function mappingChanged():void

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.





 

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/IChartElement.html