org.juicekit.visual.controls.TreeMapControl

	Property	Defined by
		colorEncodingField : String Specifies a data `Object` property's name used to encode a treemap rectangle's color.	TreeMapControl
		data : Object Sets the data value to a `Tree` data object used for rendering the size and color attributes of the treemap visualization.	TreeMapControl
		dataRoot : NodeSprite Sets the a data set's `root` reference to the `nodeSprite` parameter.	TreeMapControl
		extraOperators : Array Extra operators to include in the visualization.	TreeMapControl
		freezeColors : Boolean	TreeMapControl
		freezeColorsOnDataChange : Boolean = false Recalculate the color range when the data changes.	TreeMapControl
		freezeColorsOnDataRootChange : Boolean = true Freeze the color range when the data root changes.	TreeMapControl
		highlightRollOver : Boolean = true Specifies whether the TreeMapControl should provide a highlighting effect on mouse roll-over.	TreeMapControl
		labelEncodingField : String Specifies a data `Object` property's name used to encode a treemap rectangle's label.	TreeMapControl
		listData : BaseListData Implement the IDropInListItemRenderer interface.	RendererBase
		maxLabelDepth : int Sets the maximum hierarchy depth that labels will be applied to the visualization's rectangles.	TreeMapControl
		minLabelDepth : int Sets the minimum hierarchy depth that labels will be applied to the visualization's rectangles.	TreeMapControl
		nodeFlashFilters : Array	TreeMapControl
		sizeEncodingField : String Specifies a data `Object` property's name used to encode a treemap rectangle's visual size.	TreeMapControl
		styleFromDataRoot : Boolean = false Are node line width and line color (strokeColors, strokeThickness, strokeAlpha) styling based the depth from the data root or from the base of the tree.	TreeMapControl
		transitionPeriod : Number Specifies the animation transition time period in seconds.	FlareControlBase
		truncateToFit : Boolean Specifies whether label strings should be truncated to fit within its rectangle's width.	TreeMapControl
		vis : Visualization = null Stores reference to the prefuse.flare `Visualization` context.	FlareControlBase

	Property	Defined by
		colorPalette : ColorPalette [read-only] Return a color palette for interpolating color values from the `colorEncodingField`'s data value.	TreeMapControl
		dataPropertyChanged : Boolean = false Indicated whether the data property was changed.	RendererBase

	Method	Defined by
		TreeMapControl() Constructor.	TreeMapControl
		getColorEncoder():ColorEncoder Get the Flare ColorEncoder	TreeMapControl
		setColorScaleRange(min:Number, max:Number):void Sets a specific numeric range used to map `data` values to color values where data values less than `min` are mapped to `minEncodedColor` and data values greater than `max` are mapped to `maxEncodedColor`.	TreeMapControl
		unsetColorScaleRange():void Forces the color mapping range to be determined by the minimum and maximum `data` values.	TreeMapControl

	Method	Defined by
		addEventListeners():void Add any event listeners to the `Visualization` instance.	FlareControlBase
		asFlareProperty(propertyName:String):String Return a flare-style data property string.	FlareControlBase
		calcPaddedBounds(w:Number, h:Number):Rectangle Calculates a `Rectangle` inset by any padding styles.	FlareControlBase
		commitProperties():void Reset the `dataPropertyChanged` and invalidate the display list.	RendererBase
		initVisualization():void Initialize the control's prefuse.flare `Visualization` instance.	FlareControlBase
		makeVisualization():Visualization Create a prefuse.flare `Visualization` instance.	FlareControlBase
		numToAlphaBits(alpha:Number):uint [static] Helper function to produce high-order alpha bits from a Number ranging from 0.0 to 1.0 inclusive.	FlareControlBase
		onMouseOut(event:MouseEvent):void Handle mouse out events.	TreeMapControl
		onMouseOver(event:MouseEvent):void Handle mouse over events.	TreeMapControl
		removeEventListeners():void Remove any event listeners from the `Visualization` instance.	FlareControlBase
		signalDataMouseEvent(event:MouseEvent):void Dispatch `DataMouseEvent` events.	FlareControlBase
		toARGB(rgbColor:uint, alpha:Number):uint [static] Convert an RGB color value and alpha specification into a flare compatible ARGB color value.	FlareControlBase
		updateVisualization():void Call the `update` method on the visualization.	FlareControlBase

Summary	Defined by
dataChange	Dispatched when the `data` property changes.	RendererBase
end	Dispatched when an animating `Visualization` update completes the animation `Transition`	FlareControlBase
jkDataClick	Dispatched when the user clicks a pointing device over a `TreemapControl` instance's rectangle.	FlareControlBase
jkDataDoubleClick	Dispatched when the user clicks a pointing device over a `TreemapControl` instance's rectangle.	FlareControlBase
jkDataMouseOut	Dispatched when the user moves a pointing device away from `TreemapControl` instance's rectangle.	FlareControlBase
jkDataMouseOver	Dispatched when the user moves a pointing device over a `TreemapControl` instance's rectangle.	FlareControlBase
start	Dispatched when an animating `Visualization` update begins the animation `Transition`	FlareControlBase

Styles

	Description	Defined by
backgroundColor	Type: uint Format: Color CSS Inheritance: no Specifies the opaque background color of the control.	FlareControlBase
encodedColorAlpha	Type: Number CSS Inheritance: no Determines the alpha transparency value for rectangle colors. The default value is `1.0`.	TreeMapControl
fontColor	Type: uint Format: Color CSS Inheritance: no Sets the color of text. The default value is `0x000000`.	TreeMapControl
fontFamily	Type: String CSS Inheritance: yes Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is `"Verdana"`.	TreeMapControl
fontSize	Type: Number Format: Length CSS Inheritance: yes Sets the height of the text, in pixels. The default value is `10`.	TreeMapControl
fontStyle	Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are `"normal"` and `"italic"`. The default value is `"normal"`.	TreeMapControl
fontWeight	Type: String CSS Inheritance: yes Determines whether the text is boldface. Recognized values are `"normal"` and `"bold"`. The default value is `"normal"`.	TreeMapControl
labelColorStrategy	Type: String CSS Inheritance: no Possible labelColorStrategy values are: `blackwhite` adaptively choose black or white depending on the background color, `glow` apply a white glow around letters or `none` don't apply any effect. Deprecation warning: This default will be changed to `blackwhite` in JuiceKit 2.0. The default value is `"glow"`.	TreeMapControl
maxEncodedColor	Type: uint Format: Color CSS Inheritance: no Determines the fill color for rectangles near the maximum of a range of data values. The default value is `0x00FF00`.	TreeMapControl
midEncodedColor	Type: uint Format: Color CSS Inheritance: no Determines the fill color for rectangles near the middle of a range of data values. The default value is `0x000000`.	TreeMapControl
minEncodedColor	Type: uint Format: Color CSS Inheritance: no Determines the fill color for rectangles near the minimum of a range of data values. The default value is `0xFF0000`.	TreeMapControl
paddingBottom	Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's bottom border and the bottom edge of its content area.	FlareControlBase
paddingLeft	Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area.	FlareControlBase
paddingRight	Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area.	FlareControlBase
paddingTop	Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's top border and the top edge of its content area.	FlareControlBase
palette	Type: String CSS Inheritance: yes Determines the color palette to use Possible values are `"hot"`, `"cool"`, `"summer"`, `"winter"`, `"spring"` `"autumn"`, `"bone"`, `"copper"` or `"pink"`. The default value is `"spectral"`.	TreeMapControl
strokeAlphas	Type: Array CSS Inheritance: no Determines the alpha transparency values for rectangle strokes. The first array alpha value maps to the first level of data in the data tree, the second alpha value maps to second level of data in the data tree, and so forth. Any data levels deeper than the array has elements use the last element to determine alpha value. The default value is `[1.0]`.	TreeMapControl
strokeColors	Type: Array Format: Color CSS Inheritance: no Each array element determines the color of the rectangles' stroke at a given depth in the data tree. The first array stroke color maps to the first level of data in the data tree, the second array stroke color maps to second level of data in the data tree, and so forth. Any data levels deeper than the array has elements use the last element to determine stroke color. For example, `[0x00000000, 0xffFFFFFF]` specifies that the root rectangle does not have a stroke color but all subsequent data depths have a opaque white stroke. The default value is `[0x00000000]`.	TreeMapControl
strokeThicknesses	Type: Array Format: Length CSS Inheritance: no Each array element determines the thickness of the rectangles' stroke at a given depth in the data tree. The first array stroke thickness maps to the first level of data in the data tree, the second array stroke thickness maps to second level of data in the data tree, and so forth. Any data levels deeper than the array has elements use the last element to determine stroke thickness. For example, `[0, 1.0]` specifies that the root rectangle does not have a stroke thickness but all subsequent data depths have a 1-pixel stroke thickness. Determines the thickness of the rectangles' stroke. The default value is `[0]`.	TreeMapControl
textAlign	Type: String CSS Inheritance: yes Determines the horizontal alignment of text within the cell. Possible values are `"left"`, `"center"`, or `"right"`. The default value is `"left"`.	TreeMapControl
textPosition	Type: String CSS Inheritance: yes Determines the vertical position of text within the cell. Possible values are `"top"`, `"middle"`, or `"bottom"`. The default value is `"top"`.	TreeMapControl

Property detail

colorEncodingField

property

colorEncodingField:String [read-write]

Specifies a data Object property's name used to encode a treemap rectangle's color.

The default value is "color".

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

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

colorPalette

property

colorPalette:ColorPalette [read-only]

Return a color palette for interpolating color values from the colorEncodingField's data value.

Implementation
protected function get colorPalette():ColorPalette

data

property

data:Object [read-write]

Sets the data value to a Tree data object used for rendering the size and color attributes of the treemap visualization.

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

See also

flare.vis.data.Tree

dataRoot

property

dataRoot:NodeSprite [read-write]

Sets the a data set's root reference to the nodeSprite parameter.

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

Implementation
public function get dataRoot():NodeSprite
public function set dataRoot(value:NodeSprite):void

extraOperators

property

extraOperators:Array [read-write]

Extra operators to include in the visualization.

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

freezeColors

property

freezeColors:Boolean  [read-write]Implementation
    public function get freezeColors():Boolean
    public function set freezeColors(value:Boolean):void

freezeColorsOnDataChange

property

public var freezeColorsOnDataChange:Boolean = false

Recalculate the color range when the data changes. If true, colors will be frozen when the data changes. If false, the color scale will be recalculated when the data changes.

The default value is false.

freezeColorsOnDataRootChange

property

public var freezeColorsOnDataRootChange:Boolean = true

Freeze the color range when the data root changes. If true, colors will be frozen when the data root changes. If false, colors will be unfrozen and the color scale will be recalculated when the data root changes.

The default value is true.

highlightRollOver

property

public var highlightRollOver:Boolean = true

Specifies whether the TreeMapControl should provide a highlighting effect on mouse roll-over. The effect is to increase the brightness of the rectangle color.

The default value is true.

labelEncodingField

property

labelEncodingField:String [read-write]

Specifies a data Object property's name used to encode a treemap rectangle's label.

The default value is "label".

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

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

maxLabelDepth

property

maxLabelDepth:int [read-write]

Sets the maximum hierarchy depth that labels will be applied to the visualization's rectangles. The default is -1 indicating there is no maximum.

The default value is -1.

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

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

minLabelDepth

property

minLabelDepth:int [read-write]

Sets the minimum hierarchy depth that labels will be applied to the visualization's rectangles. The default is -1 indicating there is no minimum.

The default value is -1.

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

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

nodeFlashFilters

property

nodeFlashFilters:Array  [read-write]Implementation
    public function get nodeFlashFilters():Array
    public function set nodeFlashFilters(value:Array):void

sizeEncodingField

property

sizeEncodingField:String [read-write]

Specifies a data Object property's name used to encode a treemap rectangle's visual size.

The default value is "size".

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

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

styleFromDataRoot

property

public var styleFromDataRoot:Boolean = false

Are node line width and line color (strokeColors, strokeThickness, strokeAlpha) styling based the depth from the data root or from the base of the tree.

truncateToFit

property

truncateToFit:Boolean [read-write]

Specifies whether label strings should be truncated to fit within its rectangle's width.

The default value is false.

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

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

Constructor detail

TreeMapControl

()

constructor

public function TreeMapControl()

Constructor.

Method detail

getColorEncoder

()

method

public function getColorEncoder():ColorEncoder

Get the Flare ColorEncoder

Returns

ColorEncoder

onMouseOut

()

method

protected override function onMouseOut(event:MouseEvent):void

Handle mouse out events.

Parameters

event:MouseEvent

onMouseOver

()

method

protected override function onMouseOver(event:MouseEvent):void

Handle mouse over events.

Parameters

event:MouseEvent

setColorScaleRange

()

method

public function setColorScaleRange(min:Number, max:Number):void

Sets a specific numeric range used to map data values to color values where data values less than min are mapped to minEncodedColor and data values greater than max are mapped to maxEncodedColor.

Parameters

	`min:Number` — Contains the smallest data value to encode to a color.

	`max:Number` — Contains the largest data value to encode to a color.

unsetColorScaleRange

()

method

public function unsetColorScaleRange():void

Forces the color mapping range to be determined by the minimum and maximum data values. This is the default algorithm for TreeMapControl instances.

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class TreeMapControl	Properties \| Methods \| Events \| Styles

Package	org.juicekit.visual.controls
Class	public class TreeMapControl
Inheritance	TreeMapControl FlareControlBase RendererBase mx.core.UIComponent