| Package | com.flexicious.components.charts.treemap |
| Class | public class TreeMapSeries |
| Inheritance | TreeMapSeries  DividedSeries Series mx.styles.CSSStyleDeclaration |
| Property | Defined By | ||
|---|---|---|---|
 | baseAtZero : Boolean
Specifies whether Flex tries to keep the minimum
and maximum values rooted at zero. | Series | |
| borderColor : uint = 0x3c3c3c
The border color for the chart and each of the tiles
| TreeMapSeries | ||
| borderWidth : int = 2
Width of the border around each tile
| TreeMapSeries | ||
| calculatedMinMaxSum : Array
Calculated result of the minmaxsum function. | Series | |
| chart : TinyChartBase | Series | |
| chartRoot : Object = null
The object that is the root of the chart. | TreeMapSeries | ||
| childrenField : String
The property of the parent level object, that identifies the children that should be displayed on the next level. | TreeMapSeries | ||
| colorBase : uint = 0x02e48c
The base color used for the tile
| TreeMapSeries | ||
| colorField : String
For heat maps, we use the value of this field to come up with the color
| TreeMapSeries | ||
| colorWeightFunction : Function
A function that returns the weight of the item o calculate the color. | TreeMapSeries | ||
| dataFunction : Function
Specifies a method that returns the value that should be used for
positioning the current chart item in the series. | Series | |
| dataPropertyName : String [override] | TreeMapSeries | ||
| dataTipRenderer : IFactory
Renderer for the data tip. | Series | |
| displayName : String
The name of the series, for display to the user. | Series | |
| enabledFunction : Function
Given an item, returns the color for its renderer (line, or column)
| Series | |
| field : String
Specifies the field of the data provider that determines
the data for each wedge of the PieChart control. | DividedSeries | |
| getChildrenFunction : Function = null
This function basically gives you the opportunity to tie in to the grids hierarchy lookup mechanism. | TreeMapSeries | ||
| headerHeight : int = 20
The height of the header row. | TreeMapSeries | ||
| interactive : Boolean
Determines whether data tips appear when users interact
with chart data on the screen. | Series | |
| interval : Number
The minimum value for the color field
| TreeMapSeries | ||
| isSecondary : Boolean = false
Is this a secondary series (not used to render the axes), used
by Multi Series Charts. | Series | |
| itemFillFunction : Function = null
Given an item, returns the color for its renderer (line, or column) . | Series | |
| itemLineColorFunction : Function = null
Given an item, returns the color for its line (or border for its fill) . | Series | |
| labelColor : uint = 0x000000
The border color for the chart and each of the tiles
| TreeMapSeries | ||
| labelColorAdjustment : int = 0
The amount by which to brighten the label. | TreeMapSeries | ||
| labelColorFunction : Function
Color of the labels associated with each plot point. | TreeMapSeries | ||
| labelFactory : IFactory
Factory class creating all the labels. | TreeMapSeries | ||
| labelField : String
This is the same as name field, not sure why Adobe did not call it
the labelField to begin with, since that is the naming convention
used elsewhere in the SDK. | DividedSeries | |
| labelFunction : Function
Specifies a callback function used to render each label
of the Series. | Series | |
| labelPropertyName : String [override] [read-only]
Returns the attribute on the series that returns the data field on the dataprovider. | DividedSeries | |
| labelStyleName : String
This is the style name applied to labels that are drawn on top of individual datapoints
For now this is supported for 3d Pie, Funnel and Pyramid Charts, since they are the only ones
that draw a label on top of the individual data points. | Series | |
| maxDepth : int = 2.147483647E9
The maximum depth to draw. | TreeMapSeries | ||
| maxSquares : Number = 100
Dont draw more than these many child tiles. | TreeMapSeries | ||
| maxValue : Number
The minimum value for the color field
| TreeMapSeries | ||
| minHeightForLabel : int = 20
A height of the square below which to not show labels
| TreeMapSeries | ||
| minMaxSumFunction : Function
PLEASE NOTE: Starting 2.10 this function is deprecated. | Series | |
| minMaxSumIntervalFunction : Function
Returns an array of 4 values. | Series | |
| minValue : Number
The minimum value for the color field
| TreeMapSeries | ||
| minWidthForLabel : int = 30
A width of the square below which to not show labels
| TreeMapSeries | ||
| nameField : String
Specifies the field of the data provider that determines
the name of each wedge of the PieChart control. | DividedSeries | |
| painter : TinyChartPainterBase
The painter responsible for painting the series. | Series | |
| parentField : String
A property that points to the parent object
Used in conjunction with enableSelectionBubble property on the grid. | TreeMapSeries | ||
| plotPoints : Array
A list of plot points we calculated to render this series
| Series | |
| selectable : Boolean
Specifies whether a series is selectable or not. | Series | |
| selectedIndex : int
Index of the selected item in the data provider of the series. | Series | |
| selectedIndices : Array
An Array of indexes of the selected items in the data provider of the series. | Series | |
| selectedItem : ChartItem
The chart item that is selected in the series. | Series | |
| selectedItems : Array
An Array of chart items that are selected in the series. | Series | |
| seriesIndex : int = 0
The index of this series within the charts series collection. | Series | |
| showDataTips : Boolean
Whether or not to show data tips on mouse over
| Series | |
| treemapSeries : TreeMapSeries [read-only] | TreeMapSeries | ||
| useRollover : Boolean
Flag to show a different color for the bar/area that the user has rolled over. | Series | |
| weightField : String
The field on the dataprovider that determines how big the square should be. | TreeMapSeries | ||
| weightFunction : Function
A function that returns the weight of the item to calulate the area. | TreeMapSeries | ||
| Method | Defined By | ||
|---|---|---|---|
| TreeMapSeries | |||
| calculateSteps(minValue:Number, maxValue:Number, sum:Number):Array | Series | |
| defaultDataFunction(series:Series, item:Object, fieldName:String):* [static] | Series | |
getChildren(object:Object):Object
If the dataprovider is IHierarchicalCollectionView, calls the getChildren method on the incoming object. | TreeMapSeries | ||
| getFillForLegend():IFill
Gets the fill associated with this item for this series. | Series | |
| getItemFill(item:Object):IFill
First, checks to see if item is disabled, then returns disabled color style value, if one defined for the series, other wise the one defined for the chart. | Series | |
| getItemLineColor(item:Object):IFill | Series | |
| getLabelForLegend():String
Gets the label associated with this item for this series. | Series | |
getParent(object:Object):Object
Returns the parent object for the passed in object. | TreeMapSeries | ||
| getPlotPoint(item:Object):PlotPoint
Gets the plot point for this item in this series before this one. | Series | |
|
Gets the series before this one. | Series | |
| getStyleValue(prop:String):Object
If a style is defined on this series with a valid value, returns it from the series
style declaration otherwise, returns it from the chart's style declaration. | Series | |
| handleMouseClick(event:MouseEvent, clickedItem:HitData):void
Handles the click. | Series | |
| borderColor | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var borderColor:uint = 0x3c3c3cThe border color for the chart and each of the tiles
| borderWidth | property |
public var borderWidth:int = 2Width of the border around each tile
| chartRoot | property |
public var chartRoot:Object = nullThe object that is the root of the chart. When user clicks on a child node, it becoms the root
| childrenField | property |
childrenField:StringThe property of the parent level object, that identifies the children that should be displayed on the next level. This is only required if the collection is not a hierarchical view. Please note, in server mode, this property is also the "storage" for the lazy loaded children. See the Partially and Lazy Loaded Server Grid examples for more details
public function get childrenField():String public function set childrenField(value:String):void| colorBase | property |
public var colorBase:uint = 0x02e48cThe base color used for the tile
| colorField | property |
colorField:StringFor heat maps, we use the value of this field to come up with the color
public function get colorField():String public function set colorField(value:String):void| colorWeightFunction | property |
public var colorWeightFunction:FunctionA function that returns the weight of the item o calculate the color.
| dataPropertyName | property |
dataPropertyName:String[override] public function get dataPropertyName():String public function set dataPropertyName(value:String):void| getChildrenFunction | property |
public var getChildrenFunction:Function = nullThis function basically gives you the opportunity to tie in to the grids hierarchy lookup mechanism. By default, the grid will call the getChildren method on this class to get the children of any object when it is time to draw the hierarchy. By defining a custom getChildrenFunction, you can intercept this mechanism to provide your own implementation of retrieving children. The signature of this function should be like below: getChildren(object:Object):Object
| headerHeight | property |
public var headerHeight:int = 20The height of the header row.
| interval | property |
interval:NumberThe minimum value for the color field
This property can be used as the source for data binding.
public function get interval():Number public function set interval(value:Number):void| labelColor | property |
public var labelColor:uint = 0x000000The border color for the chart and each of the tiles
| labelColorAdjustment | property |
public var labelColorAdjustment:int = 0The amount by which to brighten the label. Gets applied to the calculated color value.
| labelColorFunction | property |
public var labelColorFunction:FunctionColor of the labels associated with each plot point.
| labelFactory | property |
public var labelFactory:IFactoryFactory class creating all the labels.
| maxDepth | property |
public var maxDepth:int = 2.147483647E9The maximum depth to draw.
| maxSquares | property |
public var maxSquares:Number = 100Dont draw more than these many child tiles.
| maxValue | property |
maxValue:NumberThe minimum value for the color field
This property can be used as the source for data binding.
public function get maxValue():Number public function set maxValue(value:Number):void| minHeightForLabel | property |
public var minHeightForLabel:int = 20A height of the square below which to not show labels
| minValue | property |
minValue:NumberThe minimum value for the color field
This property can be used as the source for data binding.
public function get minValue():Number public function set minValue(value:Number):void| minWidthForLabel | property |
public var minWidthForLabel:int = 30A width of the square below which to not show labels
| parentField | property |
parentField:StringA property that points to the parent object Used in conjunction with enableSelectionBubble property on the grid.
public function get parentField():String public function set parentField(value:String):void| treemapSeries | property |
treemapSeries:TreeMapSeries [read-only] public function get treemapSeries():TreeMapSeries| weightField | property |
weightField:StringThe field on the dataprovider that determines how big the square should be.
public function get weightField():String public function set weightField(value:String):void| weightFunction | property |
public var weightFunction:FunctionA function that returns the weight of the item to calulate the area.
| TreeMapSeries | () | Constructor |
public function TreeMapSeries()| getChildren | () | method |
public function getChildren(object:Object):ObjectIf the dataprovider is IHierarchicalCollectionView, calls the getChildren method on the incoming object. If object is XMLList or XML, returns the result of its "children" method. Else returns the value of the level.childrenField property on the object being passed in Prior to returning, applies filter, page or sort as specified by the parameters. You can intercept calls to this function by defining a custom getChildrenFunction
Parameters
object:Object |
Object |
| getParent | () | method |
public function getParent(object:Object):ObjectReturns the parent object for the passed in object. Please note, if your data provider is xml or hierarchical collection view, grid will use the getParent method or getParentItem method on such data providers respectively. If you have specified a parentField, which is a pointer on the object that points back to the parent, the grid will use that. If none of the above is true, the grid will use its built in map of hierarchical data, but this has a limitation of only being able to return parents of items that are on the current page of data.
Parameters
object:Object |
Object |