mx.charts.chartClasses.IChartElement2 - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.charts.chartClasses
Interface	public interface IChartElement2 extends IChartElement , IFlexDisplayObject , IBitmapDrawable , IEventDispatcher
Implementors	ChartElement

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

IChartElement2 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 The current accessibility options for this display object.	IFlexDisplayObject
		alpha : Number Indicates the alpha transparency value of the object specified.	IFlexDisplayObject
		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
		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
		filters : Array An indexed array that contains each filter object currently associated with the display object.	IFlexDisplayObject
		height : 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
		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
		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] 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
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	IFlexDisplayObject
		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
		transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	IFlexDisplayObject
		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
		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
		dataToLocal(... dataValues):Point Converts a tuple of data values to an x-y coordinate on screen.	IChartElement2
		describeData(dimension:String, requiredFields:uint):Array Called by the governing DataTransform to obtain a description of the data represented by this IChartElement.	IChartElement
		dispatchEvent(event:Event):Boolean 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
		getAllDataPoints():Array Returns an array of HitData of the items of all the underlying objects that implement IChartElement2 whose dataTips are to be shown when showAllDataTips is set to true on chart.	IChartElement2
		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
		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
		localToData(pt:Point):Array Converts a coordinate on screen to a tuple of data values.	IChartElement2
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	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
		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
		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

Method Detail

dataToLocal

()

method

public function dataToLocal(... dataValues):Point

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Converts a tuple of data values to an x-y coordinate on screen. Call this function to transform data on to the screen using the same transform that the individual elements go through. For example, to create a custom highlight for a data region of a chart, you might use this function to determine the on-screen coordinates of the range of interest.

For Cartesian chartelements, you typically pass two values. The first value maps to the horizontal axis, and the second value maps to the vertical axis.

For polar charts, the first value maps to the angular axis, and the second maps to the radial axis.

Parameters

... dataValues — The data values to convert to coordinates.

Returns

Point — Coordinates that are relative to the chart.

getAllDataPoints

()

method

public function getAllDataPoints():Array

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns an array of HitData of the items of all the underlying objects that implement IChartElement2 whose dataTips are to be shown when showAllDataTips is set to true on chart.

Returns

Array — The HitData objects describing the data points

localToData

()

method

public function localToData(pt:Point):Array

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Converts a coordinate on screen to a tuple of data values. Call this function to determine what data values a particular point on-screen represents.

Individual chart types determine how this transformation occurs. The point should be relative to the chart's coordinate space.

Parameters

pt:Point — The Point to convert.

Returns

Array — The tuple of data values.