Yahoo! UI Library

charts  3.3.0

Yahoo! UI Library > charts > PieSeries
Search:
 
Filters

Class PieSeries - extends MarkerSeries

PieSeries visualizes data as a circular chart divided into wedges which represent data as a percentage of a whole.

Constructor

PieSeries ( )

Properties

_categoryDisplayName - private object


_defaultBorderColors - private object


_defaultFillColors - private object


_defaultLineColors - private object


_defaultSliceColors - private object


_image - private object


_map - private object


_valueDisplayName - private object


categoryKey - object

Indicates which array to from the hash of value arrays in the category Axis instance.

GUID - private object

Constant used to generate unique id.

slices - private object


valueKey - object

Indicates which array to from the hash of value arrays in the value Axis instance.

Properties inherited from Plugin.Host:

Properties inherited from Attribute:

Properties inherited from Base:

Properties inherited from Renderer:

Methods

_categoryAxisChangeHandler

private void _categoryAxisChangeHandler ( )

_categoryDataChangeHandler

private void _categoryDataChangeHandler ( )
(protected) Handles updating the graph when the x < code>Axis values change.

_clearMarkerCache

private void _clearMarkerCache ( )

_createMarker

private void _createMarker ( )

_getDefaultColor

private void _getDefaultColor ( )
Colors used if style colors are not specified

_getPlotDefaults

private void _getPlotDefaults ( )

_setMap

private void _setMap ( )

_valueAxisChangeHandler

private void _valueAxisChangeHandler ( )

_valueDataChangeHandler

private void _valueDataChangeHandler ( )
(protected) Handles updating the chart when the y Axis values change.

addListeners

private void addListeners ( )

draw

protected void draw ( )
Draws the series. Overrides the base implementation.

drawPlots

private void drawPlots ( )

updateMarkerState

protected void updateMarkerState ( type , i )
Resizes and positions markers based on a mouse interaction.
Parameters:
type <String> state of the marker
i <Number> index of the marker

validate

private void validate ( )

Events

categoryAxisChange

categoryAxisChange ( event )
Fires when the value for the configuration attribute 'categoryAxis' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

categoryDisplayNameChange

categoryDisplayNameChange ( event )
Fires when the value for the configuration attribute 'categoryDisplayName' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

graphChange

graphChange ( event )
Fires when the value for the configuration attribute 'graph' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

orderChange

orderChange ( event )
Fires when the value for the configuration attribute 'order' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

stylesChange

stylesChange ( event )
Fires when the value for the configuration attribute 'styles' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

typeChange

typeChange ( event )
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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

valueDisplayNameChange

valueDisplayNameChange ( event )
Fires when the value for the configuration attribute 'valueDisplayName' 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:
event <Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

Configuration Attributes

categoryAxis - Axis

Reference to the Axis instance used for assigning category values to the graph.

categoryDisplayName - String

Name used for for displaying category data

graph - Graph

Reference to the Graph in which the series is drawn into.

order - Number

Order of this instance of this type.

styles - Object

Style properties used for drawing markers. This attribute is inherited from MarkerSeries. Below are the default values:
fill
A hash containing the following values:
colors
An array of colors to be used for the marker fills. The color for each marker is retrieved from the array below:
["#66007f", "#a86f41", "#295454", "#996ab2", "#e8cdb7", "#90bdbd","#000000","#c3b8ca", "#968373", "#678585"]
alphas
An array of alpha references (Number from 0 to 1) indicating the opacity of each marker fill. The default value is [1].
border
A hash containing the following values:
color
An array of colors to be used for the marker borders. The color for each marker is retrieved from the array below:
["#205096", "#b38206", "#000000", "#94001e", "#9d6fa0", "#e55b00", "#5e85c9", "#adab9e", "#6ac291", "#006457"]
alpha
Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.
weight
Number indicating the width of the border. The default value is 1.
over
hash containing styles for markers when highlighted by a mouseover event. The default values for each style is null. When an over style is not set, the non-over value will be used. For example, the default value for marker.over.fill.color is equivalent to marker.fill.color.

type - String

Read-only attribute indicating the type of series.
Default Value: pie

valueDisplayName - String

Name used for for displaying value data

Configuration attributes inherited from Base:

Configuration attributes inherited from MarkerSeries:

Configuration attributes inherited from Renderer:


Copyright © 2011 Yahoo! Inc. All rights reserved.