ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.charts.chartClasses 

LegendData  - AS3 Flex

Packagemx.charts.chartClasses
Classpublic class LegendData
InheritanceLegendData Inheritance 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.

Learn more



Public Properties
 PropertyDefined By
  aspectRatio : Number
Determines the size and placement of the legend marker.
LegendData
 Inheritedconstructor : 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
Public Methods
 MethodDefined By
  
Constructor.
LegendData
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
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.