Packagefr.kapit.components.treemap
Classpublic class TreeMapFilter
InheritanceTreeMapFilter Inheritance mx.core.UIComponent
SubclassesTreeMapAreaFilter, TreeMapColorFilter, TreeMapLegend



Public Properties
 PropertyDefined by
  filterHeight : Number
[read-only]
TreeMapFilter
  filterWidth : Number
[read-only]
TreeMapFilter
  filterX : Number
[read-only]
TreeMapFilter
  filterY : Number
[read-only]
TreeMapFilter
  isInitialized : Boolean
TreeMapFilter
  labelFunction : Function
A function used to customize labels.
TreeMapFilter
  leftValue : Number
The value associated with the left thumb.
TreeMapFilter
  maxValue : Number
Indicates the minimum value on the filter.
TreeMapFilter
  minValue : Number
Indicates the minimum value on the filter.
TreeMapFilter
  rightValue : Number
The value associated with the left thumb.
TreeMapFilter
  thumbRenderer : Class
TreeMapFilter
  thumbTextFormat : TextFormat
Indicates the TextFormat used to render text in the legend.
TreeMapFilter
  trackRenderer : Class
TreeMapFilter
  treeMap : TreeMap
TreeMapFilter
Protected Properties
 PropertyDefined by
  canDrawThumbs : Boolean
[read-only]
TreeMapFilter
  _hitArea : Sprite
TreeMapFilter
  leftThumb : TreeMapThumb
[read-only]
TreeMapFilter
  rightThumb : TreeMapThumb
[read-only]
TreeMapFilter
  _trackArea : Sprite
TreeMapFilter
Public Methods
 MethodDefined by
  
TreeMapFilter
  
formattedNumber(n:Number, roundNumber:Boolean = true):String
TreeMapFilter
  
getStyle(styleProp:String):*
TreeMapFilter
  
init():void
TreeMapFilter
  
removeFilter():void
TreeMapFilter
  
startThumbDrag(event:MouseEvent):void
TreeMapFilter
  
styleChanged(styleProp:String):void
TreeMapFilter
  
updateValues():void
TreeMapFilter
  
valueToX(value:Number):Number
TreeMapFilter
  
xToValue(x:Number):Number
TreeMapFilter
Protected Methods
 MethodDefined by
  
TreeMapFilter
  
TreeMapFilter
  
drawFilter():void
TreeMapFilter
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
TreeMapFilter
Events
 EventSummaryDefined by
   Dispatched when the user ends dragging the filter thumb.TreeMapFilter
   Dispatched when the used drags the filter thumb and changes the value.TreeMapFilter
Styles
 StyleDescriptionDefined by
  
bigTickColor
Type: uint
Big Ticks Color. Default value is 0x552233.
TreeMapFilter
  
bigTickLength
Type: uint
Big Ticks Length. Default value is 0x552233.
TreeMapFilter
  
bigTicksNumber
Type: Number
Big Ticks Number. Default value is 3.
TreeMapFilter
  
bigTickThickness
Type: uint
Big Ticks Thickness. Default value is 0x552233.
TreeMapFilter
  
leftThumbDirection
Type: String
Left Thumb Direction. It can be up or down Default value is UP_DIR.
TreeMapFilter
  
rightThumbDirection
Type: String
Right Thumb Direction. It can be up or down Default value is DOWN_DIR.
TreeMapFilter
  
showTicks
Type: Boolean
Enables ticks to be shown below track area. Default value is false.
TreeMapFilter
  
textOffset
Type: Number
Text Offset. It can be up or down Default value is 1.
TreeMapFilter
  
thumbBorderColor
Type: uint   Format: Color   CSS Inheritance: no
Color of the border of thumbs. Default value is 0x999999.
TreeMapFilter
  
thumbFillAlphas
Type: Array   CSS Inheritance: no
Alpha values used for the thumbs gradient. Default value is [1.0, 1.0].
TreeMapFilter
  
thumbFillColors
Type: Array   Format: Color   CSS Inheritance: no
Colors used for the thumbs gradient. Default value is [0x999999, 0x999999].
TreeMapFilter
  
thumbFillRatios
Type: Array   CSS Inheritance: no
Fill ratio used for the thumbs gradient. Default value is [0.0, 255.0].
TreeMapFilter
  
thumbOffset
Type: Number
Thumb Offset. It can be up or down Default value is 3.
TreeMapFilter
  
ticksOffset
Type: Number
Ticks Offset. It can be up or down Default value is 5.
TreeMapFilter
  
tinyTickColor
Type: uint
Tiny Ticks Color. Default value is 0x552233.
TreeMapFilter
  
tinyTickLength
Type: uint
Big Ticks Length. Default value is 0x552233.
TreeMapFilter
  
tinyTicksNumber
Type: Number
Tiny Ticks Number. Default value is 3.
TreeMapFilter
  
tinyTickThickness
Type: uint
Tiny Ticks Thickness. Default value is 0x552233.
TreeMapFilter
Property detail
canDrawThumbsproperty
canDrawThumbs:Boolean  [read-only]Implementation
    protected function get canDrawThumbs():Boolean
filterHeightproperty 
filterHeight:Number  [read-only]Implementation
    public function get filterHeight():Number
filterWidthproperty 
filterWidth:Number  [read-only]Implementation
    public function get filterWidth():Number
filterXproperty 
filterX:Number  [read-only]Implementation
    public function get filterX():Number
filterYproperty 
filterY:Number  [read-only]Implementation
    public function get filterY():Number
_hitAreaproperty 
protected var _hitArea:Sprite
isInitializedproperty 
isInitialized:Boolean  [read-write]Implementation
    public function get isInitialized():Boolean
    public function set isInitialized(value:Boolean):void
labelFunctionproperty 
labelFunction:Function  [read-write]

A function used to customize labels. It must have the following signature : labelFunction(n:Number):String.

Implementation
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void
leftThumbproperty 
leftThumb:TreeMapThumb  [read-only]Implementation
    protected function get leftThumb():TreeMapThumb
leftValueproperty 
leftValue:Number  [read-write]

The value associated with the left thumb. 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.

Implementation
    public function get leftValue():Number
    public function set leftValue(value:Number):void
maxValueproperty 
maxValue:Number  [read-write]

Indicates the minimum value on the filter.

Implementation
    public function get maxValue():Number
    public function set maxValue(value:Number):void
minValueproperty 
minValue:Number  [read-write]

Indicates the minimum value on the filter.

Implementation
    public function get minValue():Number
    public function set minValue(value:Number):void
rightThumbproperty 
rightThumb:TreeMapThumb  [read-only]Implementation
    protected function get rightThumb():TreeMapThumb
rightValueproperty 
rightValue:Number  [read-write]

The value associated with the left thumb. 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.

Implementation
    public function get rightValue():Number
    public function set rightValue(value:Number):void
thumbRendererproperty 
thumbRenderer:Class  [read-write]Implementation
    public function get thumbRenderer():Class
    public function set thumbRenderer(value:Class):void
thumbTextFormatproperty 
thumbTextFormat:TextFormat  [read-write]

Indicates the TextFormat used to render text in the legend. The size of the textFormat is forced to 8.

Implementation
    public function get thumbTextFormat():TextFormat
    public function set thumbTextFormat(value:TextFormat):void
_trackAreaproperty 
protected var _trackArea:Sprite
trackRendererproperty 
trackRenderer:Class  [read-write]Implementation
    public function get trackRenderer():Class
    public function set trackRenderer(value:Class):void
treeMapproperty 
treeMap:TreeMap  [read-write]Implementation
    public function get treeMap():TreeMap
    public function set treeMap(value:TreeMap):void
Constructor detail
TreeMapFilter()constructor
public function TreeMapFilter()
Method detail
commitProperties()method
protected override function commitProperties():void
createChildren()method 
protected override function createChildren():void
drawFilter()method 
protected function drawFilter():void
formattedNumber()method 
public function formattedNumber(n:Number, roundNumber:Boolean = true):StringParameters
n:Number
 
roundNumber:Boolean (default = true)

Returns
String
getStyle()method 
public override function getStyle(styleProp:String):*Parameters
styleProp:String

Returns
*
init()method 
public function init():void
removeFilter()method 
public function removeFilter():void
startThumbDrag()method 
public function startThumbDrag(event:MouseEvent):voidParameters
event:MouseEvent
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
updateValues()method 
public function updateValues():void
valueToX()method 
public function valueToX(value:Number):NumberParameters
value:Number

Returns
Number
xToValue()method 
public function xToValue(x:Number):NumberParameters
x:Number

Returns
Number
Event detail
valueChangedevent 
Event object type: fr.kapit.components.treemap.events.TreeMapFilterEvent

Dispatched when the user ends dragging the filter thumb.

valueChangingevent  
Event object type: fr.kapit.components.treemap.events.TreeMapFilterEvent

Dispatched when the used drags the filter thumb and changes the value.