Packageardisia.charts.funnel
Classpublic class Funnel
InheritanceFunnel Inheritance ChartBase Inheritance spark.components.supportClasses.SkinnableComponent

Funnel chart class.

View the technical documentation on the Ardisia Labs website for more information.

Default MXML PropertydataProvider


Public Properties
 PropertyDefined By
 InheritedcolorField : String
Field name on the data to pull the node's color.
ChartBase
 InheritedcolorFormatFunction : Function
User provided function that returns the color for the series when passed the series data object.
ChartBase
 InheriteddataProvider : ListCollectionView
The dataProvider for the chart.
ChartBase
 InheriteddataTipField : String
Field name on the data to pull the node's data tip string.
ChartBase
 InheriteddataTipFormatFunction : Function
User provided function that gets the message to display with the data tip.
ChartBase
 InheriteddataTipHideDelay : Number = 350
Delay before the data tip is hidden.
ChartBase
 InheriteddataTipInstance : IDataRenderer
Instance of the data tip.
ChartBase
  displayLabels : Boolean
True to display a label within each section of the funnel.
Funnel
 InheritedexcludedSeries : Array
Array of the series that should not be displayed.
ChartBase
  gap : Number
Gap between sections of the funnel.
Funnel
 InheritedhighlightAlpha : Number = 0.4
When series data is highlighted, the alpha to apply.
ChartBase
 InheritedhighlightDuration : Number = 250
Duration of the highlight effects.
ChartBase
  labelsFormatFunction : Function
User provided function that formats the labels.
Funnel
  neckRatio : Number
Width of the base expressed as a percentage of the total chart width.
Funnel
  seriesLabelField : String
Field on the data to get the name of the series.
Funnel
  seriesValueField : String
Field on the data to get the value of the series.
Funnel
 InheritedshowDataTip : Boolean = true
True to display a data tip on hover.
ChartBase
  slope : Number
Value to adjust the steepness of the funnel.
Funnel
  sorted : Boolean
True to sort the data for display.
Funnel
  totalWeight : Number
[read-only] Weight of all the displayed nodes added up.
Funnel
Protected Properties
 PropertyDefined By
 InheritednumberFormatter : NumberFormatter
Default number formatter.
ChartBase
Public Methods
 MethodDefined By
  
getColor(item:Object):uint
Returns the color for each node.
Funnel
 Inherited
hideDataTip():void
Hide the data tip.
ChartBase
  
setHighlightedSeries(rawDataItem:Object):void
[override] Highlight the passed series.
Funnel
Protected Methods
 MethodDefined By
  
eventHandler(event:Event):void
[override] Handles the events for the class.
Funnel
 Inherited
getDataTipContent(data:Object):Object
Returns the contents for the data tip.
ChartBase
  
getLabelsText(item:Object):String
Return formatted string to display for the labels.
Funnel
 Inherited
setupDataTip(data:Object):void
Setup the data tip.
ChartBase
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
ChartBase
Events
 Event Summary Defined By
 Inherited
updateLegend
Dispatched when the chart's legend should be updated.ChartBase
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
 Inherited
dataTipFactoryPart:mx.core.IFactory
Required: false Part Type: Dynamic
Displays the data tip when a node is hovered.

The IFactory must return an object of type IDataRenderer		ChartBase
  
labelFactoryPart:mx.core.IFactory
Required: false Part Type: Dynamic
Creates and displays the labels for sections of the funnel.

The IFactory must return an object of type Label		Funnel
 Inherited
skinLayerPart:Layer
Required: false Part Type: Dynamic
Container for the content added to the skin.
ChartBase
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
 Inherited
disabled
ChartBase
 Inherited
normal
ChartBase
Property Detail
displayLabelsproperty
displayLabels:Boolean

True to display a label within each section of the funnel.

Defaults to displaying the node value.

The default value is true.


Implementation
    public function get displayLabels():Boolean
    public function set displayLabels(value:Boolean):void
gapproperty 
gap:Number

Gap between sections of the funnel.

The default value is 1.


Implementation
    public function get gap():Number
    public function set gap(value:Number):void
labelsFormatFunctionproperty 
labelsFormatFunction:Function

User provided function that formats the labels.

Only relevant if the "displayLabels" is true.

The function has the following signature:

	  funcName(item:Object):String

The default value is null.


Implementation
    public function get labelsFormatFunction():Function
    public function set labelsFormatFunction(value:Function):void
neckRatioproperty 
neckRatio:Number

Width of the base expressed as a percentage of the total chart width.

The default value is 0.15.


Implementation
    public function get neckRatio():Number
    public function set neckRatio(value:Number):void
seriesLabelFieldproperty 
seriesLabelField:String

Field on the data to get the name of the series.

The default value is null.


Implementation
    public function get seriesLabelField():String
    public function set seriesLabelField(value:String):void
seriesValueFieldproperty 
seriesValueField:String

Field on the data to get the value of the series.

The default value is null.


Implementation
    public function get seriesValueField():String
    public function set seriesValueField(value:String):void
slopeproperty 
slope:Number

Value to adjust the steepness of the funnel. Values ranges from 0 to 1.

The default value is 0.25.


Implementation
    public function get slope():Number
    public function set slope(value:Number):void
sortedproperty 
sorted:Boolean

True to sort the data for display.

The default value is false.


Implementation
    public function get sorted():Boolean
    public function set sorted(value:Boolean):void
totalWeightproperty 
totalWeight:Number  [read-only]

Weight of all the displayed nodes added up. Useful for custom data tips.

The default value is 0.


Implementation
    public function get totalWeight():Number
Method Detail
eventHandler()method
override protected function eventHandler(event:Event):void

Handles the events for the class.

Parameters

event:Event — the Event that triggered the handler

getColor()method 
public function getColor(item:Object):uint

Returns the color for each node. First applies the color via the colorFormatFunction, next uses an optional colorField, and finally uses a default coloring scheme.

The function has the following signature:

	  funcName(value:FunnelData):uint

Parameters

item:Object

Returns
uint
getLabelsText()method 
protected function getLabelsText(item:Object):String

Return formatted string to display for the labels.

Parameters

item:Object — series data object

Returns
String — a formatted String
setHighlightedSeries()method 
override public function setHighlightedSeries(rawDataItem:Object):void

Highlight the passed series.

Pass a null value to remove any applied effects.

Parameters

rawDataItem:Object — Object





Mon Sep 15 2014, 01:55 AM -06:00