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

Package	mx.charts.chartClasses
Class	public class RenderData
Inheritance	RenderData Object
Subclasses	AreaSeriesRenderData, BarSeriesRenderData, BubbleSeriesRenderData, ColumnSeriesRenderData, HLOCSeriesRenderData, LineSeriesRenderData, PieSeriesRenderData, PlotSeriesRenderData

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

RenderData structures are used by chart elements to store all of the relevant values and data needed to fully render the chart. Storing these values in a separate structure lets chart elements decouple their rendering from their assigned properties and data as necessary. This ability is used by the chart effects: effects such as SeriesInterpolate substitute temporary values calculated from previous and future renderData structures. Effects such as SeriesSlide and SeriesZoom substitute temporary RenderData structures with values calculated to render the effect correctly.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bounds : Rectangle The bounds of all of the items a series displays on screen, relative to the series's coordinate system.	RenderData
		cache : Array The list of ChartItems representing the items in the series's dataProvider.	RenderData
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		elementBounds : Array An Array of rectangles describing the bounds of the series's ChartItems, relative to the series's coordinate system.	RenderData
		filteredCache : Array The list of ChartItems representing the items in the series's dataProvider that remain after filtering.	RenderData
		length : uint [read-only] The number of items represented in this render data.	RenderData
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		visibleRegion : Rectangle The rectangle describing the possible coordinate range that a series can display on screen.	RenderData

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		RenderData(cache:Array = null, filteredCache:Array = null) Constructor.	RenderData
		clone():RenderData Creates a copy of the render data.	RenderData
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

bounds

property

public var bounds:Rectangle

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The bounds of all of the items a series displays on screen, relative to the series's coordinate system. This value is used by the various effects during rendering. A series fills in this value when the effect calls the getElementBounds() method. A series does not need to fill in this field unless specifically requested.

cache

property

public var cache:Array

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The list of ChartItems representing the items in the series's dataProvider.

elementBounds

property

public var elementBounds:Array

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

An Array of rectangles describing the bounds of the series's ChartItems, relative to the series's coordinate system. Effects use this Array to generate the effect rendering. An effect calls the getElementBounds() method, which causes the series to fill in this value. A series does not need to fill in this field unless specifically requested. Effects modify this Array to relect current positions of the items during the effect duration. If this value is filled in on the series's renderData, the series renders itself based on these rectangles rather than from the series's data.

filteredCache

property

public var filteredCache:Array

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The list of ChartItems representing the items in the series's dataProvider that remain after filtering.

length

property

length:uint [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The number of items represented in this render data.

Implementation
public function get length():uint

visibleRegion

property

public var visibleRegion:Rectangle

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The rectangle describing the possible coordinate range that a series can display on screen. This value is used by the various effects during rendering. An effect calls the getElementBounds() method to fill in this value. A series does not need to fill in this field unless specifically requested. If left null, effects assume the visible region of an element is the bounding box of the element itself (0, 0, width, height), expressed relative to the element.

Constructor Detail

RenderData

()

Constructor

public function RenderData(cache:Array = null, filteredCache:Array = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

	`cache:Array` (default = `null`) — The list of ChartItems representing the items in the series's `dataProvider`.

	`filteredCache:Array` (default = `null`) — The list of ChartItems representing the items in the series's `dataProvider` that remain after filtering.

Method Detail

clone

()

method

public function clone():RenderData

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Creates a copy of the render data. In the new copy, properties that point to other objects continue to point to the same objects as the original.

If you subclass this class, you must override this method.

Returns

RenderData — The new copy of the RenderData object.