| Package | xp.charting |
| Class | public class Legend |
| Inheritance | Legend  mx.containers.Tile |
Default MXML PropertydataProvider
| Property | Defined by | ||
|---|---|---|---|
| canTile : Boolean = false
Control whether the legend item can be layed out in a grid or a single row/column
| Legend | ||
| dataProvider : Object
The source of the legend items.
| Legend | ||
| Method | Defined by | ||
|---|---|---|---|
|
Legend()
| Legend | ||
|
getClassStyleDeclarations():Array
| Legend | ||
| Method | Defined by | ||
|---|---|---|---|
|
commitProperties():void
Processes the properties set on the component.
| Legend | ||
|
createChildren():void
| Legend | ||
|
measure():void
| Legend | ||
| Style | Description | Defined 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. | Legend | ||
|
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
<mx:Container backgroundColor="0x66CC66"/>
<mx:ControlName ... fillAlphas="[1,1]"/>
</mx:Container>
| Legend | ||
|
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.
| Legend | ||
|
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
<mx:Container backgroundColor="0x66CC66"/>
<mx:ControlName ... fillAlphas="[1,1]"/>
</mx:Container>
| Legend | ||
|
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.
| Legend | ||
|
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. | Legend | ||
|
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.
| Legend | ||
|
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".
| Legend | ||
|
borderSkin
| Type: Class CSS Inheritance: no The border skin of the component. The default value is mx.skins.halo.HaloBorder. | Legend | ||
|
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".
| Legend | ||
|
borderThickness
| Type: Number Format: Length CSS Inheritance: no Bounding box thickness. Only used when borderStyle is set to "solid".
The default value is 1. | Legend | ||
|
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. | Legend | ||
|
dropShadowColor
| Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow. The default value is 0x000000. | Legend | ||
|
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
| Legend | ||
|
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. | Legend | ||
|
markerRenderer
| Type: xp.charting.IMarkerRenderer CSS Inheritance: yes | Legend | ||
|
markerSize
| Type: int Format: Length CSS Inheritance: yes Specifies the size of the legend marker element. The default value is 10. | Legend | ||
|
markerSpacing
| Type: int Format: Length CSS Inheritance: yes Specifies the spacing between the marker and the legend text. The default value is 5. | Legend | ||
|
markerStroke
| Type: mx.graphics.IStroke CSS Inheritance: yes | Legend | ||
|
markerType
| Type: String CSS Inheritance: yes | Legend | ||
|
shadowDirection
| Type: String CSS Inheritance: no Direction of the drop shadow. Possible values are "left", "center",
and "right".
The default value is "center". | Legend | ||
|
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. | Legend | ||
|
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. | Legend | ||
| canTile | property |
public var canTile:Boolean = falseControl whether the legend item can be layed out in a grid or a single row/column
| dataProvider | property |
dataProvider:Object [read-write]The source of the legend items. The data model for legend items . The value of this property is usually a chart base class or an array of legend items but can be any object that implements the DataProvider API.
Implementation public function get dataProvider():Object
public function set dataProvider(value:Object):void
| Legend | () | constructor |
public function Legend()
| commitProperties | () | method |
protected override function commitProperties():voidProcesses the properties set on the component.
| createChildren | () | method |
protected override function createChildren():void
| getClassStyleDeclarations | () | method |
public override function getClassStyleDeclarations():ArrayReturns
Array |
| measure | () | method |
protected override function measure():void