Packagefr.kapit.radarchart
Classpublic class RadarChart
InheritanceRadarChart 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
  arrowIconFunction : Function
Used to determine the icon to be used to draw the arrow on each axis.
RadarChart
 InheritedattributesDescriptor : AttributesDescriptor
It assigns to each column reference in the analysisPath its attributes.
KapUIComponent
  axes : Array
An array of the axes of the radarchart.
RadarChart
  axesMaxValue : Number
A custom maximum value specified by the used to control the graduation of the axes.
RadarChart
  axesMinValue : Number
A custom minimum value specified by the used to control the graduation of the axes.
RadarChart
  axisLabelFunction : Function
Used to determine the label to be associated with each axis.
RadarChart
  axisLength : Number
Axis length.
RadarChart
  axisNameTextFormat : TextFormat
Font used to render axis name.
RadarChart
  axisSortFunction : Function
Used to sort the axes.
RadarChart
  center : Point
Center of the Radar Chart.
RadarChart
 InheritedcsvDelimiter : String
CSV delimiter used for csv source parsing.
KapUIComponent
  curvature : Number
Indicates the Curvature used to draw curve polylines, it's value must be in the range 0..1.
RadarChart
  customToolTipClass : IFactory
Indicates the class to be used to create the radarchart tooltips.
RadarChart
 InheritedcustomTreeDataDescriptor : ITreeDataDescriptor
Custom Tree Data descriptor for navigating inside data provider object.
KapUIComponent
 InheriteddataProvider : Object
Visualizer Data provider.
KapUIComponent
  displayPointDragToolTip : Boolean
Indicates if a tooltip will be displayed while a point is dragging.
RadarChart
  displayToolTip : Boolean
Indicates whether the toolTip should be displayed.
RadarChart
  divisions : int
Number of axes divisions.
RadarChart
  enablePointDrag : Boolean
Indicates whether the user can change the values of series points by dragging them.
RadarChart
  exclusiveSelectedSeries : RadarChartSeries
Used indicates which series should be not highlighted.
RadarChart
  exponentToStringLabelFunction : Function
Function returning a string representation of large values.
RadarChart
  filterPath : Array
Analysis Path is used for CSV and General XML files and enables data source analysis with a given logic.
RadarChart
  graduationLabelFunction : Function
Gets or sets the function to be used to obtain the label for an axis graduation.
RadarChart
  graduations : Array
Base graduations used to determine the graduations for each axis.
RadarChart
  graduationTextFormat : TextFormat
Text format used to render the graduations on the axes.
RadarChart
 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
  isDragging : Boolean = false
RadarChart
 InheritedkData : KData
private
KapUIComponent
  lineType : String
Indicates the type of the lines used in the radarchat (linear lines or curves).
RadarChart
 InheritedlinkProperty : String
Property in a node data object depending to an ICollectionView dataProvider which value will be assigned to the created link.
KapUIComponent
  listOfDisplayedDataPoints : Dictionary
RadarChart
  listOfDisplayedTooltips : Dictionary
RadarChart
 InheritedmergeDescriptor : MergeDescriptor
Descriptor defining merging tasks that must be applied on a CSV source before displaying it.
KapUIComponent
  multipleTooltip : Boolean
Indicates whether the toolTip should be displayed.
RadarChart
  numAxes : int
[read-only] Indicates the number of axes in the RadarChart.
RadarChart
  numSeries : int
[read-only] Indicates the number of series in the RadarChart.
RadarChart
 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
  selectedSeries : Array
An array containing series that should be displayed.
RadarChart
  series : Array
An array of the series displayed by the radarchart.
RadarChart
  seriesField : String
Name of the field used to determine the name of a series.
RadarChart
  seriesLegend : IRadarChartLegend
A legend containing the list of the RadarChart series.
RadarChart
  seriestype : String
Indicates the type of the series used in the radarchat (lines, areas or points).
RadarChart
  tooltipPoisitionner : Function
RadarChart
  toolTipRenderer : IFactory
Indicates the class to be used to create the radarchart tooltips.
RadarChart
 InheritedtypesDescriptor : Dictionary
Column types descriptor.
KapUIComponent
  useSameGraduations : Boolean
Indicates wether all the axes must have the same graduations or different (independent) graduations.
RadarChart
 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 RadarChart instance.
RadarChart
 Inherited
addChild(child:DisplayObject):DisplayObject
KapUIComponent
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
KapUIComponent
  
private
RadarChart
  
hideTooltips():void
RadarChart
 Inherited
setChildIndex(child:DisplayObject, index:int):void
KapUIComponent
  
showDataPointTooltip(d:DataPoint):void
RadarChart
  
styleChanged(styleProp:String):void
RadarChart
Protected Methods
 MethodDefined by
  
getNearsetDataPoints(xMouse:Number, yMouse:Number):Array
private
RadarChart
 Inherited
loadKData():void
Generate a common data descriptor from the dataProvider and other data manipulation options.
KapUIComponent
Events
 EventSummaryDefined by
   Dispatched when the user finishes dragging a series point using the mouse.RadarChart
   Dispatched when the user is dragging a series point using the mouse.RadarChart
Styles
 StyleDescriptionDefined by
  
arrowHeight
Type: Number   CSS Inheritance: yes
Indicates the arrow height.
RadarChart
  
arrowIcon
Type: Class   CSS Inheritance: yes
A custom icon used to draw the arrow on each axis. The default value is null.
RadarChart
  
arrowIconHeight
Type: Number   CSS Inheritance: yes
Indicates the arrow icon height. If no height is specified, the actual icon height is used.
RadarChart
  
arrowIconWidth
Type: Number   CSS Inheritance: yes
Indicates the arrow icon width. If no width is specified, the actual icon width is used.
RadarChart
  
arrowIndentation
Type: Number   CSS Inheritance: yes
Indicates the arrow internal spacing.
RadarChart
  
arrowWidth
Type: Number   CSS Inheritance: yes
Indicates the arrow width.
RadarChart
  
axisAlpha
Type: Number   CSS Inheritance: yes
Axis Alpha. The default value is 1.
RadarChart
  
axisColor
Type: uint   Format: Color   CSS Inheritance: yes
Axis Color. The default value is 0xcccccc.
RadarChart
  
axisWidth
Type: Number   Format: Length   CSS Inheritance: yes
Axis Width. The default value is 2.
RadarChart
  
endPadding
Type: Number   Format: Length   CSS Inheritance: yes
Distance between the last series and the end of the axes. The default value is 30.
RadarChart
  
gridAlpha
Type: Number   CSS Inheritance: yes
Grid Alpha. The default value is 1.
RadarChart
  
gridWidth
Type: Number   Format: Length   CSS Inheritance: yes
Grid Width. The default value is 2.
RadarChart
  
hPadding
Type: Number   Format: Length   CSS Inheritance: yes
Horizontal Padding. The default value is 25.
RadarChart
  
seriesAlpha
Type: Number   CSS Inheritance: yes
Series Alpha. The default value is 1.
RadarChart
  
seriesFillAlpha
Type: Number   CSS Inheritance: yes
Series Fill Alpha; The default value is 0.2.
RadarChart
  
seriesWidth
Type: Number   Format: Length   CSS Inheritance: yes
Series Width. The default value is 2.
RadarChart
  
showAxes
Type: Boolean   CSS Inheritance: yes
Indicates whether the axes are visible or not. The default value is true.
RadarChart
  
showAxesArrow
Type: Boolean   CSS Inheritance: yes
Indicates whether to draw an arrow in the end of each axis or not. The default value is true.
RadarChart
  
showAxisName
Type: Boolean   CSS Inheritance: yes
Indicates whether to display the name of the axes or not. The default value is true.
RadarChart
  
showGraduations
Type: Boolean   CSS Inheritance: yes
Indicates whether the graduation points are visible or not. The default value is true.
RadarChart
  
showGrid
Type: Boolean   CSS Inheritance: yes
Indicates whether the grid is visible or not. The default value is true.
RadarChart
  
startPadding
Type: Number   Format: Length   CSS Inheritance: yes
Distance between the center and the first series. The default value is 20.
RadarChart
  
vPadding
Type: Number   Format: Length   CSS Inheritance: yes
Vertical Padding. The default value is 25.
RadarChart
Public Constants
 ConstantDefined by
  AREA_SERIES : String = "areaseries"
[static] Series are drawn as filled polylines.
RadarChart
 InheritedBICHROMATIC_COLORING : String = "bichromatic"
[static]
KapUIComponent
  CURVE : String = "curve"
[static] Polylines are drawn using curves;
RadarChart
 InheritedDEFAULT_COLORING : String = "none"
[static]
KapUIComponent
  LINE : String = "line"
[static] Polylines are drawn using lines.
RadarChart
  LINE_SERIES : String = "lineseries"
[static] Series are drawn as polylines.
RadarChart
 InheritedMONOCHROMATIC_COLORING : String = "monochromatic"
[static]
KapUIComponent
  POINT_SERIES : String = "pointseries"
[static] Series are drawn as points.
RadarChart
 InheritedUNIFORM_COLORING : String = "uniform"
[static]
KapUIComponent
Property detail
arrowIconFunctionproperty
arrowIconFunction:Function  [read-write]

Used to determine the icon to be used to draw the arrow on each axis. It must have the following signature : arrowIconFunction(axisName:String):Class.

Implementation
    public function get arrowIconFunction():Function
    public function set arrowIconFunction(value:Function):void
axesproperty 
axes:Array  [read-write]

An array of the axes of the radarchart.

Implementation
    public function get axes():Array
    public function set axes(value:Array):void
axesMaxValueproperty 
axesMaxValue:Number  [read-write]

A custom maximum value specified by the used to control the graduation of the axes.

Implementation
    public function get axesMaxValue():Number
    public function set axesMaxValue(value:Number):void
axesMinValueproperty 
axesMinValue:Number  [read-write]

A custom minimum value specified by the used to control the graduation of the axes.

Implementation
    public function get axesMinValue():Number
    public function set axesMinValue(value:Number):void
axisLabelFunctionproperty 
axisLabelFunction:Function  [read-write]

Used to determine the label to be associated with each axis. It must have the following signature : axisLabelFunction(axisName:String, axis:RadarChartAxis):String.

Implementation
    public function get axisLabelFunction():Function
    public function set axisLabelFunction(value:Function):void
axisLengthproperty 
axisLength:Number  [read-write]

Axis length.

Implementation
    public function get axisLength():Number
    public function set axisLength(value:Number):void
axisNameTextFormatproperty 
axisNameTextFormat:TextFormat  [read-write]

Font used to render axis name.

Implementation
    public function get axisNameTextFormat():TextFormat
    public function set axisNameTextFormat(value:TextFormat):void
axisSortFunctionproperty 
axisSortFunction:Function  [read-write]

Used to sort the axes. It must have the following signature : axisSortFunction(axisName:String):Number. Axes are ordered using their order property by puting the ones that have order = NaN at the end and ordering the other axes by ascending order.

Implementation
    public function get axisSortFunction():Function
    public function set axisSortFunction(value:Function):void
centerproperty 
center:Point  [read-write]

Center of the Radar Chart.

Implementation
    public function get center():Point
    public function set center(value:Point):void
curvatureproperty 
curvature:Number  [read-write]

Indicates the Curvature used to draw curve polylines, it's value must be in the range 0..1.

Implementation
    public function get curvature():Number
    public function set curvature(value:Number):void
customToolTipClassproperty 
customToolTipClass:IFactory  [read-write]

Indicates the class to be used to create the radarchart tooltips. This class must implement the IRadarChartToolTip interface.

The default value is null.

Implementation
    public function get customToolTipClass():IFactory
    public function set customToolTipClass(value:IFactory):void
displayPointDragToolTipproperty 
displayPointDragToolTip:Boolean  [read-write]

Indicates if a tooltip will be displayed while a point is dragging.

Implementation
    public function get displayPointDragToolTip():Boolean
    public function set displayPointDragToolTip(value:Boolean):void
displayToolTipproperty 
displayToolTip:Boolean  [read-write]

Indicates whether the toolTip should be displayed.

Implementation
    public function get displayToolTip():Boolean
    public function set displayToolTip(value:Boolean):void
divisionsproperty 
divisions:int  [read-write]

Number of axes divisions. Minimum value is 3.

Implementation
    public function get divisions():int
    public function set divisions(value:int):void
enablePointDragproperty 
enablePointDrag:Boolean  [read-write]

Indicates whether the user can change the values of series points by dragging them. The radar chart dispatches a RadarChartPointEvent.VALUE_CHANGING event when a point is being dragged and a RadarChartPointEvent.VALUE_CHANGED event when the point drag is finished.

Implementation
    public function get enablePointDrag():Boolean
    public function set enablePointDrag(value:Boolean):void
exclusiveSelectedSeriesproperty 
exclusiveSelectedSeries:RadarChartSeries  [read-write]

Used indicates which series should be not highlighted. When a custom legend is added, and when there are a many selectedseries, user can use this porperty to distinguich (using the alpha ) between selected and highlighted series.

Implementation
    public function get exclusiveSelectedSeries():RadarChartSeries
    public function set exclusiveSelectedSeries(value:RadarChartSeries):void
exponentToStringLabelFunctionproperty 
exponentToStringLabelFunction:Function  [read-write]

Function returning a string representation of large values. (more than 3 digits) This string is displayed automatically on each axis label

Implementation
    public function get exponentToStringLabelFunction():Function
    public function set exponentToStringLabelFunction(value:Function):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" ...

graduationLabelFunctionproperty 
graduationLabelFunction:Function  [read-write]

Gets or sets the function to be used to obtain the label for an axis graduation.

Implementation
    public function get graduationLabelFunction():Function
    public function set graduationLabelFunction(value:Function):void
graduationsproperty 
graduations:Array  [read-write]

Base graduations used to determine the graduations for each axis. If graduations = [1,2,5] then only multiples of 1, 2 and three will be used to graduate axes.

Implementation
    public function get graduations():Array
    public function set graduations(value:Array):void
graduationTextFormatproperty 
graduationTextFormat:TextFormat  [read-write]

Text format used to render the graduations on the axes.

Implementation
    public function get graduationTextFormat():TextFormat
    public function set graduationTextFormat(value:TextFormat):void
isDraggingproperty 
public var isDragging:Boolean = false
lineTypeproperty 
lineType:String  [read-write]

Indicates the type of the lines used in the radarchat (linear lines or curves).

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

See also

listOfDisplayedDataPointsproperty 
public var listOfDisplayedDataPoints:Dictionary
listOfDisplayedTooltipsproperty 
public var listOfDisplayedTooltips:Dictionary
multipleTooltipproperty 
multipleTooltip:Boolean  [read-write]

Indicates whether the toolTip should be displayed.

Implementation
    public function get multipleTooltip():Boolean
    public function set multipleTooltip(value:Boolean):void
numAxesproperty 
numAxes:int  [read-only]

Indicates the number of axes in the RadarChart.

Implementation
    public function get numAxes():int
numSeriesproperty 
numSeries:int  [read-only]

Indicates the number of series in the RadarChart.

Implementation
    public function get numSeries():int
selectedSeriesproperty 
selectedSeries:Array  [read-write]

An array containing series that should be displayed. Series contains a set of RadarChartSeries instances.

Implementation
    public function get selectedSeries():Array
    public function set selectedSeries(value:Array):void
seriesproperty 
series:Array  [read-write]

An array of the series displayed by the radarchart.

Implementation
    public function get series():Array
    public function set series(value:Array):void
seriesFieldproperty 
seriesField:String  [read-write]

Name of the field used to determine the name of a series.

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

A legend containing the list of the RadarChart series.

Implementation
    public function get seriesLegend():IRadarChartLegend
    public function set seriesLegend(value:IRadarChartLegend):void
seriestypeproperty 
seriestype:String  [read-write]

Indicates the type of the series used in the radarchat (lines, areas or points).

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

See also

tooltipPoisitionnerproperty 
public var tooltipPoisitionner:Function
toolTipRendererproperty 
toolTipRenderer:IFactory  [read-write]

Indicates the class to be used to create the radarchart tooltips. This class must implement the IRadarChartToolTip interface. If you need additional info than the one provided by the IRadarChartToolTip interface, you can also implement IDataRenderer interface.

The default value is null.

Implementation
    public function get toolTipRenderer():IFactory
    public function set toolTipRenderer(value:IFactory):void
useSameGraduationsproperty 
useSameGraduations:Boolean  [read-write]

Indicates wether all the axes must have the same graduations or different (independent) graduations.

Implementation
    public function get useSameGraduations():Boolean
    public function set useSameGraduations(value:Boolean):void
Constructor detail
RadarChart()constructor
public function RadarChart()

Creates a new RadarChart instance.

Method detail
getAllVisiblePoints()method
public function getAllVisiblePoints():Array

private

Returns
Array
getNearsetDataPoints()method 
protected function getNearsetDataPoints(xMouse:Number, yMouse:Number):Array

private

Parameters
xMouse:Number
 
yMouse:Number

Returns
Array
hideTooltips()method 
public function hideTooltips():void
showDataPointTooltip()method 
public function showDataPointTooltip(d:DataPoint):voidParameters
d:DataPoint
styleChanged()method 
public override function styleChanged(styleProp:String):voidParameters
styleProp:String
Event detail
valueChangedevent 
Event object type: fr.kapit.radarchart.RadarChartPointEvent

Dispatched when the user finishes dragging a series point using the mouse.

valueChangingevent  
Event object type: fr.kapit.radarchart.RadarChartPointEvent

Dispatched when the user is dragging a series point using the mouse.

Constant detail
AREA_SERIESconstant
public static const AREA_SERIES:String = "areaseries"

Series are drawn as filled polylines.

CURVEconstant 
public static const CURVE:String = "curve"

Polylines are drawn using curves;

LINEconstant 
public static const LINE:String = "line"

Polylines are drawn using lines.

LINE_SERIESconstant 
public static const LINE_SERIES:String = "lineseries"

Series are drawn as polylines.

POINT_SERIESconstant 
public static const POINT_SERIES:String = "pointseries"

Series are drawn as points.