| Package | com.flexicious.components.charts.treemap |
| Class | public class TreeMapChart |
| Inheritance | TreeMapChart  TinyChartBase ChartBase spark.components.supportClasses.SkinnableComponent |
| Property | Defined By | ||
|---|---|---|---|
 | animate : Boolean [read-only]
Should the chart animate?
| TinyChartBase | |
| autoAdjust : Boolean = true
Whether or not to adjust the min and max values for this series so that the axis bound to this series
will pad end values to nicely distribute the numbers
| TinyChartBase | |
| backgroundEnabled : Boolean = true
Flag whether or not to draw the background
| TinyChartBase | |
| chartTitleComponent : IUIComponent
The skin part responsible for displaying the chart title
| TreeMapChart | ||
| chartType : String [read-only]
One of the following constants, on basis of which chart type this is. | ChartBase | |
| currentTip : IDataTipRenderer | TinyChartBase | |
| data : Object | ChartBase | |
| dataProvider : Object [override]
Specifies the data provider for the chart. | TinyChartBase | |
| dataTipFunction : Function
Specifies a callback method used to generate data tips from values. | ChartBase | |
| description : String
A short description of the data in the chart. | ChartBase | |
| elementsToBlur : Array [read-only] | TinyChartBase | |
| elementToCenter : IUIComponent [read-only] | TinyChartBase | |
| firstSeries : Series [read-only]
The first series
| TinyChartBase | |
| interval : Number
For IBarChart and IColumnChart support, where you have an axis, you can define a custom interval. | TinyChartBase | |
| mouseSensitivity : Number = 2
Specifies the distance, in pixels, that Flex considers a data point
to be under the mouse pointer when the pointer moves around a chart. | ChartBase | |
| numElements : int [read-only]
The number of elements in the associates skin
| ChartBase | |
| painter : TinyChartPainterBase
The default painter for this chart. | TinyChartBase | |
| rootObject : Object
For treemaps that support drill down, when you set the root object, children of this object are
used as the root of the treemap. | TreeMapChart | ||
| secondarySeries : Array
For multi series charts, you can add secondary series to this array. | TinyChartBase | |
| selectedChartItems : Array [read-only]
Specifies an array of all the selected ChartItem objects in the chart. | TinyChartBase | |
| selectionMode : String
Specifies whether or not ChartItem objects can be selected. | ChartBase | |
| series : Array
An array of Series objects that define the chart data. | TinyChartBase | |
| showDataTips : Boolean = true
Flag to show data tips for this chart
| TinyChartBase | |
| showSpinnerOnCreationComplete : Boolean | TinyChartBase | |
| spinner : ISpinner | TinyChartBase | |
| spinnerBehavior : SpinnerBehavior | TinyChartBase | |
| spinnerFactory : IFactory
Factory responsible for instantiating a new spinner. | TinyChartBase | |
| spinnerLabel : String
The label of the spinner control, you can use styles
to control the appearance. | TinyChartBase | |
| spinnerParent : Object [read-only]
The parent component to add the spinner to
| TinyChartBase | |
| threeDimensional : Boolean
Is this a 3D chart? For the 2.9 release, only bar and column charts support 3d. | TinyChartBase | |
| threeDimensionalShadowRatio : Number
If threeDimensional is set to true, the ratio of the shadow for the 3D perspective. | TinyChartBase | |
| tooltipBehavior : TooltipBehavior | TinyChartBase | |
| useElements : Boolean [read-only]
Whether to use addElement or addChild;
| ChartBase | |
| Method | Defined By | ||
|---|---|---|---|
| TreeMapChart | |||
| addElement(element:IVisualElement):IVisualElement
This method will add the passed in visual element directly into the associates skin
| ChartBase | |
| drawChart():void
This method actually draws the chart. | TinyChartBase | |
| findDataPoints(x:Number, y:Number, checkInteractivity:Boolean = false, sensitivity:int = -1):Array
Returns an array of HitData objects that describe
the nearest data point to the coordinates passed to the method. | TinyChartBase | |
| getPlotPoints(item:Object):Array
Gets all the plot points across all series for this item. | TinyChartBase | |
| hideSpinner():void | TinyChartBase | |
| invalidateChart():void
Triggers a redraw of the chart area. | TinyChartBase | |
| invalidateChartArea():void
Triggers a redraw of the chart area. | TinyChartBase | |
| invalidateChartSize():void
Triggers a redraw of the chart area. | TinyChartBase | |
| isItemSelected(item:Object, series:Series = null):Boolean
Iterates over selectedChartItems and checks to see if any chart item has specified item
selected. | TinyChartBase | |
isItemUnderMouse(item:Object, series:Series = null, first:Boolean = false):Boolean [override]
Iterates over _itemsUnderMouse and checks to see if any chart item has specified item
selected. | TreeMapChart | ||
removeElement(element:IVisualElement):IVisualElement
This method will add the passed in visual element directly into the associates skin
| TreeMapChart | ||
| showSpinner(msg:String):void | TinyChartBase | |
| Method | Defined By | ||
|---|---|---|---|
| attachSkin():void [override] | ChartBase | |
| collectionChangeHandler(event:CollectionEvent):void [override]
Collection change handler. | TinyChartBase | |
defaultDataTipFunction(hitData:HitData):String [override]
Datatip function
| TreeMapChart | ||
| measure():void [override]
| ChartBase | |
| mouseClickHandler(event:MouseEvent):void
Handler for the mouse click event. | TinyChartBase | |
| mouseDoubleClickHandler(event:MouseEvent):void
Handler for the double click event. | TinyChartBase | |
| mouseDownHandler(event:MouseEvent):void
Handler for the mouse down event. | TinyChartBase | |
| mouseMoveHandler(event:MouseEvent):void | TinyChartBase | |
| mouseOutHandler(event:MouseEvent):void
Handler for the mouse out event. | TinyChartBase | |
| mouseUpHandler(event:MouseEvent):void
Handler for the mouse over event. | TinyChartBase | |
onChartClick(event:ChartEvent):void | TreeMapChart | ||
| onCreationComplete(event:FlexEvent):void [override] | TinyChartBase | |
onItemClick(event:ChartItemEvent):void | TreeMapChart | ||
| onResize(event:ResizeEvent):void [override] | TinyChartBase | |
| chartTitleComponent | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var chartTitleComponent:IUIComponentThe skin part responsible for displaying the chart title
| rootObject | property |
rootObject:ObjectFor treemaps that support drill down, when you set the root object, children of this object are used as the root of the treemap. Otherwise, we use the top level dataprovider
This property can be used as the source for data binding.
public function get rootObject():Object public function set rootObject(value:Object):void| TreeMapChart | () | Constructor |
public function TreeMapChart()| defaultDataTipFunction | () | method |
override protected function defaultDataTipFunction(hitData:HitData):StringDatatip function
Parameters
hitData:HitData |
String —
|
| isItemUnderMouse | () | method |
override public function isItemUnderMouse(item:Object, series:Series = null, first:Boolean = false):BooleanIterates over _itemsUnderMouse and checks to see if any chart item has specified item selected.
Parameters
item:Object | |
series:Series (default = null) | |
first:Boolean (default = false) |
Boolean |
| onChartClick | () | method |
| onItemClick | () | method |
| removeElement | () | method |
public function removeElement(element:IVisualElement):IVisualElementThis method will add the passed in visual element directly into the associates skin
Parameters
element:IVisualElement |
IVisualElement |