| Package | flare.vis.legend |
| Class | public class LegendItem |
| Inheritance | LegendItem  RectSprite DirtySprite flash.display.Sprite |
| Property | Defined by | ||
|---|---|---|---|
 | angle : Number The angle value of this sprite's position in polar co-ordinates.
| DirtySprite | |
| cornerHeight : Number The height of rounded corners.
| RectSprite | |
| cornerSize : Number Sets corner width and height simultaneously.
| RectSprite | |
| cornerWidth : Number The width of rounded corners.
| RectSprite | |
| fillColor : uint The fill color of the rectangle.
| RectSprite | |
| h : Number The height of the rectangle.
| RectSprite | |
| height : Number
If dirty, this sprite is re-rendered before returning the height.
| DirtySprite | |
| icon : Shape [read-only] Shape presenting this legend item's icon.
| LegendItem | ||
| iconLineWidth : Number Line width to use within the icon.
| LegendItem | ||
| iconSize : Number Size parameter for icon drawing.
| LegendItem | ||
| innerHeight : Number [read-only] The inner height of this legend item.
| LegendItem | ||
| innerWidth : Number [read-only] The inner width of this legend item.
| LegendItem | ||
| label : TextSprite
[read-only] TextSprite presenting this legend item's label.
| LegendItem | ||
| lineColor : uint The line color of the rectangle outline.
| RectSprite | |
| linePixelHinting : Boolean Flag indicating if pixel hinting should be used for the outline.
| RectSprite | |
| lineWidth : Number The line width of the rectangle outline.
| RectSprite | |
| margin : Number Margin value for padding within the legend item.
| LegendItem | ||
| maxIconSize : Number Maximum size parameter for icon drawing.
| LegendItem | ||
| origin : Point The origin point for polar coordinates.
| DirtySprite | |
| radius : Number The radius value of this sprite's position in polar co-ordinates.
| DirtySprite | |
| selected : Boolean Flag indicating if this legend item has been selected.
| LegendItem | ||
| text : String The label text.
| LegendItem | ||
| value : Object The data value represented by this legend item.
| LegendItem | ||
| w : Number The width of the rectangle.
| RectSprite | |
| width : Number
If dirty, this sprite is re-rendered before returning the width.
| DirtySprite | |
| x : Number | DirtySprite | |
| y : Number | DirtySprite | |
| Method | Defined by | ||
|---|---|---|---|
|
LegendItem(text:String = null, color:uint = 0xff888888, shape:String = null, iconSize:Number)
Creates a new LegendItem.
| LegendItem | ||
|
dirty():void
Marks this sprite as "dirty" and in need of re-rendering.
| DirtySprite | |
|
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
If dirty, this sprite is re-rendered returning the bounds.
| DirtySprite | |
|
getRect(targetCoordinateSpace:DisplayObject):Rectangle
If dirty, this sprite is re-rendered before returning the rect.
| DirtySprite | |
|
hitTestObject(obj:DisplayObject):Boolean
If dirty, either sprite is re-rendered before hit-testing.
| DirtySprite | |
|
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
If dirty, this sprite is re-rendered before hit-testing.
| DirtySprite | |
|
render():void
Draw this sprite's graphical content.
| LegendItem | ||
|
renderDirty(evt:Event = null):void
[static]
Frame render callback that renders all sprites on the dirty list.
| DirtySprite | |
|
toString():String
| DirtySprite | |
| icon | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesicon:Shape [read-only]Shape presenting this legend item's icon.
Implementation public function get icon():Shape
| iconLineWidth | property |
iconLineWidth:Number [read-write]Line width to use within the icon.
Implementation public function get iconLineWidth():Number
public function set iconLineWidth(value:Number):void
| iconSize | property |
iconSize:Number [read-write]Size parameter for icon drawing.
Implementation public function get iconSize():Number
public function set iconSize(value:Number):void
| innerHeight | property |
innerHeight:Number [read-only]The inner height of this legend item.
Implementation public function get innerHeight():Number
| innerWidth | property |
innerWidth:Number [read-only]The inner width of this legend item.
Implementation public function get innerWidth():Number
| label | property |
label:TextSprite [read-only]TextSprite presenting this legend item's label.
Implementation public function get label():TextSprite
| margin | property |
margin:Number [read-write]Margin value for padding within the legend item.
Implementation public function get margin():Number
public function set margin(value:Number):void
| maxIconSize | property |
maxIconSize:Number [read-write]Maximum size parameter for icon drawing.
Implementation public function get maxIconSize():Number
public function set maxIconSize(value:Number):void
| selected | property |
selected:Boolean [read-write]Flag indicating if this legend item has been selected.
Implementation public function get selected():Boolean
public function set selected(value:Boolean):void
| text | property |
text:String [read-write]The label text.
Implementation public function get text():String
public function set text(value:String):void
| value | property |
value:Object [read-write]The data value represented by this legend item.
Implementation public function get value():Object
public function set value(value:Object):void
| LegendItem | () | constructor |
public function LegendItem(text:String = null, color:uint = 0xff888888, shape:String = null, iconSize:Number)Creates a new LegendItem.
Parameterstext:String (default = null) |
|
color:uint (default = 0xff888888) |
|
shape:String (default = null) |
|
iconSize:Number — a size parameter for drawing the label icon
|
| render | () | method |
public override function render():voidDraw this sprite's graphical content. Subclasses should override this method with custom drawing code.