branchDataTipField:String  [read-write]

The name of the field in the data provider items to display as the datatip of the branch data renderer.

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

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

branchDataTipFunction:Function  [read-write]

A user-supplied function to run on each branch to determine its datatip.

The datatip function takes one argument, the item in the data provider. It returns a String.

dataTipFunction(item:Object):String

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

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

branchesSelectable:Boolean  [read-write]

Indicates if the node's within the TreeMap can be selected by the user.

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

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

branchLabelField:String  [read-write]

The name of the field in the data provider branches to display as the label of the data renderer. If both branchLabelField and branchLabelFunction are null, then the standard labelField and labelFunction properties will be used.

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

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

See also

branchLabelFunction:Function  [read-write]

A user-supplied function to run on each branch to determine its label.

The branch label function takes one argument, the item in the data provider. It returns a String.

branchLabelFunction(item:Object):String

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

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

See also

branchRenderer:IFactory  [read-write]

The custom branch renderer for the control. You can specify a drop-in, inline, or custom branch renderer. Unlike the renderers used by Tree components, nodes and branches in a TreeMap are quite different visually and functionally. As a result, it's easier to specify and customize seperate renderers for either type.

The default branch renderer is TreeMapBranchRenderer.

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

Implementation
    public function get branchRenderer():IFactory
    public function set branchRenderer(value:IFactory):void

colorField:String  [read-write]

The name of the field in the data provider items to use as the color.

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

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

colorFunction:Function  [read-write]

A user-supplied function to run on each item to determine its color.

The color function takes one argument, the item in the data provider. It returns a uint.

colorFunction(item:Object):uint

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

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

dataDescriptor:ITreeDataDescriptor  [read-write]

Returns the current ITreeDataDescriptor.

The default value is DefaultDataDescriptor.

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

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

dataProvider:Object  [read-write]

An object that contains the data to be displayed. When you assign a value to this property, the TreeMap class handles the source data object as follows:

• A String containing valid XML text is converted to an XMLListCollection.
• An XMLNode is converted to an XMLListCollection.
• An XMLList is converted to an XMLListCollection.
• Any object that implements the ICollectionView interface is cast to an ICollectionView.
• An Array is converted to an ArrayCollection.
• Any other type object is wrapped in an Array with the object as its sole entry.

The default value is an empty ArrayCollection.

Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void

dataTipField:String  [read-write]

The name of the field in the data provider items to display as the datatip of the data renderer.

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

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

dataTipFunction:Function  [read-write]

A user-supplied function to run on each item to determine its datatip.

The datatip function takes one argument, the item in the data provider. It returns a String.

dataTipFunction(item:Object):String

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

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

hasRoot:Boolean  [read-only]

Indicates that the current dataProvider has a root item; for example, a single top node in a hierarchical structure. XML and Object are examples of types that have a root. Lists and arrays do not.

Implementation
    public function get hasRoot():Boolean

See also

labelField:String  [read-write]

The name of the field in the data provider items to display as the label of the data renderer. If the item is a branch, the treemap will first check to see whether branchLabelField or branchLabelFunction are defined.

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

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

See also

labelFunction:Function  [read-write]

A user-supplied function to run on each item to determine its label.

The label function takes one argument, the item in the data provider. It returns a String.

labelFunction(item:Object):String

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

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

See also

layoutStrategy:ITreeMapLayoutStrategy  [read-write]

The custom layout algorithm for the control.

The default alogrithm is Squarify.

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

Implementation
    public function get layoutStrategy():ITreeMapLayoutStrategy
    public function set layoutStrategy(value:ITreeMapLayoutStrategy):void

leafRenderer:IFactory  [read-write]

The custom leaf renderer for the control. You can specify a drop-in, inline, or custom leaf renderer.

The default node renderer is TODO.

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

Implementation
    public function get leafRenderer():IFactory
    public function set leafRenderer(value:IFactory):void

maxDepth:int  [read-write]

If value is >= 0, the treemap will only render branches to a specific depth.

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

Implementation
    public function get maxDepth():int
    public function set maxDepth(value:int):void

selectable:Boolean  [read-write]

Indicates if the node's within the TreeMap can be selected by the user.

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

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

selectedItem:Object  [read-write]

The currently selected item.

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

Implementation
    public function get selectedItem():Object
    public function set selectedItem(value:Object):void

showRoot:Boolean  [read-write]

Sets the visibility of the root item. If the dataProvider data has a root node, and this is set to false, the TreeMap control does not display the root item. Only the decendants of the root item are displayed. This flag has no effect on non-rooted dataProviders, such as List and Array.

The default value is true.

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

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

See also

weightField:String  [read-write]

The name of the field in the data provider items to use in weight calculations.

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

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

weightFunction:Function  [read-write]

A user-supplied function to run on each item to determine its weight.

The weight function takes one arguments, the item in the data provider. It returns a Number.

weightFunction(item:Object):Number

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

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

zoomedBranch:Object  [read-write]

The currently zoomed branch.

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

Implementation
    public function get zoomedBranch():Object
    public function set zoomedBranch(value:Object):void

zoomEnabled:Boolean  [read-write]

If true, branches may be zoomed in (maximized) to display in the full bounds of the treemap.

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

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

zoomOutType:String  [read-write]

Determines the way that zoom out actions work. Values are defined by the constants in the TreeMapZoomOutType class.

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

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

public function TreeMap()

Constructor.

public function itemIsRoot(item:Object):Boolean

Determines if an item is the root node

Parameters

item:Object — the data for which to check against the root

Returns

Boolean — true if the item is the root data, false if not

public function itemToColor(item:Object):uint

Determines the color value for an item from the data provider. If color not available, returns the value of the itemDefaultColor style. The default value of this style is black (0x000000).

Parameters

item:Object — The item from the data provider for which to generate the color.

Returns

uint — The item's color

public function itemToDataTip(item:Object):String

Determines the datatip text for an item from the data provider. If no datatip is specified, returns an empty string.

Parameters

item:Object — The item from the data provider for which to generate the data tip.

Returns

String — The item's data tip

public function itemToItemRenderer(item:Object):ITreeMapItemRenderer

Returns the item renderer that displays specific data.

Parameters

item:Object — the data for which to find a matching item renderer

Returns

ITreeMapItemRenderer — the item renderer that matches the data

public function itemToLabel(item:Object):String

Determines the label text for an item from the data provider. If no label is specified, returns the result of the item's toString() method. If item is null, returns an empty string.

The label is derived from the labelField and labelFunction properties. The labelFunction takes precedence. If it is null, then labelField is used. As a special case, if the item is a branch, and either branchLabelField or branchLabelFunction is defined, then those values take precedence over the standard labelField and labelFunction values.

Parameters

item:Object — The item from the data provider for which to generate the label.

Returns

String — The item's label

protected function itemToUID(item:Object):String

Determines the UID for a data provider item. All items in a data provider must either have a unique ID (UID) or one will be generated and associated with it. This means that you cannot have an object or scalar value appear twice in a data provider. For example, the following data provider is not supported because the value "foo" appears twice and the UID for a string is the string itself

var sampleDP:Array = ["foo", "bar", "foo"]

Simple dynamic objects can appear twice if they are two separate instances. The following is supported because each of the instances will be given a different UID because they are different objects.

var sampleDP:Array = [{label: "foo"}, {label: "foo"}]

Note that the following is not supported because the same instance appears twice.

var foo:Object = {label: "foo"}; sampleDP:Array = [foo, foo];

Parameters

item:Object — The data provider item

Returns

String — The UID as a string

public function itemToWeight(item:Object):Number

Determines the weight value for an item from the data provider.

Parameters

item:Object — The item from the data provider for which to generate the weight.

Returns

Number — The item's weight

Event object type: flash.events.Event

Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction.

Event object type: com.flextoolbox.events.TreeMapEvent

Dispatched when the user clicks on a leaf item in the control.

Event object type: com.flextoolbox.events.TreeMapEvent

Dispatched when the user double-clicks on a leaf item in the control.

Event object type: com.flextoolbox.events.TreeMapEvent

Dispatched when the user rolls the mouse pointer out of a leaf item in the control.

Event object type: com.flextoolbox.events.TreeMapEvent

Dispatched when the user rolls the mouse pointer over a leaf item in the control.