applyGradientFill:Boolean  [read-write]

Indicates whether to apply a gradient fill when drawing treemap nodes.

Implementation
    public function get applyGradientFill():Boolean
    public function set applyGradientFill(value:Boolean):void

areaField:String  [read-write]

The name/index of the property used to detemine the area of an item. Only used when areaFunction is null.

Implementation
    public function get areaField():String
    public function set areaField(value:String):void

areaFunction:Function  [read-write]

The function used to detemine the area of an item. It must have the following signature : areaFunction(item:Object):Number.

Implementation
    public function get areaFunction():Function
    public function set areaFunction(value:Function):void

colorChanged:Boolean  [write-only]Implementation
    treemap_internal function set colorChanged(value:Boolean):void

colorField:String  [read-write]

The name/index of the property used to detemine the color of an item. Only used when colorFunction is null.

Implementation
    public function get colorField():String
    public function set colorField(value:String):void

colorFunction:Function  [read-write]

The function used to detemine the color of an item. It must have the following signature : colorFunction(item:Object):Number.

Implementation
    public function get colorFunction():Function
    public function set colorFunction(value:Function):void

colorGenerator:ITreeMapColorGenerator  [read-write]

The colorGenerator is used by the treemap to determine the displayed colors for nodes and for the legend.

Implementation
    public function get colorGenerator():ITreeMapColorGenerator
    public function set colorGenerator(value:ITreeMapColorGenerator):void

colorPolicy:String  [read-write]

Indicates the policy used to generate colors for the nodes.

Implementation
    public function get colorPolicy():String
    public function set colorPolicy(value:String):void

See also

treemap_internal var colorValuesDict:Dictionary

dataDescriptor:ITreeDataDescriptor  [read-write]

Indicates the ITreeDataDescriptor used to parse the hierarchy of the dataProvider. If this property is null, a DefaultDataDescriptor is used. Currently, only the getChildren() and isBranch() methods of the ITreeDataDescriptor interface are used.

Implementation
    public function get dataDescriptor():ITreeDataDescriptor
    public function set dataDescriptor(value:ITreeDataDescriptor):void

discreteColors:Boolean  [read-write]

Indicates whether the colorField/colorFunction contains discrete(non numerical) values or continue (numerical) values.

Implementation
    public function get discreteColors():Boolean
    public function set discreteColors(value:Boolean):void

distanceBetweenBranches:Number  [read-write]

Indicates the distance between the different branches.

Implementation
    public function get distanceBetweenBranches():Number
    public function set distanceBetweenBranches(value:Number):void

distanceBetweenNodes:Number  [read-write]

Indicates the distance between the different nodes.

Implementation
    public function get distanceBetweenNodes():Number
    public function set distanceBetweenNodes(value:Number):void

dynamicTextSize:Boolean  [read-write]

Indicates whether the text on the nodes should have a dynamic size (to fit the area of the node) or respect the default size value.

Implementation
    public function get dynamicTextSize():Boolean
    public function set dynamicTextSize(value:Boolean):void

enableSelection:Boolean  [read-write]

Indicates whether to enable item selection or not.

Implementation
    public function get enableSelection():Boolean
    public function set enableSelection(value:Boolean):void

filterPath:Array  [read-write]

Filter Path is used for CSV and General XML files and enables data source analysis with a given logic. For CSV files(like other formats), the analysis path is an Array containing the columns headers that describes an Hierarchy or another logical entity. This property can be used as the source for data binding.

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

Implementation
    public function get filterPath():Array
    public function set filterPath(value:Array):void

Example
Given the following CSV file, one of the analysis Paths should be ["Entreprise","Department"], the delimiter should be "," and the record delimiter should be "/"". "Entreprise","Department","Profit (KE)","Employees Number" "Enterp1","Dep11","1000","22" "Enterp2","Dep21","1200","30" "Enterp1","Dep12","1500","100" "Enterp2","Dep22","1500","15" "Enterp3","Dep31","1460","10" "Enterp2","Dep23","3000","28" ...

firstColor:uint  [read-write]

The first color used to generate nodes colors.

Implementation
    public function get firstColor():uint
    public function set firstColor(value:uint):void

highlightPolicy:String  [read-write]

Indicates the policy used to display highlight filters.

Implementation
    public function get highlightPolicy():String
    public function set highlightPolicy(value:String):void

See also

iconAlpha:Number  [read-write]

Indicates the icon alpha.

Implementation
    public function get iconAlpha():Number
    public function set iconAlpha(value:Number):void

iconFunction:Function  [read-write]

The function used to detemine the icon of an item. It must have one of the following signatures : iconFunction(item:Object):Class and iconFunction(item:Object):Bitmap.

Implementation
    public function get iconFunction():Function
    public function set iconFunction(value:Function):void

labelField:String  [read-write]

The name/index of the property used to detemine the label of an item. Only used when labelFunction is null.

Implementation
    public function get labelField():String
    public function set labelField(value:String):void

labelFunction:Function  [read-write]

The function used to detemine the label of an item. It must have the following signature : labelFunction(item:Object,info:Object):String where info contains some statistics about the item.

Implementation
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void

labelHorizontalAlign:String  [read-write]

The TreeMapNode label horizontal alignment. Valid values are: left, center and right.

The default value is <code>center</code>.

Implementation
    public function get labelHorizontalAlign():String
    public function set labelHorizontalAlign(value:String):void

labelMinimumHeight:Number  [read-write]

The minimum height for a TreeMapNode to display a label.

The default value is 8.

Implementation
    public function get labelMinimumHeight():Number
    public function set labelMinimumHeight(value:Number):void

See also

labelMinimumWidth:Number  [read-write]

The minimum width for a TreeMapNode to display a label.

The default value is 8.

Implementation
    public function get labelMinimumWidth():Number
    public function set labelMinimumWidth(value:Number):void

See also

labelMultiline:Boolean  [read-write]

Indicates whether the TreeMapNode label has multiline. This property is not used when dynamicTextSizetrue.

The default value is false.

Implementation
    public function get labelMultiline():Boolean
    public function set labelMultiline(value:Boolean):void

labelPolicy:String  [read-write]

Indicates the policy used to display labels.

Implementation
    public function get labelPolicy():String
    public function set labelPolicy(value:String):void

See also

labelTruncateToFit:Boolean  [read-write]

Indicates whether the TreeMapNodel label should be truncated with an '...' indicator to fit the available space.

The default value is false.

Implementation
    public function get labelTruncateToFit():Boolean
    public function set labelTruncateToFit(value:Boolean):void

labelVerticalAlign:String  [read-write]

The TreeMapNode label vertical alignment. Valid values are: top, middle and bottom.

The default value is <code>middle</code>.

Implementation
    public function get labelVerticalAlign():String
    public function set labelVerticalAlign(value:String):void

labelWordWrap:Boolean  [read-write]

Indicates whether the TreeMapNode label has word wrap. This property is not used when dynamicTextSizetrue.

The default value is false.

Implementation
    public function get labelWordWrap():Boolean
    public function set labelWordWrap(value:Boolean):void

maxColorValue:Number  [read-write]

Indicates a custom maximum color value. The Treemap computes the minimum and maximum color values found on the dataProvider and uses them to asign colors to the different nodes. If you don't want to use the default maximum color value, you can specify a custom value using this property.

Implementation
    public function get maxColorValue():Number
    public function set maxColorValue(value:Number):void

minColorValue:Number  [read-write]

Indicates a custom minimum color value. The Treemap computes the minimum and maximum color values found on the dataProvider and uses them to asign colors to the different nodes. If you don't want to use the default minimum color value, you can specify a custom value using this property.

Implementation
    public function get minColorValue():Number
    public function set minColorValue(value:Number):void

nodeHighlightFilters:Array  [read-write]

Indicates the array of filters used to highlight the node under the mouse.

Implementation
    public function get nodeHighlightFilters():Array
    public function set nodeHighlightFilters(value:Array):void

secondColor:uint  [read-write]

The second color used to generate nodes colors.

Implementation
    public function get secondColor():uint
    public function set secondColor(value:uint):void

toolTipField:String  [read-write]

The name/index of the property used to detemine the toolTip of an item. Only used when toolTipFunction is null.

Implementation
    public function get toolTipField():String
    public function set toolTipField(value:String):void

toolTipFunction:Function  [read-write]

The function used to detemine the toolTip of an item. It must have the following signature : toolTipFunction(item:Object,info:Object):String where info contains some statistics about the item.

Implementation
    public function get toolTipFunction():Function
    public function set toolTipFunction(value:Function):void

useDiscreteColors:Boolean  [read-only]Implementation
    treemap_internal function get useDiscreteColors():Boolean

treemap_internal var useKData:Boolean = false

useLogarithmicScale:Boolean  [read-write]

Indicates whether to display the name of branches or not.

Implementation
    public function get useLogarithmicScale():Boolean
    public function set useLogarithmicScale(value:Boolean):void

viewBranchHeader:Boolean  [read-write]

Indicates whether to display the name of branches or not.

Implementation
    public function get viewBranchHeader():Boolean
    public function set viewBranchHeader(value:Boolean):void

public function TreeMap()

Constructor.

public function dataToICollectionView(value:Object):ICollectionViewParameters

value:Object

Returns

ICollectionView

treemap_internal function drillDownUp(b:TreeMapBranch):voidParameters

b:TreeMapBranch

public function filterChanged(filter:TreeMapFilter):voidParameters

filter:TreeMapFilter

public function filterFunction(item:Object):Boolean

Determines the area and color filter applied by the user using the areaFilters or colooFiltersField properties.

Parameters

item:Object

Returns

Boolean

public function getAreaFromData(data:Object):Number

Determines the area from the data object using the areaFunction or areaField properties.

Parameters

data:Object — The data object from which the area will be determined.

Returns

Number — The area determined from the data object.

public function getColorFromData(data:Object):*

Determines the color from the data object using the colorFunction or colorField properties.

Parameters

data:Object — The data object from which the color will be determined.

Returns

* — The color determined from the data object.

public function getIconFromData(data:Object):BitmapParameters

data:Object

Returns

Bitmap

public function getLabelFromData(data:Object, info:Object):String

Determines the label from the data object using the labelFunction or labelField properties.

Parameters

	data:Object — The data object from which the label will be determined.
	info:Object

Returns

String — The label determined from the data object.

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

styleProp:String

Returns

*

public function getToolTipFromData(data:Object, info:Object):String

Determines the toolTip from the data object using the toolTipFunction or toolTipField properties.

Parameters

	data:Object — The data object from which the toolTip will be determined.
	info:Object

Returns

String — The toolTip determined from the data object.

treemap_internal function newNode(parentbranch:ITreeMapBranch):TreeMapNodeParameters

parentbranch:ITreeMapBranch

Returns

TreeMapNode

public function refresh():void

Forces the treemap to be redrawn.

public override function styleChanged(styleProp:String):voidParameters

styleProp:String

Event object type: fr.kapit.components.treemap.events.TreeMapEvent

Dispatched when a goup header is clicked.

Event object type: fr.kapit.components.treemap.events.TreeMapEvent

Dispatched after a drill-down on a group.

Event object type: fr.kapit.components.treemap.events.TreeMapEvent

Dispatched after a drill-up on a group.

Event object type: fr.kapit.components.treemap.events.TreeMapEvent

Dispatched when the mouse is rolled out of a group header.

Event object type: fr.kapit.components.treemap.events.TreeMapEvent

Dispatched when the mouse is rolled over a group header.

Event object type: fr.kapit.components.treemap.events.TreeMapEvent

Dispatched when a node is clicked.

Event object type: fr.kapit.components.treemap.events.TreeMapEvent

Dispatched when the mouse is rolled out of a node.

Event object type: fr.kapit.components.treemap.events.TreeMapEvent

Dispatched when the mouse is rolled over a node.

public static const COLOR_POLICY_BICHROMATIC:String = "bichromatic"

Colors are generated by mixing firstColor and secondColor.

public static const COLOR_POLICY_MONOCHROMATIC:String = "monochromatic"

Colors are generated by mixing firstColor and black.

public static const COLOR_POLICY_SPECTRUM:String = "spectrum"

Colors are generated by mixing red, green and blue colors.

public static const HIGHLIGHT_POLICY_ALL:String = "all"

Highlight filters are displayed on all nodes and all groups.

public static const HIGHLIGHT_POLICY_GROUPS:String = "groups"

Highlight filters are displayed only on groups.

public static const HIGHLIGHT_POLICY_NODES:String = "nodes"

Highlight filters are displayed only on nodes.

public static const HIGHLIGHT_POLICY_NONE:String = "none"

No highlight filters are displayed.

public static const LABEL_POLICY_ALL:String = "all"

Labels are displayed on all nodes and all groups.

public static const LABEL_POLICY_GROUPS:String = "groups"

Labels are displayed only on groups.

public static const LABEL_POLICY_NODES:String = "nodes"

Labels are displayed only on nodes.

public static const LABEL_POLICY_NONE:String = "none"

No Labels are displayed.