PieChart Class
The PieChart class creates a pie chart
Item Index
Methods
Attributes
Methods
_addAxes
()
private
Adds axes to the chart.
_addSeries
()
private
Renders the Graph.
_getAriaMessage
-
key
Returns the appropriate message based on the key press.
Parameters:
-
keyNumberThe keycode that was pressed.
Returns:
_getDefaultAxes
()
private
Generates and returns a key-indexed object containing Axis instances or objects used to create Axis instances.
Returns:
_getSeriesCollection
()
private
Calculates and returns a seriesCollection.
Returns:
_parseAxes
-
val
Creates Axis instances.
Parameters:
-
valObjectObject containing
Axisinstances or objects in which to constructAxisinstances.
Returns:
_parseSeriesAxes
-
c
Parse and sets the axes for the chart.
Parameters:
-
cArrayA collection
PieSeriesinstance.
_redraw
()
private
Redraws the chart instance.
_tooltipLabelFunction
-
categoryItem -
valueItem -
itemIndex -
series -
seriesIndex
Formats tooltip text for a pie chart.
Parameters:
-
categoryItemObjectAn object containing the following:
- axis
- The axis to which the category is bound.
- displayName
- The display name set to the category (defaults to key if not provided)
- key
- The key of the category.
- value
- The value of the category
-
valueItemObjectAn object containing the following:
- axis
- The axis to which the item's series is bound.
- displayName
- The display name of the series. (defaults to key if not provided)
- key
- The key for the series.
- value
- The value for the series item.
-
itemIndexNumberThe index of the item within the series.
-
seriesCartesianSeriesThe
PieSeriesinstance of the item. -
seriesIndexNumberThe index of the series in the
seriesCollection.
Returns:
Attributes
ariaDescription
String
Sets the aria description for the chart.
Fires event ariaDescriptionChange
Fires when the value for the configuration attribute ariaDescription is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
axes
Object
Axes to appear in the chart.
Fires event axesChange
Fires when the value for the configuration attribute axes is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
seriesCollection
Array
Collection of series to appear on the chart. This can be an array of Series instances or object literals used to describe a Series instance.
Fires event seriesCollectionChange
Fires when the value for the configuration attribute seriesCollection is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
type
String
Type of chart when there is no series collection specified.
Fires event typeChange
Fires when the value for the configuration attribute type is
changed. You can listen for the event using the on method if you
wish to be notified before the attribute's value has changed, or
using the after method if you wish to be notified after the
attribute's value has changed.
Parameters:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added: