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

Package	mx.charts.chartClasses
Class	public class LegendData
Inheritance	LegendData Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The LegendData structure is used by charts to describe the items that should be displayed in an auto-generated legend. A chart's legendData property contains an Array of LegendData objects, one for each item in the Legend.

See also

Using Legend controls

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		aspectRatio : Number Determines the size and placement of the legend marker.	LegendData
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		element : IChartElement The chart item that generated this legend item.	LegendData
		label : String The text identifying the series or item displayed in the legend item.	LegendData
		marker : IFlexDisplayObject A visual indicator associating the legend item with the series or item being represented.	LegendData
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		LegendData() Constructor.	LegendData
		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

aspectRatio

property

public var aspectRatio:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Determines the size and placement of the legend marker. If set, the LegendItem ensures that the marker's width and height match this value. If unset (NaN), the legend item chooses an appropriate default width and height.

element

property

public var element:IChartElement

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The chart item that generated this legend item.

label

property

public var label:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The text identifying the series or item displayed in the legend item.

marker

property

public var marker:IFlexDisplayObject

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

A visual indicator associating the legend item with the series or item being represented. This DisplayObject is added as a child to the LegendItem.

Constructor Detail

LegendData

()

Constructor

public function LegendData()

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.