Package | com.flexicious.components.tinycharts |
Class | public class TinyChartBase |
Inheritance | TinyChartBase ChartBase spark.components.supportClasses.SkinnableComponent |
Implements | ISpinnerOwner |
Subclasses | CartesianChart, PyramidChart, TinyBarChart, TinyColumnChart, TinyDividedBarChart, TinyDividedColumnChart, TinyLineChart, TinyPieChart, TreeMapChart |
Language Version : | ActionScript 3.0 |
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 | ||
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 | ||
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 | ||
---|---|---|---|
The constructor
| TinyChartBase | ||
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
Iterates over _itemsUnderMouse and checks to see if any chart item has specified item
selected. | TinyChartBase | ||
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
Datatip function
| TinyChartBase | ||
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 | ||
onCreationComplete(event:FlexEvent):void [override] | TinyChartBase | ||
onResize(event:ResizeEvent):void [override] | TinyChartBase |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the selection changes in the chart. | TinyChartBase | |||
Dispatched when no data point is found under the mouse pointer when mouse is clicked on chart. | TinyChartBase | |||
Dispatched when no data point is found under the mouse pointer when mouse is double-clicked on chart. | TinyChartBase | |||
Dispatched when the ICollectionView has been updated in some way. | ChartBase | |||
Dispatched when a data point is found under the mouse pointer when it is clicked. | TinyChartBase | |||
Dispatched when a data point is found under the mouse pointer when it is double clicked. | TinyChartBase | |||
Dispatched when a data point is found under the mouse pointer when it is pressed down. | TinyChartBase | |||
Dispatched when the mouse pointer moves while over a data point. | TinyChartBase | |||
Dispatched when a data point is found under the mouse pointer when it is released. | TinyChartBase | |||
Dispatched when the closest data point under the mouse pointer changes. | TinyChartBase | |||
Dispatched when a new data point is found under the mouse pointer. | TinyChartBase |
Constant | Defined By | ||
---|---|---|---|
CHART_TYPE_AREA : String = area [static] | TinyChartBase | ||
CHART_TYPE_BAR : String = bar [static] | TinyChartBase | ||
CHART_TYPE_BUBBLE : String = bubble [static] | TinyChartBase | ||
CHART_TYPE_COLUMN : String = column [static] | TinyChartBase | ||
CHART_TYPE_DIVIDED_BAR : String = dividedbar [static] | TinyChartBase | ||
CHART_TYPE_DIVIDED_COLUMN : String = dividedcolumn [static] | TinyChartBase | ||
CHART_TYPE_FUNNEL : String = funnel [static] | TinyChartBase | ||
CHART_TYPE_LINE : String = line [static] | TinyChartBase | ||
CHART_TYPE_PIE : String = pie [static] | TinyChartBase | ||
CHART_TYPE_PYRAMID : String = pyramid [static] | TinyChartBase | ||
CHART_VARTIAION_TYPE_100PERCENT : String = 100% [static] | TinyChartBase | ||
CHART_VARTIAION_TYPE_CLUSTERED : String = clustered [static] | TinyChartBase | ||
CHART_VARTIAION_TYPE_OVERLAID : String = overlaid [static] | TinyChartBase | ||
CHART_VARTIAION_TYPE_STACKED : String = stacked [static] | TinyChartBase | ||
seriesColors : Array [static]
Default list of colors for series. | TinyChartBase |
animate | property |
animate:Boolean
[read-only] Should the chart animate?
This property can be used as the source for data binding.
public function get animate():Boolean
autoAdjust | property |
public var 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
backgroundEnabled | property |
public var backgroundEnabled:Boolean = true
Flag whether or not to draw the background
currentTip | property |
public var currentTip:IDataTipRenderer
dataProvider | property |
dataProvider:Object
[override] Specifies the data provider for the chart.
This property can accept an array or any other object that implements the IList or ICollectionView interface.
public function get dataProvider():Object
public function set dataProvider(value:Object):void
elementsToBlur | property |
elementsToBlur:Array
[read-only] public function get elementsToBlur():Array
elementToCenter | property |
elementToCenter:IUIComponent
[read-only] public function get elementToCenter():IUIComponent
firstSeries | property |
firstSeries:Series
[read-only] The first series
public function get firstSeries():Series
interval | property |
public var interval:Number
For IBarChart and IColumnChart support, where you have an axis, you can define a custom interval. IF you set autoAdjust=false and specify an interval, that interval will be used between min and max values.
painter | property |
public var painter:TinyChartPainterBase
The default painter for this chart. This painter is associated with all the series that do not come with a default painter.
secondarySeries | property |
secondarySeries:Array
For multi series charts, you can add secondary series to this array. Make sure you specify a painter for each secondary series. For the primary series, we simply use the charts default painter (unless the series overrides it), but secondary series need their own painters.
public function get secondarySeries():Array
public function set secondarySeries(value:Array):void
selectedChartItems | property |
selectedChartItems:Array
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Specifies an array of all the selected ChartItem objects in the chart.
public function get selectedChartItems():Array
series | property |
series:Array
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
An array of Series objects that define the chart data. Each chart defines the type of Series objects that you use to populate this array. For example, a ColumnChart control expects ColumnSeries objects as part of this array. Some charts accept any object of type IChartElement2 as part of the array, but in general each chart expects a specific type.
public function get series():Array
public function set series(value:Array):void
showDataTips | property |
public var showDataTips:Boolean = true
Flag to show data tips for this chart
showSpinnerOnCreationComplete | property |
showSpinnerOnCreationComplete:Boolean
public function get showSpinnerOnCreationComplete():Boolean
public function set showSpinnerOnCreationComplete(value:Boolean):void
spinner | property |
spinner:ISpinner
public function get spinner():ISpinner
public function set spinner(value:ISpinner):void
spinnerBehavior | property |
public var spinnerBehavior:SpinnerBehavior
spinnerFactory | property |
spinnerFactory:IFactory
Factory responsible for instantiating a new spinner. Defaults to com.flexicious.Spinner. Needs to implement com.flexicious.interfaces.ISpinner, and extend UIComponent
public function get spinnerFactory():IFactory
public function set spinnerFactory(value:IFactory):void
spinnerLabel | property |
spinnerLabel:String
The label of the spinner control, you can use styles to control the appearance.
public function get spinnerLabel():String
public function set spinnerLabel(value:String):void
spinnerParent | property |
spinnerParent:Object
[read-only] The parent component to add the spinner to
public function get spinnerParent():Object
threeDimensional | property |
threeDimensional:Boolean
Is this a 3D chart? For the 2.9 release, only bar and column charts support 3d.
public function get threeDimensional():Boolean
public function set threeDimensional(value:Boolean):void
threeDimensionalShadowRatio | property |
threeDimensionalShadowRatio:Number
If threeDimensional is set to true, the ratio of the shadow for the 3D perspective. Defaults to 0.25. Should range between 0 and 1. Currently only applicable to bar and column charts.
public function get threeDimensionalShadowRatio():Number
public function set threeDimensionalShadowRatio(value:Number):void
tooltipBehavior | property |
public var tooltipBehavior:TooltipBehavior
TinyChartBase | () | Constructor |
public function TinyChartBase()
The constructor
collectionChangeHandler | () | method |
override protected function collectionChangeHandler(event:CollectionEvent):void
Collection change handler.
Parameters
event:CollectionEvent |
defaultDataTipFunction | () | method |
protected function defaultDataTipFunction(hitData:HitData):String
Datatip function
Parameters
hitData:HitData |
String —
|
drawChart | () | method |
public function drawChart():void
This method actually draws the chart. Internally, most charts will call the associated painters paintSeries method.
findDataPoints | () | method |
public function findDataPoints(x:Number, y:Number, checkInteractivity:Boolean = false, sensitivity:int = -1):Array
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns an array of HitData objects that describe
the nearest data point to the coordinates passed to the method.
The x
and y
arguments should be values
in the coordinate system of the ChartBase object.
This method adheres to the limits specified by the
mouseSensitivity
property of the ChartBase object
when looking for nearby data points.
Parameters
x:Number — The x coordinate relative to the ChartBase object.
| |
y:Number — The y coordinate relative to the ChartBase object.
| |
checkInteractivity:Boolean (default = false )
| |
sensitivity:int (default = -1 )
|
Array — An array of HitData objects.
|
See also
getPlotPoints | () | method |
public function getPlotPoints(item:Object):Array
Gets all the plot points across all series for this item.
Parameters
item:Object |
Array |
hideSpinner | () | method |
public function hideSpinner():void
invalidateChart | () | method |
public function invalidateChart():void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Triggers a redraw of the chart area. Call this method when you add or change the chart's series or data providers. This triggers a full repaint of the chart, including recalculation of axes, bounds, etc.
invalidateChartArea | () | method |
public function invalidateChartArea():void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Triggers a redraw of the chart area. This triggers a lightweigh repaint of the chart.
invalidateChartSize | () | method |
public function invalidateChartSize():void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Triggers a redraw of the chart area. This triggers a lightweigh repaint of the chart.
isItemSelected | () | method |
public function isItemSelected(item:Object, series:Series = null):Boolean
Iterates over selectedChartItems and checks to see if any chart item has specified item selected.
Parameters
item:Object | |
series:Series (default = null )
|
Boolean |
isItemUnderMouse | () | method |
public function isItemUnderMouse(item:Object, series:Series = null, first:Boolean = false):Boolean
Iterates 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 |
mouseClickHandler | () | method |
protected function mouseClickHandler(event:MouseEvent):void
Handler for the mouse click event. Identifies the data points under the mouse and dispatches a ITEM_CLICK event with this information. Asks the series to handle mouse click for selection.
Parameters
event:MouseEvent |
mouseDoubleClickHandler | () | method |
protected function mouseDoubleClickHandler(event:MouseEvent):void
Handler for the double click event. Identifies the data points under the mouse and dispatches a CHART_DOUBLE_CLICK or ITEM_DOUBLE_CLICK event with this information. Asks the series to handle mouse click for selection.
Parameters
event:MouseEvent |
mouseDownHandler | () | method |
protected function mouseDownHandler(event:MouseEvent):void
Handler for the mouse down event. Identifies the data points under the mouse and dispatches a ITEM_MOUSE_DOWN event with this information
Parameters
event:MouseEvent |
mouseMoveHandler | () | method |
protected function mouseMoveHandler(event:MouseEvent):void
Parameters
event:MouseEvent |
mouseOutHandler | () | method |
protected function mouseOutHandler(event:MouseEvent):void
Handler for the mouse out event. Hides the data tip, if any
Parameters
event:MouseEvent |
mouseUpHandler | () | method |
protected function mouseUpHandler(event:MouseEvent):void
Handler for the mouse over event. Identifies the data points under the mouse and dispatches a ITEM_MOUSE_UP event with this information
Parameters
event:MouseEvent |
onCreationComplete | () | method |
override protected function onCreationComplete(event:FlexEvent):void
Parameters
event:FlexEvent |
onResize | () | method |
override protected function onResize(event:ResizeEvent):void
Parameters
event:ResizeEvent |
showSpinner | () | method |
public function showSpinner(msg:String):void
Parameters
msg:String |
change | Event |
com.flexicious.components.tinycharts.events.ChartItemEvent
com.flexicious.components.tinycharts.events.ChartItemEvent.CHANGE
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when the selection changes in the chart.
Event type constant; indicates that the selection in the chart has changed.chartClick | Event |
com.events.ChartEvent
com.events.ChartEvent.CHART_CLICK
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when no data point is found under the mouse pointer
when mouse is clicked on chart.
Flex considers only data points within the radius determined by
the mouseSensitivity
property.
chartDoubleClick | Event |
com.events.ChartEvent
com.events.ChartEvent.CHART_DOUBLE_CLICK
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when no data point is found under the mouse pointer
when mouse is double-clicked on chart.
Flex considers only data points within the radius determined by
the mouseSensitivity
property.
itemClick | Event |
com.flexicious.components.tinycharts.events.ChartItemEvent
com.flexicious.components.tinycharts.events.ChartItemEvent.MOUSE_CLICK_DATA
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when a data point is found under the mouse pointer
when it is clicked.
Flex considers only data points within the radius determined by
the mouseSensitivity
property.
itemDoubleClick | Event |
com.flexicious.components.tinycharts.events.ChartItemEvent
com.flexicious.components.tinycharts.events.ChartItemEvent.ITEM_DOUBLE_CLICK
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when a data point is found under the mouse pointer
when it is double clicked.
Flex considers only data points within the radius determined by
the mouseSensitivity
property.
itemMouseDown | Event |
com.flexicious.components.tinycharts.events.ChartItemEvent
com.flexicious.components.tinycharts.events.ChartItemEvent.ITEM_MOUSE_DOWN
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when a data point is found under the mouse pointer
when it is pressed down.
Flex considers only data points within the radius determined by
the mouseSensitivity
property.
itemMouseMove | Event |
com.flexicious.components.tinycharts.events.ChartItemEvent
com.flexicious.components.tinycharts.events.ChartItemEvent.ITEM_MOUSE_MOVE
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when the mouse pointer moves while over a data point.
Flex considers only data points within the radius determined by
the mouseSensitivity
property.
itemMouseUp | Event |
com.flexicious.components.tinycharts.events.ChartItemEvent
com.flexicious.components.tinycharts.events.ChartItemEvent.ITEM_MOUSE_UP
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when a data point is found under the mouse pointer
when it is released.
Flex considers only data points within the radius determined by
the mouseSensitivity
property.
itemRollOut | Event |
com.flexicious.components.tinycharts.events.ChartItemEvent
com.flexicious.components.tinycharts.events.ChartItemEvent.ITEM_ROLL_OUT
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when the closest data point under the mouse pointer changes.
Flex considers only data points within the radius determined by
the mouseSensitivity
property.
itemRollOver | Event |
com.flexicious.components.tinycharts.events.ChartItemEvent
com.flexicious.components.tinycharts.events.ChartItemEvent.ITEM_ROLL_OVER
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when a new data point is found under the mouse pointer.
Flex only considers data points within the radius determined by
the mouseSensitivity
property.
CHART_TYPE_AREA | Constant |
public static const CHART_TYPE_AREA:String = area
CHART_TYPE_BAR | Constant |
public static const CHART_TYPE_BAR:String = bar
CHART_TYPE_BUBBLE | Constant |
public static const CHART_TYPE_BUBBLE:String = bubble
CHART_TYPE_COLUMN | Constant |
public static const CHART_TYPE_COLUMN:String = column
CHART_TYPE_DIVIDED_BAR | Constant |
public static const CHART_TYPE_DIVIDED_BAR:String = dividedbar
CHART_TYPE_DIVIDED_COLUMN | Constant |
public static const CHART_TYPE_DIVIDED_COLUMN:String = dividedcolumn
CHART_TYPE_FUNNEL | Constant |
public static const CHART_TYPE_FUNNEL:String = funnel
CHART_TYPE_LINE | Constant |
public static const CHART_TYPE_LINE:String = line
CHART_TYPE_PIE | Constant |
public static const CHART_TYPE_PIE:String = pie
CHART_TYPE_PYRAMID | Constant |
public static const CHART_TYPE_PYRAMID:String = pyramid
CHART_VARTIAION_TYPE_100PERCENT | Constant |
public static const CHART_VARTIAION_TYPE_100PERCENT:String = 100%
CHART_VARTIAION_TYPE_CLUSTERED | Constant |
public static const CHART_VARTIAION_TYPE_CLUSTERED:String = clustered
CHART_VARTIAION_TYPE_OVERLAID | Constant |
public static const CHART_VARTIAION_TYPE_OVERLAID:String = overlaid
CHART_VARTIAION_TYPE_STACKED | Constant |
public static const CHART_VARTIAION_TYPE_STACKED:String = stacked
seriesColors | Constant |
public static const seriesColors:Array
Default list of colors for series.