Packagexp.charting
Classpublic class LegendItem
InheritanceLegendItem Inheritance mx.core.UIComponent
Implementsmx.core.IDataRenderer

A non-editable, single or multi line text field. A label component can contain a single or multiple lines of text. You can control the font, alignment and size of a label. An optional Icon can be displayed placed either left,right,above or below the text The icon property is set with the linkageId of a clip. After loading the icon will be a {

See also

support


Public Properties
 PropertyDefined by
  data : Object
Lets you pass a value to the component when you use it in an item renderer or item editor.
LegendItem
Protected Properties
 PropertyDefined by
  _labelPlacement : String
LegendItem
  _markerRenderer : IMarkerRenderer
LegendItem
  _markerSize : Number
LegendItem
  _markerSpacing : Number
LegendItem
  _markerStroke : IStroke
LegendItem
  _markerType : String
LegendItem
  _paddingBottom : Number = 0
LegendItem
  _paddingLeft : Number = 0
LegendItem
  _paddingRight : Number = 0
LegendItem
  _paddingTop : Number = 0
LegendItem
Public Methods
 MethodDefined by
  
Constructor
LegendItem
  
LegendItem
  
styleChanged(styleProp:String):void
LegendItem
Protected Methods
 MethodDefined by
  
LegendItem
  
markerRender(x:Number, y:Number, r:Number):void
LegendItem
  
setData():void
LegendItem
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
LegendItem
Styles
 StyleDescriptionDefined by
  
backgroundAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. Valid values range from 0.0 to 1.0. The default value is 1.0.
LegendItem
  
backgroundColor
Type: uint   Format: Color   CSS Inheritance: no
Background color of a component. You can have both a backgroundColor and a backgroundImage set. Some components do not have a background. The DataGrid control ignores this style. The default value is undefined, which means it is not set. If both this style and the backgroundImage style are undefined, the component has a transparent background.

For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color.

The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows:

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

LegendItem
  
backgroundDisabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Background color of the component when it is disabled. The global default value is undefined. The default value for List controls is 0xDDDDDD (light gray). If a container is disabled, the background is dimmed, and the degree of dimming is controlled by the disabledOverlayAlpha style.
LegendItem
  
backgroundImage
Type: Object   Format: File   CSS Inheritance: no
Background image of a component. This can be an absolute or relative URL or class. You can either have both a backgroundColor and a backgroundImage set at the same time. The background image is displayed on top of the background color. The default value is undefined, meaning "not set". If this style and the backgroundColor style are undefined, the component has a transparent background.

The default skins of most Flex controls are partially transparent. As a result, the background image of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows:

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

LegendItem
  
backgroundSize
Type: String   CSS Inheritance: no
Scales the image specified by backgroundImage to different percentage sizes. A value of "100%" stretches the image to fit the entire component. To specify a percentage value, you must include the percent sign (%). The default value is "auto", which maintains the original size of the image.
LegendItem
  
borderAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the borderColor property. Valid values range from 0.0 to 1.0. The default value is 1.0.
LegendItem
  
borderColor
Type: uint   Format: Color   CSS Inheritance: no
Color of the border. The default value depends on the component class; if not overridden for the class, the default value is 0xB7BABC.
LegendItem
  
borderSides
Type: String   CSS Inheritance: no
Bounding box sides. A space-delimited String that specifies the sides of the border to show. The String can contain "left", "top", "right", and "bottom" in any order. The default value is "left top right bottom", which shows all four sides. This style is only used when borderStyle is "solid".
LegendItem
  
borderSkin
Type: Class   CSS Inheritance: no
The border skin of the component. The default value is mx.skins.halo.HaloBorder.
LegendItem
  
borderStyle
Type: String   CSS Inheritance: no
Bounding box style. The possible values are "none", "solid", "inset", and "outset". The default value depends on the component class; if not overridden for the class, the default value is "inset". The default value for most Containers is "none".
LegendItem
  
borderThickness
Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness. Only used when borderStyle is set to "solid". The default value is 1.
LegendItem
  
cornerRadius
Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners. The default value depends on the component class; if not overriden for the class, the default value is 0. The default value for ApplicationControlBar is 5.
LegendItem
  
dropShadowColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow. The default value is 0x000000.
LegendItem
  
dropShadowEnabled
Type: Boolean   CSS Inheritance: no
Boolean property that specifies whether the component has a visible drop shadow. This style is used with borderStyle="solid". The default value is false.

Note: For drop shadows to appear on containers, set backgroundColor or backgroundImage properties. Otherwise, the shadow appears behind the container because the default background of a container is transparent.

LegendItem
  
horizontalGap
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overriden for the class, the default value is 8.
LegendItem
  
labelPlacement
Type: String   CSS Inheritance: yes
Specifies the label placement of the legend element. Recognized values are "top", "bottom", "left", and "right".
LegendItem
  
markerRenderer
Type: xp.charting.IMarkerRenderer   CSS Inheritance: yes
LegendItem
  
markerSize
Type: int   Format: Length   CSS Inheritance: yes
Specifies the size of the legend marker element. The default value is 12.
LegendItem
  
markerSpacing
Type: int   Format: Length   CSS Inheritance: yes
Specifies the spacing between the marker and the legend text. The default value is 5.
LegendItem
  
markerStroke
Type: mx.graphics.IStroke   CSS Inheritance: yes
LegendItem
  
markerType
Type: String   CSS Inheritance: yes
LegendItem
  
shadowDirection
Type: String   CSS Inheritance: no
Direction of the drop shadow. Possible values are "left", "center", and "right". The default value is "center".
LegendItem
  
shadowDistance
Type: Number   Format: Length   CSS Inheritance: no
Distance of the drop shadow. If the property is set to a negative value, the shadow appears above the component. The default value is 2.
LegendItem
  
verticalGap
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between children in the vertical direction. The default value depends on the component class; if not overriden for the class, the default value is 6.
LegendItem
Property detail
dataproperty
data:Object  [read-write]

Lets you pass a value to the component when you use it in an item renderer or item editor. You typically use data binding to bind a field of the data property to a property of this component.

When you use the control as a drop-in item renderer or drop-in item editor, Flex automatically writes the current value of the item to the text property of this control.

You do not set this property in MXML.

The default value is null.

This property can be used as the source for data binding.

Implementation
    public function get data():Object
    public function set data(value:Object):void

See also

mx.core.IDataRenderer
_labelPlacementproperty 
protected var _labelPlacement:String
_markerRendererproperty 
protected var _markerRenderer:IMarkerRenderer
_markerSizeproperty 
protected var _markerSize:Number
_markerSpacingproperty 
protected var _markerSpacing:Number
_markerStrokeproperty 
protected var _markerStroke:IStroke
_markerTypeproperty 
protected var _markerType:String
_paddingBottomproperty 
protected var _paddingBottom:Number = 0
_paddingLeftproperty 
protected var _paddingLeft:Number = 0
_paddingRightproperty 
protected var _paddingRight:Number = 0
_paddingTopproperty 
protected var _paddingTop:Number = 0
Constructor detail
LegendItem()constructor
public function LegendItem()

Constructor

Method detail
createChildren()method
protected override function createChildren():void
getClassStyleDeclarations()method 
public override function getClassStyleDeclarations():Array

Returns
Array
markerRender()method 
protected function markerRender(x:Number, y:Number, r:Number):voidParameters
x:Number
 
y:Number
 
r:Number
setData()method 
protected function setData():void
styleChanged()method 
public override function styleChanged(styleProp:String):voidParameters
styleProp:String
updateDisplayList()method 
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters
unscaledWidth:Number
 
unscaledHeight:Number