Packagefr.kapit.ringchart
Classpublic class RingChart
InheritanceRingChart Inheritance KapUIComponent Inheritance mx.core.UIComponent



Public Properties
 PropertyDefined by
 InheritedanalysisPath : Object
An array used for CSV and General ICollectionView files and enables data source analysis with a given logic.
KapUIComponent
  animationDuration : Number = 500
Explode/Collpase animation duration.
RingChart
 InheritedattributesDescriptor : AttributesDescriptor
It assigns to each column reference in the analysisPath its attributes.
KapUIComponent
  callOutContainer : Sprite
[read-only]
RingChart
  callOuts : Array
RingChart
  colorFunction : Function
The first color used to generate nodes colors.
RingChart
  colorPolicy : String
Indicates the policy used to generate colors for the nodes.
RingChart
 InheritedcsvDelimiter : String
CSV delimiter used for csv source parsing.
KapUIComponent
  customToolTipClass : Class
Indicates the class to be used to create the ringChart tooltips.
RingChart
 InheritedcustomTreeDataDescriptor : ITreeDataDescriptor
Custom Tree Data descriptor for navigating inside data provider object.
KapUIComponent
 InheriteddataProvider : Object
Visualizer Data provider.
KapUIComponent
  filterPath : Array
Analysis Path is used for CSV and General XML files and enables data source analysis with a given logic.
RingChart
  firstColor : uint
The first color used to generate nodes colors.
RingChart
  gapBetweenRings : Number
specifiy the gap between rings
RingChart
  gapBetweenWedges : Number
specify the distance between the different wedges
RingChart
  getDataAsSeries : Boolean
specifiy if the data source is provided as series or nop User should put this property in True if every item of the data provider is a Serie (presented by a ring on the RingChart), unless if the data are in orthogonal structure this property should be set on False
RingChart
 InheritedgroupProperty : String
Property in a node data object (XML node for example) which value refers to the group dependency.The value is considered as the unique id of the group.
KapUIComponent
 InheritedidProperty : String
For any data item in any ICollectionView dataProvider (XML, array collection containing objects with children property), The idProperty is the property which value is considered as the unique id of the item (node, group or link).
KapUIComponent
 InheritedignoreRoot : Boolean
Indicator if common root node of ICollectionView should be ignored.
KapUIComponent
  innerRadius : Number
Inner Radius displayed by the ring Chart.
RingChart
 InheritedkData : KData
private
KapUIComponent
  labels : Array
RingChart
  lastColor : uint
The second color used to generate nodes colors.
RingChart
  leftEspacement : int
RingChart
  leftLabels : ArrayCollection
RingChart
 InheritedlinkProperty : String
Property in a node data object depending to an ICollectionView dataProvider which value will be assigned to the created link.
KapUIComponent
  _maxRadius : Number
RingChart
 InheritedmergeDescriptor : MergeDescriptor
Descriptor defining merging tasks that must be applied on a CSV source before displaying it.
KapUIComponent
  radialDisplacement : Number
specify the distance of displacement of the wedge when clicking on
RingChart
  radius : Number
OuterRadius displayed by the ring Chart.
RingChart
 InheritedrecordDelimiter : String
Record delimiter of CSV fields.
KapUIComponent
 InheritedreportingFunctions : Dictionary
Reporting functions used to compute a data field from an array of data fields generated after CSV parsing or advanced XML treatment.
KapUIComponent
  rightDownLabels : ArrayCollection
RingChart
  rightEspacement : int
RingChart
  rightUpLabels : ArrayCollection
RingChart
  rings : Array
this property define the array of the rings used to draw all the ringchart
RingChart
  ringSize : Boolean
Specify the ring size: by default , the ringChart can handle an illimited number of series and it will display them even if the ring size is very small ( we can even have a circle).
RingChart
  selectedSerie : Number
SelectedSerie get the index of the serie when clicking on an item in the dataGrid
RingChart
  selectedWedge : String
Ensure the interconnexion between the ringChart and other components in fact when clicking on a data on the grid the SelectedWedge property will get the name of the wedge and the applying a filter on it.
RingChart
  seriesLegend : RingLegend
A legend containing the list of the RingChart series.
RingChart
  transitionAspect : String
this porperty is used to define the effect aspect when exploding a wedge
RingChart
  tweenerArray : Array
RingChart
 InheritedtypesDescriptor : Dictionary
Column types descriptor.
KapUIComponent
  viewLabel : Boolean
show the labels in a callout way: in fact when this labelShow is set the labels will be displayet on the outer ring in a callout way.
RingChart
  viewPercentage : Boolean
This property is used to show the percentage on the ringChart: when this property is set to true, the percentage values will be displayed on the different rings.
RingChart
  viewTooltips : Boolean
this property should be set to True when the user want to show the toolTip in each wedge
RingChart
 InheritedwithHeaders : Boolean
Indicator if the CSV data provider first row are headers or not.
KapUIComponent
Protected Properties
 PropertyDefined by
 Inherited_analysisPath : Array
private
KapUIComponent
 Inherited_attributesDescriptor : AttributesDescriptor
private
KapUIComponent
 Inherited_csvDelimiter : String = ";"
private
KapUIComponent
 Inherited_customTreeDataDescriptor : ITreeDataDescriptor
private
KapUIComponent
 Inherited_dataProvider : Object
private
KapUIComponent
 Inherited_dataProviderChanged : Boolean
private
KapUIComponent
 Inherited_dataProviderType : int
private
KapUIComponent
 Inherited_groupProperty : String
private
KapUIComponent
 Inherited_idProperty : String
private
KapUIComponent
 Inherited_ignoreRoot : Boolean
private
KapUIComponent
 Inherited_kData : KData
KapUIComponent
 Inherited_linkProperty : String
private
KapUIComponent
 Inherited_mergeDescriptor : MergeDescriptor
private
KapUIComponent
 Inherited_recordDelimiter : String = ""
private
KapUIComponent
 Inherited_reportingFunctions : Dictionary
private
KapUIComponent
 Inherited_reportingFunctionsChanged : Boolean
private
KapUIComponent
 Inherited_typesDescriptor : Dictionary
private
KapUIComponent
 Inherited_useMultiLink : Boolean = true
private
KapUIComponent
 Inherited_withHeaders : Boolean = true
private
KapUIComponent
Public Methods
 MethodDefined by
  
Creates a new RingChart instance.
RingChart
 Inherited
addChild(child:DisplayObject):DisplayObject
KapUIComponent
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
KapUIComponent
 Inherited
setChildIndex(child:DisplayObject, index:int):void
KapUIComponent
  
styleChanged(styleProp:String):void
RingChart
Protected Methods
 MethodDefined by
  
handleResize(event:ResizeEvent):void
RingChart
  
loadKData():void
RingChart
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
RingChart
Events
 EventSummaryDefined by
    RingChart
    RingChart
    RingChart
Styles
 StyleDescriptionDefined by
  
callOutColor
Type: uint   Format: Color   CSS Inheritance: yes
label callOutColor. The default value is 0x000000.
RingChart
  
fontFamily
Type: String   CSS Inheritance: yes
label font family. The default value is verdana.
RingChart
  
fontWeight
Type: Number   CSS Inheritance: yes
label font weight. The default value is 11.
RingChart
  
labelColor
Type: uint   Format: Color   CSS Inheritance: yes
label Color. The default value is 0x000000.
RingChart
  
percentageColor
Type: uint   Format: Color   CSS Inheritance: yes
label Color. The default value is 0x000000.
RingChart
  
seriesFilter
Type: Object   CSS Inheritance: yes
series Filter. The default value is Glow.
RingChart
Public Constants
 ConstantDefined by
 InheritedBICHROMATIC_COLORING : String = "bichromatic"
[static]
KapUIComponent
  COLOR_POLICY_BICHROMATIC : String = "bichromatic"
[static] Colors are generated by mixing firstColor and secondColor.
RingChart
  COLOR_POLICY_MONOCHROMATIC : String = "monochromatic"
[static] Colors are generated by mixing firstColor and black.
RingChart
  COLOR_POLICY_SPECTRUM : String = "spectrum"
[static] Colors are generated by mixing red, green and blue colors.
RingChart
 InheritedDEFAULT_COLORING : String = "none"
[static]
KapUIComponent
  DEG_TO_RAD : Number = 0.017453292519943295
[static]
RingChart
 InheritedMONOCHROMATIC_COLORING : String = "monochromatic"
[static]
KapUIComponent
 InheritedUNIFORM_COLORING : String = "uniform"
[static]
KapUIComponent
Property detail
animationDurationproperty
public var animationDuration:Number = 500

Explode/Collpase animation duration.

callOutContainerproperty 
callOutContainer:Sprite  [read-only]Implementation
    public function get callOutContainer():Sprite
callOutsproperty 
public var callOuts:Array
colorFunctionproperty 
colorFunction:Function  [read-write]

The first color used to generate nodes colors.

Implementation
    public function get colorFunction():Function
    public function set colorFunction(value:Function):void
colorPolicyproperty 
colorPolicy:String  [read-write]

Indicates the policy used to generate colors for the nodes.

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

See also

customToolTipClassproperty 
customToolTipClass:Class  [read-write]

Indicates the class to be used to create the ringChart tooltips. This class must implement the IRingChartToolTip interface.

The default value is null.

Implementation
    public function get customToolTipClass():Class
    public function set customToolTipClass(value:Class):void
filterPathproperty 
filterPath:Array  [read-write]

Analysis Path is used for CSV and General XML files and enables data source analysis with a given logic. For CSV files(like other formats), the analysis path is an Array with only one string (can be 2 but not advised) containing the considered columns header. This property can be used as the source for data binding.

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

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

Example
Given the following CSV file, one of the analysis Paths should be ["Entreprise"], the delimiter should be "," and the record delimiter should be "/"". "Entreprise","Profit (KE)","Employees Number" "Enterp1","1000","22" "Enterp2","1200","30" "Enterp3","1500","100" "Enterp4","1500","15" "Enterp5","1460","10" "Enterp6","3000","28" ...

firstColorproperty 
firstColor:uint  [read-write]

The first color used to generate nodes colors.

Implementation
    public function get firstColor():uint
    public function set firstColor(value:uint):void
gapBetweenRingsproperty 
gapBetweenRings:Number  [read-write]

specifiy the gap between rings

Implementation
    public function get gapBetweenRings():Number
    public function set gapBetweenRings(value:Number):void
gapBetweenWedgesproperty 
gapBetweenWedges:Number  [read-write]

specify the distance between the different wedges

Implementation
    public function get gapBetweenWedges():Number
    public function set gapBetweenWedges(value:Number):void
getDataAsSeriesproperty 
getDataAsSeries:Boolean  [read-write]

specifiy if the data source is provided as series or nop User should put this property in True if every item of the data provider is a Serie (presented by a ring on the RingChart), unless if the data are in orthogonal structure this property should be set on False

Implementation
    public function get getDataAsSeries():Boolean
    public function set getDataAsSeries(value:Boolean):void
innerRadiusproperty 
innerRadius:Number  [read-write]

Inner Radius displayed by the ring Chart.

Implementation
    public function get innerRadius():Number
    public function set innerRadius(value:Number):void
labelsproperty 
public var labels:Array
lastColorproperty 
lastColor:uint  [read-write]

The second color used to generate nodes colors.

Implementation
    public function get lastColor():uint
    public function set lastColor(value:uint):void
leftEspacementproperty 
public var leftEspacement:int
leftLabelsproperty 
public var leftLabels:ArrayCollection
_maxRadiusproperty 
public var _maxRadius:Number
radialDisplacementproperty 
radialDisplacement:Number  [read-write]

specify the distance of displacement of the wedge when clicking on

Implementation
    public function get radialDisplacement():Number
    public function set radialDisplacement(value:Number):void
radiusproperty 
radius:Number  [read-write]

OuterRadius displayed by the ring Chart.

Implementation
    public function get radius():Number
    public function set radius(value:Number):void
rightDownLabelsproperty 
public var rightDownLabels:ArrayCollection
rightEspacementproperty 
public var rightEspacement:int
rightUpLabelsproperty 
public var rightUpLabels:ArrayCollection
ringsproperty 
rings:Array  [read-write]

this property define the array of the rings used to draw all the ringchart

Implementation
    public function get rings():Array
    public function set rings(value:Array):void
ringSizeproperty 
ringSize:Boolean  [read-write]

Specify the ring size: by default , the ringChart can handle an illimited number of series and it will display them even if the ring size is very small ( we can even have a circle). However when setting the ringSize property: the ringChart will display not all the series, depending on the unscaled width and height, but it will display rings with a minimum size of 10

Implementation
    public function get ringSize():Boolean
    public function set ringSize(value:Boolean):void
selectedSerieproperty 
selectedSerie:Number  [read-write]

SelectedSerie get the index of the serie when clicking on an item in the dataGrid

Implementation
    public function get selectedSerie():Number
    public function set selectedSerie(value:Number):void
selectedWedgeproperty 
selectedWedge:String  [read-write]

Ensure the interconnexion between the ringChart and other components in fact when clicking on a data on the grid the SelectedWedge property will get the name of the wedge and the applying a filter on it.

Implementation
    public function get selectedWedge():String
    public function set selectedWedge(value:String):void
seriesLegendproperty 
seriesLegend:RingLegend  [read-write]

A legend containing the list of the RingChart series.

Implementation
    public function get seriesLegend():RingLegend
    public function set seriesLegend(value:RingLegend):void
transitionAspectproperty 
transitionAspect:String  [read-write]

this porperty is used to define the effect aspect when exploding a wedge

The default value is linear.

Implementation
    public function get transitionAspect():String
    public function set transitionAspect(value:String):void
tweenerArrayproperty 
public var tweenerArray:Array
viewLabelproperty 
viewLabel:Boolean  [read-write]

show the labels in a callout way: in fact when this labelShow is set the labels will be displayet on the outer ring in a callout way.

The default value is true.

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

This property is used to show the percentage on the ringChart: when this property is set to true, the percentage values will be displayed on the different rings.

The default value is true.

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

this property should be set to True when the user want to show the toolTip in each wedge

Implementation
    public function get viewTooltips():Boolean
    public function set viewTooltips(value:Boolean):void
Constructor detail
RingChart()constructor
public function RingChart()

Creates a new RingChart instance.

Method detail
handleResize()method
protected function handleResize(event:ResizeEvent):voidParameters
event:ResizeEvent
loadKData()method 
protected override function loadKData():void
styleChanged()method 
public override function styleChanged(styleProp:String):voidParameters
styleProp:String
updateDisplayList()method 
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters
unscaledWidth:Number
 
unscaledHeight:Number
Event detail
itemRollOutevent 
Event object type: fr.kapit.ringchart.events.RingEvent

itemRollOverevent  
Event object type: fr.kapit.ringchart.events.RingEvent

wedgeClickevent  
Event object type: fr.kapit.ringchart.events.RingEvent

Constant detail
COLOR_POLICY_BICHROMATICconstant
public static const COLOR_POLICY_BICHROMATIC:String = "bichromatic"

Colors are generated by mixing firstColor and secondColor.

COLOR_POLICY_MONOCHROMATICconstant 
public static const COLOR_POLICY_MONOCHROMATIC:String = "monochromatic"

Colors are generated by mixing firstColor and black.

COLOR_POLICY_SPECTRUMconstant 
public static const COLOR_POLICY_SPECTRUM:String = "spectrum"

Colors are generated by mixing red, green and blue colors.

DEG_TO_RADconstant 
public static const DEG_TO_RAD:Number = 0.017453292519943295