Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
IChartElement

Package | mx.charts.chartClasses
Interface | public interface IChartElement extends IFlexDisplayObject, flash.display.IBitmapDrawable, flash.events.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
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityProperties : AccessibilityProperties | IFlexDisplayObject
|  | alpha : Number | IFlexDisplayObject
|  | blendMode : String | IFlexDisplayObject
|  | cacheAsBitmap : Boolean | 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
|  | filters : Array | IFlexDisplayObject
|  | height : Number | IFlexDisplayObject
|  | labelContainer : Sprite [read-only] The DisplayObject that displays labels rendered by this element. | IChartElement
|  | loaderInfo : LoaderInfo [read-only] | IFlexDisplayObject
|  | mask : DisplayObject | IFlexDisplayObject
|  | measuredHeight : Number [read-only] The measured height of this object. | IFlexDisplayObject
|  | measuredWidth : Number [read-only] The measured width of this object. | IFlexDisplayObject
|  | mouseX : Number [read-only] | IFlexDisplayObject
|  | mouseY : Number [read-only] | IFlexDisplayObject
|  | name : String | IFlexDisplayObject
|  | opaqueBackground : Object | IFlexDisplayObject
|  | parent : DisplayObjectContainer [read-only] | IFlexDisplayObject
|  | root : DisplayObject [read-only] | IFlexDisplayObject
|  | rotation : Number | IFlexDisplayObject
|  | scale9Grid : Rectangle | IFlexDisplayObject
|  | scaleX : Number | IFlexDisplayObject
|  | scaleY : Number | IFlexDisplayObject
|  | scrollRect : Rectangle | IFlexDisplayObject
|  | stage : Stage [read-only] | IFlexDisplayObject
|  | transform : Transform | IFlexDisplayObject
|  | visible : Boolean | IFlexDisplayObject
|  | width : Number | IFlexDisplayObject
|  | x : Number | IFlexDisplayObject
|  | y : Number | IFlexDisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | chartStateChanged(oldState:uint, v:uint):void 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
|  | 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
|  | getBounds(targetCoordinateSpace:DisplayObject):Rectangle | IFlexDisplayObject
|  | getRect(targetCoordinateSpace:DisplayObject):Rectangle | IFlexDisplayObject
|  | globalToLocal(point:Point):Point | IFlexDisplayObject
|  | hitTestObject(obj:DisplayObject):Boolean | IFlexDisplayObject
|  | hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean | IFlexDisplayObject
|  | localToGlobal(point:Point):Point | IFlexDisplayObject
|  | mappingChanged():void Indicates to the element that the data mapping of the associated axes has changed. | IChartElement
|  | move(x:Number, y:Number):void Moves this object to the specified x and y coordinates. | IFlexDisplayObject
|  | setActualSize(newWidth:Number, newHeight:Number):void Sets the actual size of this object. | IFlexDisplayObject

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

mx.charts.chartClasses.DataDescription
mx.charts.chartClasses.DataTransform

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

mx.charts.HitData

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.

Wed Nov 15 2017, 09:50 AM +01:00