Yahoo! UI Library

charts  3.3.0

Yahoo! UI Library > charts > ComboSeries
Search:
 
Filters

Class ComboSeries - extends CartesianSeries - uses Fills , Lines , Plots

Known Subclasses:
ComboSplineSeries StackedComboSeries
The ComboSeries class renders a combination of lines, plots and area fills in a single series. Each series type has a corresponding boolean attribute indicating if it is rendered. By default, lines and plots are rendered and area is not.

Constructor

ComboSeries ( )

Properties inherited from Plugin.Host:

PluginHost

Properties inherited from Fills:

_defaults

Properties inherited from Attribute:

Properties inherited from Lines:

_lineDefaults

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

_getDefaultStyles

protected _getDefaultStyles ( )
Returns the default hash for the styles attribute.
Returns:
Object

drawSeries

protected void drawSeries ( )
Draws the series.

Methods inherited from Plugin.Host:

_destroyPlugins, _initPlugins, hasPlugin, plug, unplug

Methods inherited from Fills:

_getAreaDefaults, _getClosingPoints, _getStackedClosingPoints, drawAreaSpline, drawFill, drawStackedAreaSpline

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 Lines:

_getGraphic, _getLineDefaults, drawDashedLine, drawLines, drawSpline

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

Events

areaChange

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

lineChange

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

markerChange

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

showAreaFillChange

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

showLinesChange

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

showMarkersChange

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

area - Object

Reference to the styles of the area fills. These styles can also be accessed through the styles attribute. Below are the default values:
color
The 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 following array: ["#66007f", "#a86f41", "#295454", "#996ab2", "#e8cdb7", "#90bdbd","#000000","#c3b8ca", "#968373", "#678585"]
alpha
Number between 0 and 1 that indicates the opacity of the fill. The default value is 1

line - Object

Reference to the styles of the lines. These styles can also be accessed through the styles attribute. Below are the default values:
color
The color of the line. The default value is determined by the order of the series on the graph. The color will be retrieved from the following array: ["#426ab3", "#d09b2c", "#000000", "#b82837", "#b384b5", "#ff7200", "#779de3", "#cbc8ba", "#7ed7a6", "#007a6c"]
weight
Number that indicates the width of the line. The default value is 6.
alpha
Number between 0 and 1 that indicates the opacity of the line. The default value is 1.
lineType
Indicates whether the line is solid or dashed. The default value is solid.
dashLength
When the lineType is dashed, indicates the length of the dash. The default value is 10.
gapSpace
When the lineType is dashed, indicates the distance between dashes. The default value is 10.
connectDiscontinuousPoints
Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.
discontinuousType
Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.
discontinuousDashLength
When the discontinuousType is dashed, indicates the length of the dash. The default value is 10.
discontinuousGapSpace
When the discontinuousType is dashed, indicates the distance between dashes. The default value is 10.

marker - Object

Reference to the styles of the markers. These styles can also be accessed through the styles attribute. Below are 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:
["#6084d0", "#eeb647", "#6c6b5f", "#d6484f", "#ce9ed1", "#ff9f3b", "#93b7ff", "#e0ddd0", "#94ecba", "#309687"]
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 10.
height
indicates the height of the marker The default value is 10.
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.

showAreaFill - Boolean

Indicates whether a fill is displayed.
Default Value: false

showLines - Boolean

Indicates whether lines are displayed.
Default Value: true

showMarkers - Boolean

Indicates whether markers are displayed.
Default Value: true

styles - Object

Style properties for the series. Contains a key indexed hash of the following:
marker
Style properties for the markers in the series. Specific style attributes are listed here.
line
Style properties for the lines in the series. Specific style attributes are listed here.
area
Style properties for the area fills in the series. Specific style attributes are listed here.

type - String

Read-only attribute indicating the type of series.
Default Value: combo
Copyright © 2011 Yahoo! Inc. All rights reserved.