Yahoo! UI Library

charts  3.3.0

Yahoo! UI Library > charts > StackedBarSeries
Search:
 
Filters

Class StackedBarSeries - extends BarSeries - uses StackingUtil

The StackedBarSeries renders bar chart in which series are stacked horizontally to show their contribution to the cumulative total.

Constructor

StackedBarSeries ( )

Properties inherited from Plugin.Host:

Properties inherited from Attribute:

Properties inherited from Histogram:

Properties inherited from Base:

Properties inherited from Renderer:

Methods

_getPlotDefaults

protected _getPlotDefaults ( )
Returns default values for the styles attribute.
Returns:
Object

drawSeries

protected void drawSeries ( )
Draws the series.

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

Methods inherited from Histogram:

Methods inherited from StackingUtil:

Events

directionChange

directionChange ( event )
Fires when the value for the configuration attribute 'direction' 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

negativeBaseValuesChange

negativeBaseValuesChange ( event )
Fires when the value for the configuration attribute 'negativeBaseValues' 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

positiveBaseValuesChange

positiveBaseValuesChange ( event )
Fires when the value for the configuration attribute 'positiveBaseValues' 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

Configuration Attributes

direction - String

Direction of the series
Default Value: vertical

negativeBaseValues - private Array

Default Value: null

positiveBaseValues - private Array

Default Value: null

styles - Object

Style properties used for drawing markers. This attribute is inherited from BarSeries. Below are the default values:
fill
A hash containing the following values:
color
Color of the fill. The default value is determined by the order of the series on the graph. The color will be retrieved from the below array:
["#66007f", "#a86f41", "#295454", "#996ab2", "#e8cdb7", "#90bdbd","#000000","#c3b8ca", "#968373", "#678585"]
alpha
Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.
border
A hash containing the following values:
color
Color of the border. The default value is determined by the order of the series on the graph. The color will be retrieved from the below array:
["#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.
height
indicates the width of the marker. The default value is 24.
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: stackedBar

Configuration attributes inherited from BarSeries:

Configuration attributes inherited from Base:

Configuration attributes inherited from MarkerSeries:

Configuration attributes inherited from Renderer:


Copyright © 2011 Yahoo! Inc. All rights reserved.