Yahoo! UI Library

charts  3.3.0

Yahoo! UI Library > charts > ColumnSeries
Search:
 
Filters

Class ColumnSeries - extends MarkerSeries - uses Histogram

Known Subclasses:
StackedColumnSeries
The ColumnSeries class renders columns positioned horizontally along a category or time axis. The columns' lengths are proportional to the values they represent along a vertical axis. and the relevant data points.

Constructor

ColumnSeries ( )

Properties inherited from Plugin.Host:

PluginHost

Properties inherited from Attribute:

Properties inherited from Histogram:

_defaultFillColors

Properties inherited from CartesianSeries:

_bottomOrigin, _defaultBorderColors, _defaultFillColors, _defaultLineColors, _defaultPlaneOffset, _defaultSliceColors, _leftOrigin, _xDisplayName, _yDisplayName, GUID

Properties inherited from Base:

name

Properties inherited from Renderer:

_styles

Properties inherited from Plots:

_hotspotCache, _hotspots, _markerCache, _markers, _plotDefaults, _stateSyles

Methods

_getMarkerDimensions

private void _getMarkerDimensions ( )

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 Plugin.Host:

_destroyPlugins, _initPlugins, hasPlugin, plug, unplug

Methods inherited from Attribute:

_addAttrs, _addLazyAttr, _defAttrChangeFn, _fireAttrChange, _getAttr, _getAttrCfg, _getAttrInitVal, _getAttrs, _getStateVal, _isLazyAttr, _normAttrVals, _protectAttrs, _set, _setAttr, _setAttrs, _setAttrVal, _setStateVal, addAttr, addAttrs, attrAdded, get, getAttrs, modifyAttr, removeAttr, reset, set, setAttrs

Methods inherited from Histogram:

_getPlotDefaults, drawSeries

Methods inherited from EventTarget:

_getType, _monitor, _parseType, addTarget, after, before, bubble, detach, detachAll, fire, getEvent, getTargets, on, once, parseType, publish, removeTarget, subscribe, unsubscribe, unsubscribeAll

Methods inherited from CartesianSeries:

_getDefaultColor, _getDefaultStyles, _setCanvas, _toggleVisible, _updateAxisData, _xAxisChangeHandler, _xDataChangeHandler, _yAxisChangeHandler, _yDataChangeHandler, addListeners, draw, render, setAreaData, validate

Methods inherited from Base:

_aggregateAttrs, _defDestroyFn, _defInitFn, _destroyHierarchy, _filterAttrCfs, _getAttrCfgs, _getClasses, _initHierarchy, _initHierarchyData, _preInitEventCfg, destroy, init, toString

Methods inherited from Renderer:

_getDefaultStyles, _mergeStyles, _setStyles

Methods inherited from Plots:

_clearHotspotCache, _clearMarkerCache, _createHotspot, _createHotspotCache, _createMarker, _createMarkerCache, _getItemColor, _getPlotDefaults, _getState, _parseMarkerStyles, _setStyles, drawPlots, getHotspot, getMarker, updateMarkerState

Methods inherited from MarkerSeries:

_getDefaultStyles, _setStyles, drawSeries, renderUI

Events

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

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:
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.
width
indicates the width of the marker. The default value is 12.
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: column

Configuration attributes inherited from CartesianSeries:

categoryDisplayName, direction, graph, graphOrder, height, order, rendered, type, valueDisplayName, visible, xAxis, xcoords xData xDisplayName xKey xMarkerPlane xMarkerPlaneOffset yAxis ycoords yData yDisplayName yKey yMarkerPlane yMarkerPlaneOffset

Configuration attributes inherited from Base:

destroyed initialized

Configuration attributes inherited from MarkerSeries:

styles type

Configuration attributes inherited from Renderer:

graphic styles

Configuration Attributes

Copyright © 2011 Yahoo! Inc. All rights reserved.