| Package | fr.kapit.components.treemap |
| Class | public class TreeMapLegend |
| Inheritance | TreeMapLegend  fr.kapit.components.treemap.TreeMapFilter |
| Property | Defined by | ||
|---|---|---|---|
| divisions : Number
Indicates the number of divisions on the legend.
| TreeMapLegend | ||
| labelFunction : Function
A function used to customize labels.
| TreeMapLegend | ||
| leftValue : Number
The value associated with the left arrow.
| TreeMapLegend | ||
| maxValue : Number
Indicates the minimum value on the filter.
| TreeMapLegend | ||
| minValue : Number
Indicates the minimum value on the filter.
| TreeMapLegend | ||
| rightValue : Number
The value associated with the left arrow.
| TreeMapLegend | ||
| showFilter : Boolean
Indicates whether to show the filter arrows on the legend.
| TreeMapLegend | ||
| textFormat : TextFormat
Indicates the TextFormat used to render text in the legend.
| TreeMapLegend | ||
| treeMap : TreeMap
The TreeMap associated with this TreeMapLegend.
| TreeMapLegend | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| TreeMapLegend | ||
| divisions | property |
divisions:Number [read-write]Indicates the number of divisions on the legend.
Implementation public function get divisions():Number
public function set divisions(value:Number):void
| labelFunction | property |
labelFunction:Function [read-write]
A function used to customize labels.
It must have the following signature : labelFunction(n:Number):String.
public function get labelFunction():Function
public function set labelFunction(value:Function):void
| leftValue | property |
leftValue:Number [read-write]
The value associated with the left arrow.
The leftValue can be modified programatically. But it will default to minValue
if the new value is lower than minValue and to maxValue if the new value is greater than maxValue.
It also changes the rightValue if the new value is greater than rightValue in order to keep the property leftValue <= rightValue.
public function get leftValue():Number
public function set leftValue(value:Number):void
| maxValue | property |
maxValue:Number [read-write]Indicates the minimum value on the filter.
Implementation public function get maxValue():Number
public function set maxValue(value:Number):void
| minValue | property |
minValue:Number [read-write]Indicates the minimum value on the filter.
Implementation public function get minValue():Number
public function set minValue(value:Number):void
| rightValue | property |
rightValue:Number [read-write]
The value associated with the left arrow.
The rightValue can be modified programatically. But it will default to minValue
if the new value is lower than minValue and to maxValue if the new value is greater than maxValue.
It also changes the leftValue if the new value is lower than leftValue in order to keep the property leftValue <= rightValue.
public function get rightValue():Number
public function set rightValue(value:Number):void
| showFilter | property |
showFilter:Boolean [read-write]Indicates whether to show the filter arrows on the legend.
Implementation public function get showFilter():Boolean
public function set showFilter(value:Boolean):void
| textFormat | property |
textFormat:TextFormat [read-write]Indicates the TextFormat used to render text in the legend.
Implementation public function get textFormat():TextFormat
public function set textFormat(value:TextFormat):void
| treeMap | property |
treeMap:TreeMap [read-write]The TreeMap associated with this TreeMapLegend.
Implementation public function get treeMap():TreeMap
public function set treeMap(value:TreeMap):void
| TreeMapLegend | () | constructor |
public function TreeMapLegend()Constructor.