ComboSeries.js revision 11174dd4aa7b6152555e21e3e0a5a511e058415b
f69d245bb21be88752420e834a6b6be37e9b525fTripp/**
f69d245bb21be88752420e834a6b6be37e9b525fTripp * The ComboSeries class renders a combination of lines, plots and area fills in a single series. Each
f69d245bb21be88752420e834a6b6be37e9b525fTripp * series type has a corresponding boolean attribute indicating if it is rendered. By default, lines and plots
f69d245bb21be88752420e834a6b6be37e9b525fTripp * are rendered and area is not.
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @class ComboSeries
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @extends CartesianSeries
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @uses Fills
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @uses Lines
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @uses Plots
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @constructor
f69d245bb21be88752420e834a6b6be37e9b525fTripp */
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTrippY.ComboSeries = Y.Base.create("comboSeries", Y.CartesianSeries, [Y.Fills, Y.Lines, Y.Plots], {
f69d245bb21be88752420e834a6b6be37e9b525fTripp /**
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @protected
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
f69d245bb21be88752420e834a6b6be37e9b525fTripp * Draws the series.
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @method drawSeries
f69d245bb21be88752420e834a6b6be37e9b525fTripp */
f69d245bb21be88752420e834a6b6be37e9b525fTripp drawSeries: function()
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp this.get("graphic").clear();
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp if(this.get("showAreaFill"))
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp this.drawFill.apply(this, this._getClosingPoints());
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp }
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp if(this.get("showLines"))
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp this.drawLines();
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp }
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp if(this.get("showMarkers"))
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp this.drawPlots();
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp }
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp /**
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @protected
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp *
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * Returns the default hash for the <code>styles</code> attribute.
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp *
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @method _getDefaultStyles
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @return Object
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp */
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp _getDefaultStyles: function()
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp var styles = Y.ComboSeries.superclass._getDefaultStyles();
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp styles.line = this._getLineDefaults();
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp styles.marker = this._getPlotDefaults();
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp styles.area = this._getAreaDefaults();
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp return styles;
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp }
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp},
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp{
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp ATTRS: {
f69d245bb21be88752420e834a6b6be37e9b525fTripp /**
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * Read-only attribute indicating the type of series.
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp *
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @attribute type
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @type String
8648721e29bb657dd5c5ff20f03e86fe50628ce6Tripp * @default combo
f69d245bb21be88752420e834a6b6be37e9b525fTripp */
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp type: {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp value:"combo"
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
f69d245bb21be88752420e834a6b6be37e9b525fTripp /**
f69d245bb21be88752420e834a6b6be37e9b525fTripp * Indicates whether a fill is displayed.
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @attribute showAreaFill
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @type Boolean
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @default false
f69d245bb21be88752420e834a6b6be37e9b525fTripp */
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp showAreaFill: {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp value: false
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
f69d245bb21be88752420e834a6b6be37e9b525fTripp /**
f69d245bb21be88752420e834a6b6be37e9b525fTripp * Indicates whether lines are displayed.
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @attribute showLines
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @type Boolean
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @default true
f69d245bb21be88752420e834a6b6be37e9b525fTripp */
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp showLines: {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp value: true
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
f69d245bb21be88752420e834a6b6be37e9b525fTripp /**
f69d245bb21be88752420e834a6b6be37e9b525fTripp * Indicates whether markers are displayed.
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @attribute showMarkers
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @type Boolean
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @default true
f69d245bb21be88752420e834a6b6be37e9b525fTripp */
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp showMarkers: {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp value: true
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
f69d245bb21be88752420e834a6b6be37e9b525fTripp /**
f69d245bb21be88752420e834a6b6be37e9b525fTripp * Reference to the styles of the markers. These styles can also
f69d245bb21be88752420e834a6b6be37e9b525fTripp * be accessed through the <code>styles</code> attribute. Below are default
f69d245bb21be88752420e834a6b6be37e9b525fTripp * values:
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dl>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>fill</dt><dd>A hash containing the following values:
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dl>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>color</dt><dd>Color of the fill. The default value is determined by the order of the series on the graph. The color
f69d245bb21be88752420e834a6b6be37e9b525fTripp * will be retrieved from the below array:<br/>
f69d245bb21be88752420e834a6b6be37e9b525fTripp * <code>["#6084d0", "#eeb647", "#6c6b5f", "#d6484f", "#ce9ed1", "#ff9f3b", "#93b7ff", "#e0ddd0", "#94ecba", "#309687"]</code>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * </dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker fill. The default value is 1.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * </dl>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * </dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>border</dt><dd>A hash containing the following values:
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dl>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>color</dt><dd>Color of the border. The default value is determined by the order of the series on the graph. The color
f69d245bb21be88752420e834a6b6be37e9b525fTripp * will be retrieved from the below array:<br/>
f69d245bb21be88752420e834a6b6be37e9b525fTripp * <code>["#205096", "#b38206", "#000000", "#94001e", "#9d6fa0", "#e55b00", "#5e85c9", "#adab9e", "#6ac291", "#006457"]</code>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>alpha</dt><dd>Number from 0 to 1 indicating the opacity of the marker border. The default value is 1.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>weight</dt><dd>Number indicating the width of the border. The default value is 1.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * </dl>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * </dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>width</dt><dd>indicates the width of the marker. The default value is 10.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>height</dt><dd>indicates the height of the marker The default value is 10.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>over</dt><dd>hash containing styles for markers when highlighted by a <code>mouseover</code> event. The default
f69d245bb21be88752420e834a6b6be37e9b525fTripp * values for each style is null. When an over style is not set, the non-over value will be used. For example,
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * the default value for <code>marker.over.fill.color</code> is equivalent to <code>marker.fill.color</code>.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * </dl>
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @attribute marker
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @type Object
f69d245bb21be88752420e834a6b6be37e9b525fTripp */
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp marker: {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp lazyAdd: false,
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp getter: function()
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp return this.get("styles").marker;
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp setter: function(val)
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp this.set("styles", {marker:val});
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp }
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
f69d245bb21be88752420e834a6b6be37e9b525fTripp
f69d245bb21be88752420e834a6b6be37e9b525fTripp /**
f69d245bb21be88752420e834a6b6be37e9b525fTripp * Reference to the styles of the lines. These styles can also be accessed through the <code>styles</code> attribute.
f69d245bb21be88752420e834a6b6be37e9b525fTripp * Below are the default values:
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dl>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>color</dt><dd>The color of the line. The default value is determined by the order of the series on the graph. The color will be
f69d245bb21be88752420e834a6b6be37e9b525fTripp * retrieved from the following array:
f69d245bb21be88752420e834a6b6be37e9b525fTripp * <code>["#426ab3", "#d09b2c", "#000000", "#b82837", "#b384b5", "#ff7200", "#779de3", "#cbc8ba", "#7ed7a6", "#007a6c"]</code>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>weight</dt><dd>Number that indicates the width of the line. The default value is 6.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>alpha</dt><dd>Number between 0 and 1 that indicates the opacity of the line. The default value is 1.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>lineType</dt><dd>Indicates whether the line is solid or dashed. The default value is solid.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>dashLength</dt><dd>When the <code>lineType</code> is dashed, indicates the length of the dash. The default value is 10.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>gapSpace</dt><dd>When the <code>lineType</code> is dashed, indicates the distance between dashes. The default value is 10.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>connectDiscontinuousPoints</dt><dd>Indicates whether or not to connect lines when there is a missing or null value between points. The default value is true.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>discontinuousType</dt><dd>Indicates whether the line between discontinuous points is solid or dashed. The default value is solid.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>discontinuousDashLength</dt><dd>When the <code>discontinuousType</code> is dashed, indicates the length of the dash. The default value is 10.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>discontinuousGapSpace</dt><dd>When the <code>discontinuousType</code> is dashed, indicates the distance between dashes. The default value is 10.</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * </dl>
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @attribute line
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @type Object
f69d245bb21be88752420e834a6b6be37e9b525fTripp */
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp line: {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp lazyAdd: false,
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp getter: function()
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp return this.get("styles").line;
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp setter: function(val)
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp this.set("styles", {line:val});
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp }
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
f69d245bb21be88752420e834a6b6be37e9b525fTripp
f69d245bb21be88752420e834a6b6be37e9b525fTripp /**
f69d245bb21be88752420e834a6b6be37e9b525fTripp * Reference to the styles of the area fills. These styles can also be accessed through the <code>styles</code> attribute.
f69d245bb21be88752420e834a6b6be37e9b525fTripp * Below are the default values:
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dl>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>color</dt><dd>The color of the fill. The default value is determined by the order of the series on the graph. The color will be
f69d245bb21be88752420e834a6b6be37e9b525fTripp * retrieved from the following array:
f69d245bb21be88752420e834a6b6be37e9b525fTripp * <code>["#66007f", "#a86f41", "#295454", "#996ab2", "#e8cdb7", "#90bdbd","#000000","#c3b8ca", "#968373", "#678585"]</code>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * </dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * <dt>alpha</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1</dd>
11174dd4aa7b6152555e21e3e0a5a511e058415bTripp * </dl>
f69d245bb21be88752420e834a6b6be37e9b525fTripp *
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @attribute area
f69d245bb21be88752420e834a6b6be37e9b525fTripp * @type Object
f69d245bb21be88752420e834a6b6be37e9b525fTripp */
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp area: {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp lazyAdd: false,
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp getter: function()
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp return this.get("styles").area;
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp },
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp setter: function(val)
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp {
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp this.set("styles", {area:val});
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp }
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp }
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp }
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp});
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp
e393eced613f9b4a5fb6bdd461d0e0bf5064d5ecTripp