Merge pull request #161 from klausw-g/is-series-locked
[dygraphs.git] / dygraph.js
CommitLineData
88e95c46
DV
1/**
2 * @license
3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
5 */
6a1aa64f
DV
6
7/**
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
285a6bda
DV
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
6a1aa64f
DV
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
13
14 Usage:
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
285a6bda
DV
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
19 { }); // options
6a1aa64f
DV
20 </script>
21
22 The CSV file is of the form
23
285a6bda 24 Date,SeriesA,SeriesB,SeriesC
6a1aa64f
DV
25 YYYYMMDD,A1,B1,C1
26 YYYYMMDD,A2,B2,C2
27
6a1aa64f
DV
28 If the 'errorBars' option is set in the constructor, the input should be of
29 the form
285a6bda 30 Date,SeriesA,SeriesB,...
6a1aa64f
DV
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
33
34 If the 'fractions' option is set, the input should be of the form:
35
285a6bda 36 Date,SeriesA,SeriesB,...
6a1aa64f
DV
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
39
40 And error bars will be calculated automatically using a binomial distribution.
41
727439b4 42 For further documentation and examples, see http://dygraphs.com/
6a1aa64f
DV
43
44 */
45
758a629f
DV
46/*jshint globalstrict: true */
47/*global DygraphRangeSelector:false, DygraphLayout:false, DygraphCanvasRenderer:false, G_vmlCanvasManager:false */
c0f54d4f
DV
48"use strict";
49
6a1aa64f 50/**
629a09ae
DV
51 * Creates an interactive, zoomable chart.
52 *
53 * @constructor
54 * @param {div | String} div A div or the id of a div into which to construct
55 * the chart.
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
6a1aa64f 60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
629a09ae
DV
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
6a1aa64f 63 */
86a3e64f
DV
64var Dygraph = function(div, data, opts, opt_fourth_param) {
65 if (opt_fourth_param !== undefined) {
66 // Old versions of dygraphs took in the series labels as a constructor
67 // parameter. This doesn't make sense anymore, but it's easy to continue
68 // to support this usage.
69 this.warn("Using deprecated four-argument dygraph constructor");
70 this.__old_init__(div, data, opts, opt_fourth_param);
71 } else {
72 this.__init__(div, data, opts);
285a6bda 73 }
6a1aa64f
DV
74};
75
285a6bda
DV
76Dygraph.NAME = "Dygraph";
77Dygraph.VERSION = "1.2";
78Dygraph.__repr__ = function() {
6a1aa64f
DV
79 return "[" + this.NAME + " " + this.VERSION + "]";
80};
629a09ae
DV
81
82/**
83 * Returns information about the Dygraph class.
84 */
285a6bda 85Dygraph.toString = function() {
6a1aa64f
DV
86 return this.__repr__();
87};
88
89// Various default values
285a6bda
DV
90Dygraph.DEFAULT_ROLL_PERIOD = 1;
91Dygraph.DEFAULT_WIDTH = 480;
92Dygraph.DEFAULT_HEIGHT = 320;
6a1aa64f 93
b1a3b195
DV
94Dygraph.ANIMATION_STEPS = 10;
95Dygraph.ANIMATION_DURATION = 200;
96
48e614ac
DV
97// These are defined before DEFAULT_ATTRS so that it can refer to them.
98/**
99 * @private
100 * Return a string version of a number. This respects the digitsAfterDecimal
101 * and maxNumberWidth options.
102 * @param {Number} x The number to be formatted
103 * @param {Dygraph} opts An options view
104 * @param {String} name The name of the point's data series
105 * @param {Dygraph} g The dygraph object
106 */
107Dygraph.numberValueFormatter = function(x, opts, pt, g) {
108 var sigFigs = opts('sigFigs');
109
110 if (sigFigs !== null) {
111 // User has opted for a fixed number of significant figures.
112 return Dygraph.floatFormat(x, sigFigs);
113 }
114
115 var digits = opts('digitsAfterDecimal');
116 var maxNumberWidth = opts('maxNumberWidth');
117
118 // switch to scientific notation if we underflow or overflow fixed display.
119 if (x !== 0.0 &&
120 (Math.abs(x) >= Math.pow(10, maxNumberWidth) ||
121 Math.abs(x) < Math.pow(10, -digits))) {
122 return x.toExponential(digits);
123 } else {
124 return '' + Dygraph.round_(x, digits);
125 }
126};
127
128/**
129 * variant for use as an axisLabelFormatter.
130 * @private
131 */
132Dygraph.numberAxisLabelFormatter = function(x, granularity, opts, g) {
133 return Dygraph.numberValueFormatter(x, opts, g);
134};
135
136/**
137 * Convert a JS date (millis since epoch) to YYYY/MM/DD
138 * @param {Number} date The JavaScript date (ms since epoch)
139 * @return {String} A date of the form "YYYY/MM/DD"
140 * @private
141 */
142Dygraph.dateString_ = function(date) {
143 var zeropad = Dygraph.zeropad;
144 var d = new Date(date);
145
146 // Get the year:
147 var year = "" + d.getFullYear();
148 // Get a 0 padded month string
149 var month = zeropad(d.getMonth() + 1); //months are 0-offset, sigh
150 // Get a 0 padded day string
151 var day = zeropad(d.getDate());
152
153 var ret = "";
154 var frac = d.getHours() * 3600 + d.getMinutes() * 60 + d.getSeconds();
155 if (frac) ret = " " + Dygraph.hmsString_(date);
156
157 return year + "/" + month + "/" + day + ret;
158};
159
160/**
161 * Convert a JS date to a string appropriate to display on an axis that
162 * is displaying values at the stated granularity.
163 * @param {Date} date The date to format
164 * @param {Number} granularity One of the Dygraph granularity constants
165 * @return {String} The formatted date
166 * @private
167 */
168Dygraph.dateAxisFormatter = function(date, granularity) {
169 if (granularity >= Dygraph.DECADAL) {
170 return date.strftime('%Y');
171 } else if (granularity >= Dygraph.MONTHLY) {
172 return date.strftime('%b %y');
173 } else {
174 var frac = date.getHours() * 3600 + date.getMinutes() * 60 + date.getSeconds() + date.getMilliseconds();
758a629f 175 if (frac === 0 || granularity >= Dygraph.DAILY) {
48e614ac
DV
176 return new Date(date.getTime() + 3600*1000).strftime('%d%b');
177 } else {
178 return Dygraph.hmsString_(date.getTime());
179 }
180 }
181};
182
38e3d209
DV
183/**
184 * Standard plotters. These may be used by clients.
185 * Available plotters are:
186 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
187 * - Dygraph.Plotters.errorPlotter: draws error bars
188 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
189 *
190 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
191 * This causes all the lines to be drawn over all the fills/error bars.
192 */
193Dygraph.Plotters = DygraphCanvasRenderer._Plotters;
194
48e614ac 195
8e4a6af3 196// Default attribute values.
285a6bda 197Dygraph.DEFAULT_ATTRS = {
a9fc39ab 198 highlightCircleSize: 3,
857a6931 199 highlightSeriesOpts: null,
afdb20d8 200 highlightSeriesBackgroundAlpha: 0.5,
285a6bda 201
8e4a6af3
DV
202 labelsDivWidth: 250,
203 labelsDivStyles: {
204 // TODO(danvk): move defaults from createStatusMessage_ here.
285a6bda
DV
205 },
206 labelsSeparateLines: false,
bcd3ebf0 207 labelsShowZeroValues: true,
285a6bda 208 labelsKMB: false,
afefbcdb 209 labelsKMG2: false,
d160cc3b 210 showLabelsOnHighlight: true,
12e4c741 211
2e1fcf1a
DV
212 digitsAfterDecimal: 2,
213 maxNumberWidth: 6,
19589a3e 214 sigFigs: null,
285a6bda
DV
215
216 strokeWidth: 1.0,
857a6931
KW
217 strokeBorderWidth: 0,
218 strokeBorderColor: "white",
8e4a6af3 219
8846615a
DV
220 axisTickSize: 3,
221 axisLabelFontSize: 14,
222 xAxisLabelWidth: 50,
223 yAxisLabelWidth: 50,
224 rightGap: 5,
285a6bda
DV
225
226 showRoller: false,
285a6bda 227 xValueParser: Dygraph.dateParser,
285a6bda 228
3d67f03b
DV
229 delimiter: ',',
230
285a6bda
DV
231 sigma: 2.0,
232 errorBars: false,
233 fractions: false,
234 wilsonInterval: true, // only relevant if fractions is true
5954ef32 235 customBars: false,
43af96e7
NK
236 fillGraph: false,
237 fillAlpha: 0.15,
f032c51d 238 connectSeparatedPoints: false,
43af96e7
NK
239
240 stackedGraph: false,
afdc483f
NN
241 hideOverlayOnMouseOut: true,
242
2fccd3dc
DV
243 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
244 legend: 'onmouseover', // the only relevant value at the moment is 'always'.
245
00c281d4 246 stepPlot: false,
062ef401 247 avoidMinZero: false,
f4b87da2 248 drawAxesAtZero: false,
062ef401 249
ad1798c2 250 // Sizes of the various chart labels.
b4202b3d 251 titleHeight: 28,
86cce9e8
DV
252 xLabelHeight: 18,
253 yLabelWidth: 18,
ad1798c2 254
423f5ed3
DV
255 drawXAxis: true,
256 drawYAxis: true,
257 axisLineColor: "black",
990d6a35
DV
258 axisLineWidth: 0.3,
259 gridLineWidth: 0.3,
260 axisLabelColor: "black",
261 axisLabelFont: "Arial", // TODO(danvk): is this implemented?
262 axisLabelWidth: 50,
263 drawYGrid: true,
264 drawXGrid: true,
265 gridLineColor: "rgb(128,128,128)",
423f5ed3 266
48e614ac 267 interactionModel: null, // will be set to Dygraph.Interaction.defaultModel
b1a3b195 268 animatedZooms: false, // (for now)
48e614ac 269
ccd9d7c2
PF
270 // Range selector options
271 showRangeSelector: false,
272 rangeSelectorHeight: 40,
273 rangeSelectorPlotStrokeColor: "#808FAB",
274 rangeSelectorPlotFillColor: "#A7B1C4",
275
38e3d209
DV
276 // The ordering here ensures that central lines always appear above any
277 // fill bars/error bars.
278 plotter: [
279 Dygraph.Plotters.fillPlotter,
280 Dygraph.Plotters.errorPlotter,
281 Dygraph.Plotters.linePlotter
282 ],
283
48e614ac
DV
284 // per-axis options
285 axes: {
286 x: {
287 pixelsPerLabel: 60,
288 axisLabelFormatter: Dygraph.dateAxisFormatter,
289 valueFormatter: Dygraph.dateString_,
290 ticker: null // will be set in dygraph-tickers.js
291 },
292 y: {
293 pixelsPerLabel: 30,
294 valueFormatter: Dygraph.numberValueFormatter,
295 axisLabelFormatter: Dygraph.numberAxisLabelFormatter,
296 ticker: null // will be set in dygraph-tickers.js
297 },
298 y2: {
299 pixelsPerLabel: 30,
300 valueFormatter: Dygraph.numberValueFormatter,
301 axisLabelFormatter: Dygraph.numberAxisLabelFormatter,
302 ticker: null // will be set in dygraph-tickers.js
303 }
304 }
285a6bda
DV
305};
306
39b0e098
RK
307// Directions for panning and zooming. Use bit operations when combined
308// values are possible.
309Dygraph.HORIZONTAL = 1;
310Dygraph.VERTICAL = 2;
311
e2c21500
DV
312// Installed plugins, in order of precedence (most-general to most-specific).
313// Plugins are installed after they are defined, in plugins/install.js.
314Dygraph.PLUGINS = [
315];
316
5c528fa2
DV
317// Used for initializing annotation CSS rules only once.
318Dygraph.addedAnnotationCSS = false;
319
285a6bda
DV
320Dygraph.prototype.__old_init__ = function(div, file, labels, attrs) {
321 // Labels is no longer a constructor parameter, since it's typically set
322 // directly from the data source. It also conains a name for the x-axis,
323 // which the previous constructor form did not.
758a629f 324 if (labels !== null) {
285a6bda
DV
325 var new_labels = ["Date"];
326 for (var i = 0; i < labels.length; i++) new_labels.push(labels[i]);
fc80a396 327 Dygraph.update(attrs, { 'labels': new_labels });
285a6bda
DV
328 }
329 this.__init__(div, file, attrs);
8e4a6af3
DV
330};
331
6a1aa64f 332/**
285a6bda 333 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
7aedf6fe 334 * and context &lt;canvas&gt; inside of it. See the constructor for details.
6a1aa64f 335 * on the parameters.
12e4c741 336 * @param {Element} div the Element to render the graph into.
6a1aa64f 337 * @param {String | Function} file Source data
6a1aa64f
DV
338 * @param {Object} attrs Miscellaneous other options
339 * @private
340 */
285a6bda 341Dygraph.prototype.__init__ = function(div, file, attrs) {
a2c8fff4
DV
342 // Hack for IE: if we're using excanvas and the document hasn't finished
343 // loading yet (and hence may not have initialized whatever it needs to
344 // initialize), then keep calling this routine periodically until it has.
345 if (/MSIE/.test(navigator.userAgent) && !window.opera &&
346 typeof(G_vmlCanvasManager) != 'undefined' &&
347 document.readyState != 'complete') {
348 var self = this;
758a629f 349 setTimeout(function() { self.__init__(div, file, attrs); }, 100);
ccd9d7c2 350 return;
a2c8fff4
DV
351 }
352
285a6bda 353 // Support two-argument constructor
758a629f 354 if (attrs === null || attrs === undefined) { attrs = {}; }
285a6bda 355
48e614ac
DV
356 attrs = Dygraph.mapLegacyOptions_(attrs);
357
358 if (!div) {
359 Dygraph.error("Constructing dygraph with a non-existent div!");
360 return;
361 }
362
920208fb
PF
363 this.isUsingExcanvas_ = typeof(G_vmlCanvasManager) != 'undefined';
364
6a1aa64f 365 // Copy the important bits into the object
32988383 366 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
6a1aa64f 367 this.maindiv_ = div;
6a1aa64f 368 this.file_ = file;
285a6bda 369 this.rollPeriod_ = attrs.rollPeriod || Dygraph.DEFAULT_ROLL_PERIOD;
6a1aa64f 370 this.previousVerticalX_ = -1;
6a1aa64f 371 this.fractions_ = attrs.fractions || false;
6a1aa64f 372 this.dateWindow_ = attrs.dateWindow || null;
8b83c6cc 373
fe0b7c03 374 this.is_initial_draw_ = true;
5c528fa2 375 this.annotations_ = [];
7aedf6fe 376
45f2c689 377 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
57baab03
NN
378 this.zoomed_x_ = false;
379 this.zoomed_y_ = false;
45f2c689 380
f7d6278e
DV
381 // Clear the div. This ensure that, if multiple dygraphs are passed the same
382 // div, then only one will be drawn.
383 div.innerHTML = "";
384
0cb9bd91
DV
385 // For historical reasons, the 'width' and 'height' options trump all CSS
386 // rules _except_ for an explicit 'width' or 'height' on the div.
387 // As an added convenience, if the div has zero height (like <div></div> does
388 // without any styles), then we use a default height/width.
758a629f 389 if (div.style.width === '' && attrs.width) {
0cb9bd91 390 div.style.width = attrs.width + "px";
285a6bda 391 }
758a629f 392 if (div.style.height === '' && attrs.height) {
0cb9bd91 393 div.style.height = attrs.height + "px";
32988383 394 }
758a629f 395 if (div.style.height === '' && div.clientHeight === 0) {
0cb9bd91 396 div.style.height = Dygraph.DEFAULT_HEIGHT + "px";
758a629f 397 if (div.style.width === '') {
0cb9bd91
DV
398 div.style.width = Dygraph.DEFAULT_WIDTH + "px";
399 }
c21d2c2d 400 }
fffad740 401 // these will be zero if the dygraph's div is hidden.
ccd9d7c2
PF
402 this.width_ = div.clientWidth;
403 this.height_ = div.clientHeight;
32988383 404
344ba8c0 405 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
758a629f
DV
406 if (attrs.stackedGraph) {
407 attrs.fillGraph = true;
43af96e7
NK
408 // TODO(nikhilk): Add any other stackedGraph checks here.
409 }
410
e71332d6
DV
411 // These two options have a bad interaction. See issue 359.
412 if (attrs.showRangeSelector && attrs.animatedZooms) {
413 this.warn('You should not set animatedZooms=true when using the range selector.');
414 attrs.animatedZooms = false;
415 }
416
285a6bda
DV
417 // Dygraphs has many options, some of which interact with one another.
418 // To keep track of everything, we maintain two sets of options:
419 //
c21d2c2d 420 // this.user_attrs_ only options explicitly set by the user.
285a6bda
DV
421 // this.attrs_ defaults, options derived from user_attrs_, data.
422 //
423 // Options are then accessed this.attr_('attr'), which first looks at
424 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
425 // defaults without overriding behavior that the user specifically asks for.
426 this.user_attrs_ = {};
fc80a396 427 Dygraph.update(this.user_attrs_, attrs);
6a1aa64f 428
48e614ac 429 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
285a6bda 430 this.attrs_ = {};
48e614ac 431 Dygraph.updateDeep(this.attrs_, Dygraph.DEFAULT_ATTRS);
6a1aa64f 432
16269f6e 433 this.boundaryIds_ = [];
82c6fe4d 434 this.setIndexByName_ = {};
857a6931 435 this.datasetIndex_ = [];
6a1aa64f 436
6a4587ac 437 this.registeredEvents_ = [];
de8f284f 438 this.eventListeners_ = {};
6a4587ac 439
6a1aa64f
DV
440 // Create the containing DIV and other interactive elements
441 this.createInterface_();
442
e2c21500
DV
443 // Activate plugins.
444 this.plugins_ = [];
445 for (var i = 0; i < Dygraph.PLUGINS.length; i++) {
42a9ebb8
DV
446 var Plugin = Dygraph.PLUGINS[i];
447 var pluginInstance = new Plugin();
e2c21500
DV
448 var pluginDict = {
449 plugin: pluginInstance,
450 events: {},
451 options: {},
452 pluginOptions: {}
453 };
454
6a4457b4
KW
455 var handlers = pluginInstance.activate(this);
456 for (var eventName in handlers) {
28aa77ac 457 // TODO(danvk): validate eventName.
6a4457b4
KW
458 pluginDict.events[eventName] = handlers[eventName];
459 }
e2c21500
DV
460
461 this.plugins_.push(pluginDict);
462 }
463
464 // At this point, plugins can no longer register event handlers.
465 // Construct a map from event -> ordered list of [callback, plugin].
e2c21500
DV
466 for (var i = 0; i < this.plugins_.length; i++) {
467 var plugin_dict = this.plugins_[i];
468 for (var eventName in plugin_dict.events) {
469 if (!plugin_dict.events.hasOwnProperty(eventName)) continue;
470 var callback = plugin_dict.events[eventName];
471
472 var pair = [plugin_dict.plugin, callback];
473 if (!(eventName in this.eventListeners_)) {
474 this.eventListeners_[eventName] = [pair];
475 } else {
476 this.eventListeners_[eventName].push(pair);
477 }
478 }
479 }
480
738fc797 481 this.start_();
6a1aa64f
DV
482};
483
dcb25130 484/**
e2c21500
DV
485 * Triggers a cascade of events to the various plugins which are interested in them.
486 * Returns true if the "default behavior" should be performed, i.e. if none of
487 * the event listeners called event.preventDefault().
488 * @private
489 */
490Dygraph.prototype.cascadeEvents_ = function(name, extra_props) {
42a9ebb8 491 if (!(name in this.eventListeners_)) return true;
e2c21500
DV
492
493 // QUESTION: can we use objects & prototypes to speed this up?
494 var e = {
495 dygraph: this,
496 cancelable: false,
497 defaultPrevented: false,
498 preventDefault: function() {
499 if (!e.cancelable) throw "Cannot call preventDefault on non-cancelable event.";
500 e.defaultPrevented = true;
501 },
502 propagationStopped: false,
503 stopPropagation: function() {
5bd29cf4 504 e.propagationStopped = true;
e2c21500
DV
505 }
506 };
507 Dygraph.update(e, extra_props);
508
509 var callback_plugin_pairs = this.eventListeners_[name];
da1c187b
KW
510 if (callback_plugin_pairs) {
511 for (var i = callback_plugin_pairs.length - 1; i >= 0; i--) {
512 var plugin = callback_plugin_pairs[i][0];
513 var callback = callback_plugin_pairs[i][1];
514 callback.call(plugin, e);
515 if (e.propagationStopped) break;
516 }
e2c21500
DV
517 }
518 return e.defaultPrevented;
519};
520
521/**
dcb25130
NN
522 * Returns the zoomed status of the chart for one or both axes.
523 *
524 * Axis is an optional parameter. Can be set to 'x' or 'y'.
525 *
526 * The zoomed status for an axis is set whenever a user zooms using the mouse
42a9ebb8
DV
527 * or when the dateWindow or valueRange are updated (unless the
528 * isZoomedIgnoreProgrammaticZoom option is also specified).
dcb25130 529 */
57baab03 530Dygraph.prototype.isZoomed = function(axis) {
42a9ebb8
DV
531 if (axis === null || axis === undefined) {
532 return this.zoomed_x_ || this.zoomed_y_;
533 }
758a629f
DV
534 if (axis === 'x') return this.zoomed_x_;
535 if (axis === 'y') return this.zoomed_y_;
94ea5744 536 throw "axis parameter is [" + axis + "] must be null, 'x' or 'y'.";
57baab03
NN
537};
538
629a09ae
DV
539/**
540 * Returns information about the Dygraph object, including its containing ID.
541 */
22bd1dfb
RK
542Dygraph.prototype.toString = function() {
543 var maindiv = this.maindiv_;
758a629f 544 var id = (maindiv && maindiv.id) ? maindiv.id : maindiv;
22bd1dfb 545 return "[Dygraph " + id + "]";
758a629f 546};
22bd1dfb 547
629a09ae
DV
548/**
549 * @private
550 * Returns the value of an option. This may be set by the user (either in the
551 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
552 * per-series value.
553 * @param { String } name The name of the option, e.g. 'rollPeriod'.
554 * @param { String } [seriesName] The name of the series to which the option
555 * will be applied. If no per-series value of this option is available, then
556 * the global value is returned. This is optional.
557 * @return { ... } The value of the option.
558 */
227b93cc 559Dygraph.prototype.attr_ = function(name, seriesName) {
028ddf8a
DV
560// <REMOVE_FOR_COMBINED>
561 if (typeof(Dygraph.OPTIONS_REFERENCE) === 'undefined') {
562 this.error('Must include options reference JS for testing');
563 } else if (!Dygraph.OPTIONS_REFERENCE.hasOwnProperty(name)) {
564 this.error('Dygraphs is using property ' + name + ', which has no entry ' +
565 'in the Dygraphs.OPTIONS_REFERENCE listing.');
566 // Only log this error once.
567 Dygraph.OPTIONS_REFERENCE[name] = true;
568 }
569// </REMOVE_FOR_COMBINED>
857a6931
KW
570
571 var sources = [];
572 sources.push(this.attrs_);
475f7420
KW
573 if (this.user_attrs_) {
574 sources.push(this.user_attrs_);
575 if (seriesName) {
576 if (this.user_attrs_.hasOwnProperty(seriesName)) {
577 sources.push(this.user_attrs_[seriesName]);
578 }
579 if (seriesName === this.highlightSet_ &&
580 this.user_attrs_.hasOwnProperty('highlightSeriesOpts')) {
42a9ebb8 581 sources.push(this.user_attrs_.highlightSeriesOpts);
475f7420 582 }
857a6931 583 }
285a6bda 584 }
857a6931
KW
585
586 var ret = null;
587 for (var i = sources.length - 1; i >= 0; --i) {
588 var source = sources[i];
589 if (source.hasOwnProperty(name)) {
590 ret = source[name];
591 break;
592 }
285a6bda 593 }
857a6931 594 return ret;
285a6bda
DV
595};
596
6a1aa64f 597/**
e2c21500
DV
598 * Returns the current value for an option, as set in the constructor or via
599 * updateOptions. You may pass in an (optional) series name to get per-series
600 * values for the option.
601 *
602 * All values returned by this method should be considered immutable. If you
603 * modify them, there is no guarantee that the changes will be honored or that
604 * dygraphs will remain in a consistent state. If you want to modify an option,
605 * use updateOptions() instead.
606 *
607 * @param { String } name The name of the option (e.g. 'strokeWidth')
608 * @param { String } [opt_seriesName] Series name to get per-series values.
609 * @return { ... } The value of the option.
610 */
611Dygraph.prototype.getOption = function(name, opt_seriesName) {
612 return this.attr_(name, opt_seriesName);
613};
614
615/**
48e614ac
DV
616 * @private
617 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
618 * @return { ... } A function mapping string -> option value
619 */
620Dygraph.prototype.optionsViewForAxis_ = function(axis) {
621 var self = this;
622 return function(opt) {
758a629f 623 var axis_opts = self.user_attrs_.axes;
48e614ac
DV
624 if (axis_opts && axis_opts[axis] && axis_opts[axis][opt]) {
625 return axis_opts[axis][opt];
626 }
627 // user-specified attributes always trump defaults, even if they're less
628 // specific.
629 if (typeof(self.user_attrs_[opt]) != 'undefined') {
630 return self.user_attrs_[opt];
631 }
632
758a629f 633 axis_opts = self.attrs_.axes;
48e614ac
DV
634 if (axis_opts && axis_opts[axis] && axis_opts[axis][opt]) {
635 return axis_opts[axis][opt];
636 }
637 // check old-style axis options
638 // TODO(danvk): add a deprecation warning if either of these match.
639 if (axis == 'y' && self.axes_[0].hasOwnProperty(opt)) {
640 return self.axes_[0][opt];
641 } else if (axis == 'y2' && self.axes_[1].hasOwnProperty(opt)) {
642 return self.axes_[1][opt];
643 }
644 return self.attr_(opt);
645 };
646};
647
648/**
6a1aa64f 649 * Returns the current rolling period, as set by the user or an option.
6faebb69 650 * @return {Number} The number of points in the rolling window
6a1aa64f 651 */
285a6bda 652Dygraph.prototype.rollPeriod = function() {
6a1aa64f 653 return this.rollPeriod_;
76171648
DV
654};
655
599fb4ad
DV
656/**
657 * Returns the currently-visible x-range. This can be affected by zooming,
658 * panning or a call to updateOptions.
659 * Returns a two-element array: [left, right].
660 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
661 */
662Dygraph.prototype.xAxisRange = function() {
4cac8c7a
RK
663 return this.dateWindow_ ? this.dateWindow_ : this.xAxisExtremes();
664};
599fb4ad 665
4cac8c7a
RK
666/**
667 * Returns the lower- and upper-bound x-axis values of the
668 * data set.
669 */
670Dygraph.prototype.xAxisExtremes = function() {
599fb4ad
DV
671 var left = this.rawData_[0][0];
672 var right = this.rawData_[this.rawData_.length - 1][0];
673 return [left, right];
674};
675
3230c662 676/**
d58ae307
DV
677 * Returns the currently-visible y-range for an axis. This can be affected by
678 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
679 * called with no arguments, returns the range of the first axis.
3230c662
DV
680 * Returns a two-element array: [bottom, top].
681 */
d58ae307 682Dygraph.prototype.yAxisRange = function(idx) {
d63e6799 683 if (typeof(idx) == "undefined") idx = 0;
d64b8fea
RK
684 if (idx < 0 || idx >= this.axes_.length) {
685 return null;
686 }
687 var axis = this.axes_[idx];
688 return [ axis.computedValueRange[0], axis.computedValueRange[1] ];
d58ae307
DV
689};
690
691/**
692 * Returns the currently-visible y-ranges for each axis. This can be affected by
693 * zooming, panning, calls to updateOptions, etc.
694 * Returns an array of [bottom, top] pairs, one for each y-axis.
695 */
696Dygraph.prototype.yAxisRanges = function() {
697 var ret = [];
698 for (var i = 0; i < this.axes_.length; i++) {
699 ret.push(this.yAxisRange(i));
700 }
701 return ret;
3230c662
DV
702};
703
d58ae307 704// TODO(danvk): use these functions throughout dygraphs.
3230c662
DV
705/**
706 * Convert from data coordinates to canvas/div X/Y coordinates.
d58ae307
DV
707 * If specified, do this conversion for the coordinate system of a particular
708 * axis. Uses the first axis by default.
3230c662 709 * Returns a two-element array: [X, Y]
ff022deb 710 *
0747928a 711 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
ff022deb 712 * instead of toDomCoords(null, y, axis).
3230c662 713 */
d58ae307 714Dygraph.prototype.toDomCoords = function(x, y, axis) {
ff022deb
RK
715 return [ this.toDomXCoord(x), this.toDomYCoord(y, axis) ];
716};
717
718/**
719 * Convert from data x coordinates to canvas/div X coordinate.
720 * If specified, do this conversion for the coordinate system of a particular
0037b2a4
RK
721 * axis.
722 * Returns a single value or null if x is null.
ff022deb
RK
723 */
724Dygraph.prototype.toDomXCoord = function(x) {
758a629f 725 if (x === null) {
ff022deb 726 return null;
758a629f 727 }
ff022deb 728
3230c662 729 var area = this.plotter_.area;
ff022deb
RK
730 var xRange = this.xAxisRange();
731 return area.x + (x - xRange[0]) / (xRange[1] - xRange[0]) * area.w;
758a629f 732};
3230c662 733
ff022deb
RK
734/**
735 * Convert from data x coordinates to canvas/div Y coordinate and optional
736 * axis. Uses the first axis by default.
737 *
738 * returns a single value or null if y is null.
739 */
740Dygraph.prototype.toDomYCoord = function(y, axis) {
0747928a 741 var pct = this.toPercentYCoord(y, axis);
3230c662 742
758a629f 743 if (pct === null) {
ff022deb
RK
744 return null;
745 }
e4416fb9 746 var area = this.plotter_.area;
ff022deb 747 return area.y + pct * area.h;
758a629f 748};
3230c662
DV
749
750/**
751 * Convert from canvas/div coords to data coordinates.
d58ae307
DV
752 * If specified, do this conversion for the coordinate system of a particular
753 * axis. Uses the first axis by default.
ff022deb
RK
754 * Returns a two-element array: [X, Y].
755 *
0747928a 756 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
ff022deb 757 * instead of toDataCoords(null, y, axis).
3230c662 758 */
d58ae307 759Dygraph.prototype.toDataCoords = function(x, y, axis) {
ff022deb
RK
760 return [ this.toDataXCoord(x), this.toDataYCoord(y, axis) ];
761};
762
763/**
764 * Convert from canvas/div x coordinate to data coordinate.
765 *
766 * If x is null, this returns null.
767 */
768Dygraph.prototype.toDataXCoord = function(x) {
758a629f 769 if (x === null) {
ff022deb 770 return null;
3230c662
DV
771 }
772
ff022deb
RK
773 var area = this.plotter_.area;
774 var xRange = this.xAxisRange();
775 return xRange[0] + (x - area.x) / area.w * (xRange[1] - xRange[0]);
776};
777
778/**
779 * Convert from canvas/div y coord to value.
780 *
781 * If y is null, this returns null.
782 * if axis is null, this uses the first axis.
783 */
784Dygraph.prototype.toDataYCoord = function(y, axis) {
758a629f 785 if (y === null) {
ff022deb 786 return null;
3230c662
DV
787 }
788
ff022deb
RK
789 var area = this.plotter_.area;
790 var yRange = this.yAxisRange(axis);
791
b70247dc
RK
792 if (typeof(axis) == "undefined") axis = 0;
793 if (!this.axes_[axis].logscale) {
d9816e62 794 return yRange[0] + (area.y + area.h - y) / area.h * (yRange[1] - yRange[0]);
ff022deb
RK
795 } else {
796 // Computing the inverse of toDomCoord.
758a629f 797 var pct = (y - area.y) / area.h;
ff022deb
RK
798
799 // Computing the inverse of toPercentYCoord. The function was arrived at with
800 // the following steps:
801 //
802 // Original calcuation:
d59b6f34 803 // pct = (logr1 - Dygraph.log10(y)) / (logr1 - Dygraph.log10(yRange[0]));
ff022deb
RK
804 //
805 // Move denominator to both sides:
d59b6f34 806 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
ff022deb
RK
807 //
808 // subtract logr1, and take the negative value.
d59b6f34 809 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
ff022deb
RK
810 //
811 // Swap both sides of the equation, and we can compute the log of the
812 // return value. Which means we just need to use that as the exponent in
813 // e^exponent.
d59b6f34 814 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
ff022deb 815
d59b6f34
RK
816 var logr1 = Dygraph.log10(yRange[1]);
817 var exponent = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
818 var value = Math.pow(Dygraph.LOG_SCALE, exponent);
ff022deb
RK
819 return value;
820 }
3230c662
DV
821};
822
e99fde05 823/**
ff022deb 824 * Converts a y for an axis to a percentage from the top to the
4cac8c7a 825 * bottom of the drawing area.
ff022deb
RK
826 *
827 * If the coordinate represents a value visible on the canvas, then
828 * the value will be between 0 and 1, where 0 is the top of the canvas.
829 * However, this method will return values outside the range, as
830 * values can fall outside the canvas.
831 *
832 * If y is null, this returns null.
833 * if axis is null, this uses the first axis.
629a09ae
DV
834 *
835 * @param { Number } y The data y-coordinate.
836 * @param { Number } [axis] The axis number on which the data coordinate lives.
837 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
ff022deb
RK
838 */
839Dygraph.prototype.toPercentYCoord = function(y, axis) {
758a629f 840 if (y === null) {
ff022deb
RK
841 return null;
842 }
7d0e7a0d 843 if (typeof(axis) == "undefined") axis = 0;
ff022deb 844
ff022deb
RK
845 var yRange = this.yAxisRange(axis);
846
847 var pct;
7d0e7a0d 848 if (!this.axes_[axis].logscale) {
4cac8c7a
RK
849 // yRange[1] - y is unit distance from the bottom.
850 // yRange[1] - yRange[0] is the scale of the range.
ff022deb
RK
851 // (yRange[1] - y) / (yRange[1] - yRange[0]) is the % from the bottom.
852 pct = (yRange[1] - y) / (yRange[1] - yRange[0]);
853 } else {
d59b6f34
RK
854 var logr1 = Dygraph.log10(yRange[1]);
855 pct = (logr1 - Dygraph.log10(y)) / (logr1 - Dygraph.log10(yRange[0]));
ff022deb
RK
856 }
857 return pct;
758a629f 858};
ff022deb
RK
859
860/**
4cac8c7a
RK
861 * Converts an x value to a percentage from the left to the right of
862 * the drawing area.
863 *
864 * If the coordinate represents a value visible on the canvas, then
865 * the value will be between 0 and 1, where 0 is the left of the canvas.
866 * However, this method will return values outside the range, as
867 * values can fall outside the canvas.
868 *
869 * If x is null, this returns null.
629a09ae
DV
870 * @param { Number } x The data x-coordinate.
871 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
4cac8c7a
RK
872 */
873Dygraph.prototype.toPercentXCoord = function(x) {
758a629f 874 if (x === null) {
4cac8c7a
RK
875 return null;
876 }
877
4cac8c7a 878 var xRange = this.xAxisRange();
965a030e 879 return (x - xRange[0]) / (xRange[1] - xRange[0]);
629a09ae 880};
4cac8c7a
RK
881
882/**
e99fde05 883 * Returns the number of columns (including the independent variable).
629a09ae 884 * @return { Integer } The number of columns.
e99fde05
DV
885 */
886Dygraph.prototype.numColumns = function() {
395e98a3 887 return this.rawData_[0] ? this.rawData_[0].length : this.attr_("labels").length;
e99fde05
DV
888};
889
890/**
891 * Returns the number of rows (excluding any header/label row).
629a09ae 892 * @return { Integer } The number of rows, less any header.
e99fde05
DV
893 */
894Dygraph.prototype.numRows = function() {
895 return this.rawData_.length;
896};
897
898/**
395e98a3
DV
899 * Returns the full range of the x-axis, as determined by the most extreme
900 * values in the data set. Not affected by zooming, visibility, etc.
769e8bc7 901 * TODO(danvk): merge w/ xAxisExtremes
395e98a3
DV
902 * @return { Array<Number> } A [low, high] pair
903 * @private
904 */
905Dygraph.prototype.fullXRange_ = function() {
906 if (this.numRows() > 0) {
907 return [this.rawData_[0][0], this.rawData_[this.numRows() - 1][0]];
908 } else {
909 return [0, 1];
910 }
758a629f 911};
395e98a3
DV
912
913/**
e99fde05
DV
914 * Returns the value in the given row and column. If the row and column exceed
915 * the bounds on the data, returns null. Also returns null if the value is
916 * missing.
629a09ae
DV
917 * @param { Number} row The row number of the data (0-based). Row 0 is the
918 * first row of data, not a header row.
919 * @param { Number} col The column number of the data (0-based)
920 * @return { Number } The value in the specified cell or null if the row/col
921 * were out of range.
e99fde05
DV
922 */
923Dygraph.prototype.getValue = function(row, col) {
924 if (row < 0 || row > this.rawData_.length) return null;
925 if (col < 0 || col > this.rawData_[row].length) return null;
926
927 return this.rawData_[row][col];
928};
929
629a09ae 930/**
285a6bda 931 * Generates interface elements for the Dygraph: a containing div, a div to
6a1aa64f 932 * display the current point, and a textbox to adjust the rolling average
697e70b2 933 * period. Also creates the Renderer/Layout elements.
6a1aa64f
DV
934 * @private
935 */
285a6bda 936Dygraph.prototype.createInterface_ = function() {
6a1aa64f
DV
937 // Create the all-enclosing graph div
938 var enclosing = this.maindiv_;
939
b0c3b730
DV
940 this.graphDiv = document.createElement("div");
941 this.graphDiv.style.width = this.width_ + "px";
942 this.graphDiv.style.height = this.height_ + "px";
943 enclosing.appendChild(this.graphDiv);
944
945 // Create the canvas for interactive parts of the chart.
f8cfec73 946 this.canvas_ = Dygraph.createCanvas();
b0c3b730
DV
947 this.canvas_.style.position = "absolute";
948 this.canvas_.width = this.width_;
949 this.canvas_.height = this.height_;
f8cfec73
DV
950 this.canvas_.style.width = this.width_ + "px"; // for IE
951 this.canvas_.style.height = this.height_ + "px"; // for IE
b0c3b730 952
2cf95fff
RK
953 this.canvas_ctx_ = Dygraph.getContext(this.canvas_);
954
b0c3b730 955 // ... and for static parts of the chart.
6a1aa64f 956 this.hidden_ = this.createPlotKitCanvas_(this.canvas_);
2cf95fff 957 this.hidden_ctx_ = Dygraph.getContext(this.hidden_);
76171648 958
ccd9d7c2
PF
959 if (this.attr_('showRangeSelector')) {
960 // The range selector must be created here so that its canvases and contexts get created here.
961 // For some reason, if the canvases and contexts don't get created here, things don't work in IE.
ccd9d7c2
PF
962 this.rangeSelector_ = new DygraphRangeSelector(this);
963 }
964
eb7bf005
EC
965 // The interactive parts of the graph are drawn on top of the chart.
966 this.graphDiv.appendChild(this.hidden_);
967 this.graphDiv.appendChild(this.canvas_);
920208fb
PF
968 this.mouseEventElement_ = this.createMouseEventElement_();
969
970 // Create the grapher
971 this.layout_ = new DygraphLayout(this);
972
973 if (this.rangeSelector_) {
974 // This needs to happen after the graph canvases are added to the div and the layout object is created.
975 this.rangeSelector_.addToGraph(this.graphDiv, this.layout_);
976 }
eb7bf005 977
76171648 978 var dygraph = this;
de8f284f 979
d7eddd78 980 this.mouseMoveHandler = function(e) {
421f1773 981 dygraph.mouseMove_(e);
d7eddd78 982 };
6a4587ac 983 this.addEvent(this.mouseEventElement_, 'mousemove', this.mouseMoveHandler);
de8f284f 984
d7eddd78 985 this.mouseOutHandler = function(e) {
421f1773 986 dygraph.mouseOut_(e);
d7eddd78 987 };
6a4587ac 988 this.addEvent(this.mouseEventElement_, 'mouseout', this.mouseOutHandler);
697e70b2 989
697e70b2 990 this.createDragInterface_();
4b4d1a63 991
1c6b239c 992 this.resizeHandler = function(e) {
993 dygraph.resize();
d7eddd78 994 };
1c6b239c 995
4b4d1a63
DV
996 // Update when the window is resized.
997 // TODO(danvk): drop frames depending on complexity of the chart.
6a4587ac 998 this.addEvent(window, 'resize', this.resizeHandler);
4cfcc38c
DV
999};
1000
1001/**
1002 * Detach DOM elements in the dygraph and null out all data references.
1003 * Calling this when you're done with a dygraph can dramatically reduce memory
1004 * usage. See, e.g., the tests/perf.html example.
1005 */
1006Dygraph.prototype.destroy = function() {
1007 var removeRecursive = function(node) {
1008 while (node.hasChildNodes()) {
1009 removeRecursive(node.firstChild);
1010 node.removeChild(node.firstChild);
1011 }
1012 };
de8f284f 1013
6a4587ac
RK
1014 for (var idx = 0; idx < this.registeredEvents_.length; idx++) {
1015 var reg = this.registeredEvents_[idx];
1cc3540b 1016 Dygraph.removeEvent(reg.elem, reg.type, reg.fn);
6a4587ac
RK
1017 }
1018 this.registeredEvents_ = [];
1019
1020 // remove mouse event handlers (This may not be necessary anymore)
1cc3540b
RK
1021 Dygraph.removeEvent(this.mouseEventElement_, 'mouseout', this.mouseOutHandler);
1022 Dygraph.removeEvent(this.mouseEventElement_, 'mousemove', this.mouseMoveHandler);
1023 Dygraph.removeEvent(this.mouseEventElement_, 'mousemove', this.mouseUpHandler_);
4cfcc38c
DV
1024 removeRecursive(this.maindiv_);
1025
1026 var nullOut = function(obj) {
1027 for (var n in obj) {
1028 if (typeof(obj[n]) === 'object') {
1029 obj[n] = null;
1030 }
1031 }
1032 };
1c6b239c 1033 // remove event handlers
1cc3540b 1034 Dygraph.removeEvent(window,'resize',this.resizeHandler);
1c6b239c 1035 this.resizeHandler = null;
4cfcc38c
DV
1036 // These may not all be necessary, but it can't hurt...
1037 nullOut(this.layout_);
1038 nullOut(this.plotter_);
1039 nullOut(this);
1040};
6a1aa64f
DV
1041
1042/**
629a09ae
DV
1043 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1044 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1045 * or the zoom rectangles) is done on this.canvas_.
8846615a 1046 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
6a1aa64f
DV
1047 * @return {Object} The newly-created canvas
1048 * @private
1049 */
285a6bda 1050Dygraph.prototype.createPlotKitCanvas_ = function(canvas) {
f8cfec73 1051 var h = Dygraph.createCanvas();
6a1aa64f 1052 h.style.position = "absolute";
9ac5e4ae
DV
1053 // TODO(danvk): h should be offset from canvas. canvas needs to include
1054 // some extra area to make it easier to zoom in on the far left and far
1055 // right. h needs to be precisely the plot area, so that clipping occurs.
6a1aa64f
DV
1056 h.style.top = canvas.style.top;
1057 h.style.left = canvas.style.left;
1058 h.width = this.width_;
1059 h.height = this.height_;
f8cfec73
DV
1060 h.style.width = this.width_ + "px"; // for IE
1061 h.style.height = this.height_ + "px"; // for IE
6a1aa64f
DV
1062 return h;
1063};
1064
629a09ae 1065/**
920208fb
PF
1066 * Creates an overlay element used to handle mouse events.
1067 * @return {Object} The mouse event element.
1068 * @private
1069 */
1070Dygraph.prototype.createMouseEventElement_ = function() {
1071 if (this.isUsingExcanvas_) {
1072 var elem = document.createElement("div");
1073 elem.style.position = 'absolute';
1074 elem.style.backgroundColor = 'white';
1075 elem.style.filter = 'alpha(opacity=0)';
1076 elem.style.width = this.width_ + "px";
1077 elem.style.height = this.height_ + "px";
1078 this.graphDiv.appendChild(elem);
1079 return elem;
1080 } else {
1081 return this.canvas_;
1082 }
1083};
1084
1085/**
6a1aa64f
DV
1086 * Generate a set of distinct colors for the data series. This is done with a
1087 * color wheel. Saturation/Value are customizable, and the hue is
1088 * equally-spaced around the color wheel. If a custom set of colors is
1089 * specified, that is used instead.
6a1aa64f
DV
1090 * @private
1091 */
285a6bda 1092Dygraph.prototype.setColors_ = function() {
ee53deb9
DV
1093 var labels = this.getLabels();
1094 var num = labels.length - 1;
6a1aa64f 1095 this.colors_ = [];
ee53deb9 1096 this.colorsMap_ = {};
285a6bda 1097 var colors = this.attr_('colors');
758a629f 1098 var i;
285a6bda
DV
1099 if (!colors) {
1100 var sat = this.attr_('colorSaturation') || 1.0;
1101 var val = this.attr_('colorValue') || 0.5;
2aa21213 1102 var half = Math.ceil(num / 2);
758a629f 1103 for (i = 1; i <= num; i++) {
ec1959eb 1104 if (!this.visibility()[i-1]) continue;
43af96e7 1105 // alternate colors for high contrast.
2aa21213 1106 var idx = i % 2 ? Math.ceil(i / 2) : (half + i / 2);
43af96e7 1107 var hue = (1.0 * idx/ (1 + num));
ee53deb9
DV
1108 var colorStr = Dygraph.hsvToRGB(hue, sat, val);
1109 this.colors_.push(colorStr);
1110 this.colorsMap_[labels[i]] = colorStr;
6a1aa64f
DV
1111 }
1112 } else {
758a629f 1113 for (i = 0; i < num; i++) {
ec1959eb 1114 if (!this.visibility()[i]) continue;
285a6bda 1115 var colorStr = colors[i % colors.length];
f474c2a3 1116 this.colors_.push(colorStr);
ee53deb9 1117 this.colorsMap_[labels[1 + i]] = colorStr;
6a1aa64f
DV
1118 }
1119 }
629a09ae 1120};
6a1aa64f 1121
43af96e7
NK
1122/**
1123 * Return the list of colors. This is either the list of colors passed in the
629a09ae 1124 * attributes or the autogenerated list of rgb(r,g,b) strings.
e2c21500 1125 * This does not return colors for invisible series.
43af96e7
NK
1126 * @return {Array<string>} The list of colors.
1127 */
1128Dygraph.prototype.getColors = function() {
1129 return this.colors_;
1130};
1131
6a1aa64f 1132/**
e2c21500
DV
1133 * Returns a few attributes of a series, i.e. its color, its visibility, which
1134 * axis it's assigned to, and its column in the original data.
1135 * Returns null if the series does not exist.
1136 * Otherwise, returns an object with column, visibility, color and axis properties.
1137 * The "axis" property will be set to 1 for y1 and 2 for y2.
1138 * The "column" property can be fed back into getValue(row, column) to get
1139 * values for this series.
6a1aa64f 1140 */
e2c21500
DV
1141Dygraph.prototype.getPropertiesForSeries = function(series_name) {
1142 var idx = -1;
1143 var labels = this.getLabels();
1144 for (var i = 1; i < labels.length; i++) {
1145 if (labels[i] == series_name) {
1146 idx = i;
1147 break;
b0c3b730 1148 }
6a1aa64f 1149 }
e2c21500 1150 if (idx == -1) return null;
0abfbd7e 1151
e2c21500
DV
1152 return {
1153 name: series_name,
1154 column: idx,
1155 visible: this.visibility()[idx - 1],
189f8030 1156 color: this.colorsMap_[series_name],
e2c21500
DV
1157 axis: 1 + this.seriesToAxisMap_[series_name]
1158 };
0abfbd7e
DV
1159};
1160
1161/**
6a1aa64f 1162 * Create the text box to adjust the averaging period
6a1aa64f
DV
1163 * @private
1164 */
285a6bda 1165Dygraph.prototype.createRollInterface_ = function() {
8c69de65
DV
1166 // Create a roller if one doesn't exist already.
1167 if (!this.roller_) {
1168 this.roller_ = document.createElement("input");
1169 this.roller_.type = "text";
1170 this.roller_.style.display = "none";
1171 this.graphDiv.appendChild(this.roller_);
1172 }
1173
1174 var display = this.attr_('showRoller') ? 'block' : 'none';
26ca7938 1175
0c38f187 1176 var area = this.plotter_.area;
b0c3b730
DV
1177 var textAttr = { "position": "absolute",
1178 "zIndex": 10,
0c38f187
DV
1179 "top": (area.y + area.h - 25) + "px",
1180 "left": (area.x + 1) + "px",
b0c3b730 1181 "display": display
6a1aa64f 1182 };
8c69de65
DV
1183 this.roller_.size = "2";
1184 this.roller_.value = this.rollPeriod_;
b0c3b730 1185 for (var name in textAttr) {
85b99f0b 1186 if (textAttr.hasOwnProperty(name)) {
8c69de65 1187 this.roller_.style[name] = textAttr[name];
85b99f0b 1188 }
b0c3b730
DV
1189 }
1190
76171648 1191 var dygraph = this;
8c69de65 1192 this.roller_.onchange = function() { dygraph.adjustRoll(dygraph.roller_.value); };
76171648
DV
1193};
1194
629a09ae
DV
1195/**
1196 * @private
629a09ae
DV
1197 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1198 * canvas (i.e. DOM Coords).
1199 */
062ef401 1200Dygraph.prototype.dragGetX_ = function(e, context) {
758a629f 1201 return Dygraph.pageX(e) - context.px;
062ef401 1202};
bce01b0f 1203
629a09ae
DV
1204/**
1205 * @private
1206 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1207 * canvas (i.e. DOM Coords).
1208 */
062ef401 1209Dygraph.prototype.dragGetY_ = function(e, context) {
758a629f 1210 return Dygraph.pageY(e) - context.py;
062ef401 1211};
ee672584 1212
629a09ae 1213/**
062ef401
JB
1214 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1215 * events.
1216 * @private
1217 */
1218Dygraph.prototype.createDragInterface_ = function() {
1219 var context = {
1220 // Tracks whether the mouse is down right now
1221 isZooming: false,
1222 isPanning: false, // is this drag part of a pan?
1223 is2DPan: false, // if so, is that pan 1- or 2-dimensional?
8442269f
RK
1224 dragStartX: null, // pixel coordinates
1225 dragStartY: null, // pixel coordinates
1226 dragEndX: null, // pixel coordinates
1227 dragEndY: null, // pixel coordinates
062ef401 1228 dragDirection: null,
8442269f
RK
1229 prevEndX: null, // pixel coordinates
1230 prevEndY: null, // pixel coordinates
062ef401 1231 prevDragDirection: null,
421f1773 1232 cancelNextDblclick: false, // see comment in dygraph-interaction-model.js
062ef401 1233
ec291cbe
RK
1234 // The value on the left side of the graph when a pan operation starts.
1235 initialLeftmostDate: null,
1236
1237 // The number of units each pixel spans. (This won't be valid for log
1238 // scales)
1239 xUnitsPerPixel: null,
062ef401
JB
1240
1241 // TODO(danvk): update this comment
1242 // The range in second/value units that the viewport encompasses during a
1243 // panning operation.
1244 dateRange: null,
1245
8442269f
RK
1246 // Top-left corner of the canvas, in DOM coords
1247 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
062ef401
JB
1248 px: 0,
1249 py: 0,
1250
965a030e 1251 // Values for use with panEdgeFraction, which limit how far outside the
4cac8c7a
RK
1252 // graph's data boundaries it can be panned.
1253 boundedDates: null, // [minDate, maxDate]
1254 boundedValues: null, // [[minValue, maxValue] ...]
1255
2bad4d92
DV
1256 // We cover iframes during mouse interactions. See comments in
1257 // dygraph-utils.js for more info on why this is a good idea.
1258 tarp: new Dygraph.IFrameTarp(),
1259
6a4587ac
RK
1260 // contextB is the same thing as this context object but renamed.
1261 initializeMouseDown: function(event, g, contextB) {
062ef401
JB
1262 // prevents mouse drags from selecting page text.
1263 if (event.preventDefault) {
1264 event.preventDefault(); // Firefox, Chrome, etc.
6a1aa64f 1265 } else {
062ef401
JB
1266 event.returnValue = false; // IE
1267 event.cancelBubble = true;
6a1aa64f
DV
1268 }
1269
6a4587ac
RK
1270 contextB.px = Dygraph.findPosX(g.canvas_);
1271 contextB.py = Dygraph.findPosY(g.canvas_);
1272 contextB.dragStartX = g.dragGetX_(event, contextB);
1273 contextB.dragStartY = g.dragGetY_(event, contextB);
1274 contextB.cancelNextDblclick = false;
2bad4d92 1275 contextB.tarp.cover();
6a1aa64f 1276 }
062ef401 1277 };
2b188b3d 1278
062ef401 1279 var interactionModel = this.attr_("interactionModel");
8b83c6cc 1280
062ef401
JB
1281 // Self is the graph.
1282 var self = this;
6faebb69 1283
062ef401
JB
1284 // Function that binds the graph and context to the handler.
1285 var bindHandler = function(handler) {
1286 return function(event) {
1287 handler(event, self, context);
1288 };
1289 };
1290
1291 for (var eventName in interactionModel) {
1292 if (!interactionModel.hasOwnProperty(eventName)) continue;
6a4587ac 1293 this.addEvent(this.mouseEventElement_, eventName,
062ef401
JB
1294 bindHandler(interactionModel[eventName]));
1295 }
1296
1297 // If the user releases the mouse button during a drag, but not over the
1298 // canvas, then it doesn't count as a zooming action.
cb1261cb 1299 this.mouseUpHandler_ = function(event) {
062ef401
JB
1300 if (context.isZooming || context.isPanning) {
1301 context.isZooming = false;
1302 context.dragStartX = null;
1303 context.dragStartY = null;
1304 }
1305
1306 if (context.isPanning) {
1307 context.isPanning = false;
1308 context.draggingDate = null;
1309 context.dateRange = null;
1310 for (var i = 0; i < self.axes_.length; i++) {
1311 delete self.axes_[i].draggingValue;
1312 delete self.axes_[i].dragValueRange;
1313 }
1314 }
2bad4d92
DV
1315
1316 context.tarp.uncover();
cb1261cb
DV
1317 };
1318
bc3e2c5d 1319 this.addEvent(document, 'mouseup', this.mouseUpHandler_);
6a1aa64f
DV
1320};
1321
1322/**
1323 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1324 * up any previous zoom rectangles that were drawn. This could be optimized to
1325 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1326 * dots.
ccd9d7c2 1327 *
39b0e098
RK
1328 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1329 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
6a1aa64f
DV
1330 * @param {Number} startX The X position where the drag started, in canvas
1331 * coordinates.
1332 * @param {Number} endX The current X position of the drag, in canvas coords.
8b83c6cc
RK
1333 * @param {Number} startY The Y position where the drag started, in canvas
1334 * coordinates.
1335 * @param {Number} endY The current Y position of the drag, in canvas coords.
39b0e098 1336 * @param {Number} prevDirection the value of direction on the previous call to
8b83c6cc 1337 * this function. Used to avoid excess redrawing
6a1aa64f
DV
1338 * @param {Number} prevEndX The value of endX on the previous call to this
1339 * function. Used to avoid excess redrawing
8b83c6cc
RK
1340 * @param {Number} prevEndY The value of endY on the previous call to this
1341 * function. Used to avoid excess redrawing
6a1aa64f
DV
1342 * @private
1343 */
7201b11e
JB
1344Dygraph.prototype.drawZoomRect_ = function(direction, startX, endX, startY,
1345 endY, prevDirection, prevEndX,
1346 prevEndY) {
2cf95fff 1347 var ctx = this.canvas_ctx_;
6a1aa64f
DV
1348
1349 // Clean up from the previous rect if necessary
39b0e098 1350 if (prevDirection == Dygraph.HORIZONTAL) {
fa54c193
FXB
1351 ctx.clearRect(Math.min(startX, prevEndX), this.layout_.getPlotArea().y,
1352 Math.abs(startX - prevEndX), this.layout_.getPlotArea().h);
39b0e098 1353 } else if (prevDirection == Dygraph.VERTICAL){
fa54c193
FXB
1354 ctx.clearRect(this.layout_.getPlotArea().x, Math.min(startY, prevEndY),
1355 this.layout_.getPlotArea().w, Math.abs(startY - prevEndY));
6a1aa64f
DV
1356 }
1357
1358 // Draw a light-grey rectangle to show the new viewing area
39b0e098 1359 if (direction == Dygraph.HORIZONTAL) {
8b83c6cc
RK
1360 if (endX && startX) {
1361 ctx.fillStyle = "rgba(128,128,128,0.33)";
fa54c193
FXB
1362 ctx.fillRect(Math.min(startX, endX), this.layout_.getPlotArea().y,
1363 Math.abs(endX - startX), this.layout_.getPlotArea().h);
8b83c6cc 1364 }
920208fb 1365 } else if (direction == Dygraph.VERTICAL) {
8b83c6cc
RK
1366 if (endY && startY) {
1367 ctx.fillStyle = "rgba(128,128,128,0.33)";
fa54c193
FXB
1368 ctx.fillRect(this.layout_.getPlotArea().x, Math.min(startY, endY),
1369 this.layout_.getPlotArea().w, Math.abs(endY - startY));
8b83c6cc 1370 }
6a1aa64f 1371 }
920208fb
PF
1372
1373 if (this.isUsingExcanvas_) {
1374 this.currentZoomRectArgs_ = [direction, startX, endX, startY, endY, 0, 0, 0];
1375 }
1376};
1377
1378/**
1379 * Clear the zoom rectangle (and perform no zoom).
1380 * @private
1381 */
1382Dygraph.prototype.clearZoomRect_ = function() {
1383 this.currentZoomRectArgs_ = null;
1384 this.canvas_ctx_.clearRect(0, 0, this.canvas_.width, this.canvas_.height);
6a1aa64f
DV
1385};
1386
1387/**
8b83c6cc
RK
1388 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1389 * the canvas. The exact zoom window may be slightly larger if there are no data
1390 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1391 * which accepts dates that match the raw data. This function redraws the graph.
d58ae307 1392 *
6a1aa64f
DV
1393 * @param {Number} lowX The leftmost pixel value that should be visible.
1394 * @param {Number} highX The rightmost pixel value that should be visible.
1395 * @private
1396 */
8b83c6cc 1397Dygraph.prototype.doZoomX_ = function(lowX, highX) {
920208fb 1398 this.currentZoomRectArgs_ = null;
6a1aa64f 1399 // Find the earliest and latest dates contained in this canvasx range.
8b83c6cc 1400 // Convert the call to date ranges of the raw data.
ff022deb
RK
1401 var minDate = this.toDataXCoord(lowX);
1402 var maxDate = this.toDataXCoord(highX);
8b83c6cc
RK
1403 this.doZoomXDates_(minDate, maxDate);
1404};
6a1aa64f 1405
8b83c6cc 1406/**
b1a3b195
DV
1407 * Transition function to use in animations. Returns values between 0.0
1408 * (totally old values) and 1.0 (totally new values) for each frame.
1409 * @private
1410 */
1411Dygraph.zoomAnimationFunction = function(frame, numFrames) {
1412 var k = 1.5;
1413 return (1.0 - Math.pow(k, -frame)) / (1.0 - Math.pow(k, -numFrames));
1414};
1415
1416/**
8b83c6cc
RK
1417 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1418 * method with doZoomX which accepts pixel coordinates. This function redraws
1419 * the graph.
d58ae307 1420 *
8b83c6cc
RK
1421 * @param {Number} minDate The minimum date that should be visible.
1422 * @param {Number} maxDate The maximum date that should be visible.
1423 * @private
1424 */
1425Dygraph.prototype.doZoomXDates_ = function(minDate, maxDate) {
b1a3b195
DV
1426 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1427 // can produce strange effects. Rather than the y-axis transitioning slowly
1428 // between values, it can jerk around.)
1429 var old_window = this.xAxisRange();
1430 var new_window = [minDate, maxDate];
57baab03 1431 this.zoomed_x_ = true;
b1a3b195
DV
1432 var that = this;
1433 this.doAnimatedZoom(old_window, new_window, null, null, function() {
1434 if (that.attr_("zoomCallback")) {
1435 that.attr_("zoomCallback")(minDate, maxDate, that.yAxisRanges());
1436 }
1437 });
8b83c6cc
RK
1438};
1439
1440/**
1441 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
d58ae307
DV
1442 * the canvas. This function redraws the graph.
1443 *
8b83c6cc
RK
1444 * @param {Number} lowY The topmost pixel value that should be visible.
1445 * @param {Number} highY The lowest pixel value that should be visible.
1446 * @private
1447 */
1448Dygraph.prototype.doZoomY_ = function(lowY, highY) {
920208fb 1449 this.currentZoomRectArgs_ = null;
d58ae307
DV
1450 // Find the highest and lowest values in pixel range for each axis.
1451 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1452 // This is because pixels increase as you go down on the screen, whereas data
1453 // coordinates increase as you go up the screen.
b1a3b195
DV
1454 var oldValueRanges = this.yAxisRanges();
1455 var newValueRanges = [];
d58ae307 1456 for (var i = 0; i < this.axes_.length; i++) {
ff022deb
RK
1457 var hi = this.toDataYCoord(lowY, i);
1458 var low = this.toDataYCoord(highY, i);
b1a3b195 1459 newValueRanges.push([low, hi]);
d58ae307 1460 }
8b83c6cc 1461
57baab03 1462 this.zoomed_y_ = true;
b1a3b195
DV
1463 var that = this;
1464 this.doAnimatedZoom(null, null, oldValueRanges, newValueRanges, function() {
1465 if (that.attr_("zoomCallback")) {
1466 var xRange = that.xAxisRange();
b1a3b195
DV
1467 that.attr_("zoomCallback")(xRange[0], xRange[1], that.yAxisRanges());
1468 }
1469 });
8b83c6cc
RK
1470};
1471
1472/**
1473 * Reset the zoom to the original view coordinates. This is the same as
1474 * double-clicking on the graph.
d58ae307 1475 *
8b83c6cc
RK
1476 * @private
1477 */
1478Dygraph.prototype.doUnzoom_ = function() {
b1a3b195 1479 var dirty = false, dirtyX = false, dirtyY = false;
758a629f 1480 if (this.dateWindow_ !== null) {
d58ae307 1481 dirty = true;
b1a3b195 1482 dirtyX = true;
8b83c6cc 1483 }
d58ae307
DV
1484
1485 for (var i = 0; i < this.axes_.length; i++) {
1f6a6254 1486 if (typeof(this.axes_[i].valueWindow) !== 'undefined' && this.axes_[i].valueWindow !== null) {
d58ae307 1487 dirty = true;
b1a3b195 1488 dirtyY = true;
d58ae307 1489 }
8b83c6cc
RK
1490 }
1491
da1369a5
DV
1492 // Clear any selection, since it's likely to be drawn in the wrong place.
1493 this.clearSelection();
1494
8b83c6cc 1495 if (dirty) {
57baab03
NN
1496 this.zoomed_x_ = false;
1497 this.zoomed_y_ = false;
b1a3b195
DV
1498
1499 var minDate = this.rawData_[0][0];
1500 var maxDate = this.rawData_[this.rawData_.length - 1][0];
1501
1502 // With only one frame, don't bother calculating extreme ranges.
1503 // TODO(danvk): merge this block w/ the code below.
1504 if (!this.attr_("animatedZooms")) {
1505 this.dateWindow_ = null;
758a629f
DV
1506 for (i = 0; i < this.axes_.length; i++) {
1507 if (this.axes_[i].valueWindow !== null) {
b1a3b195
DV
1508 delete this.axes_[i].valueWindow;
1509 }
1510 }
1511 this.drawGraph_();
1512 if (this.attr_("zoomCallback")) {
1513 this.attr_("zoomCallback")(minDate, maxDate, this.yAxisRanges());
1514 }
1515 return;
1516 }
1517
1518 var oldWindow=null, newWindow=null, oldValueRanges=null, newValueRanges=null;
1519 if (dirtyX) {
1520 oldWindow = this.xAxisRange();
1521 newWindow = [minDate, maxDate];
1522 }
1523
1524 if (dirtyY) {
1525 oldValueRanges = this.yAxisRanges();
1526 // TODO(danvk): this is pretty inefficient
1527 var packed = this.gatherDatasets_(this.rolledSeries_, null);
1528 var extremes = packed[1];
1529
1530 // this has the side-effect of modifying this.axes_.
1531 // this doesn't make much sense in this context, but it's convenient (we
1532 // need this.axes_[*].extremeValues) and not harmful since we'll be
1533 // calling drawGraph_ shortly, which clobbers these values.
1534 this.computeYAxisRanges_(extremes);
1535
1536 newValueRanges = [];
758a629f 1537 for (i = 0; i < this.axes_.length; i++) {
1f6a6254 1538 var axis = this.axes_[i];
681a215e
DV
1539 newValueRanges.push((axis.valueRange !== null &&
1540 axis.valueRange !== undefined) ?
42a9ebb8 1541 axis.valueRange : axis.extremeRange);
b1a3b195
DV
1542 }
1543 }
1544
1545 var that = this;
1546 this.doAnimatedZoom(oldWindow, newWindow, oldValueRanges, newValueRanges,
1547 function() {
1548 that.dateWindow_ = null;
1549 for (var i = 0; i < that.axes_.length; i++) {
758a629f 1550 if (that.axes_[i].valueWindow !== null) {
b1a3b195
DV
1551 delete that.axes_[i].valueWindow;
1552 }
1553 }
1554 if (that.attr_("zoomCallback")) {
1555 that.attr_("zoomCallback")(minDate, maxDate, that.yAxisRanges());
1556 }
1557 });
1558 }
1559};
1560
1561/**
1562 * Combined animation logic for all zoom functions.
1563 * either the x parameters or y parameters may be null.
1564 * @private
1565 */
1566Dygraph.prototype.doAnimatedZoom = function(oldXRange, newXRange, oldYRanges, newYRanges, callback) {
1567 var steps = this.attr_("animatedZooms") ? Dygraph.ANIMATION_STEPS : 1;
1568
1569 var windows = [];
1570 var valueRanges = [];
758a629f 1571 var step, frac;
b1a3b195 1572
758a629f
DV
1573 if (oldXRange !== null && newXRange !== null) {
1574 for (step = 1; step <= steps; step++) {
1575 frac = Dygraph.zoomAnimationFunction(step, steps);
b1a3b195
DV
1576 windows[step-1] = [oldXRange[0]*(1-frac) + frac*newXRange[0],
1577 oldXRange[1]*(1-frac) + frac*newXRange[1]];
8b83c6cc 1578 }
67e650dc 1579 }
b1a3b195 1580
758a629f
DV
1581 if (oldYRanges !== null && newYRanges !== null) {
1582 for (step = 1; step <= steps; step++) {
1583 frac = Dygraph.zoomAnimationFunction(step, steps);
b1a3b195
DV
1584 var thisRange = [];
1585 for (var j = 0; j < this.axes_.length; j++) {
1586 thisRange.push([oldYRanges[j][0]*(1-frac) + frac*newYRanges[j][0],
1587 oldYRanges[j][1]*(1-frac) + frac*newYRanges[j][1]]);
1588 }
1589 valueRanges[step-1] = thisRange;
1590 }
1591 }
1592
1593 var that = this;
1594 Dygraph.repeatAndCleanup(function(step) {
1595 if (valueRanges.length) {
1596 for (var i = 0; i < that.axes_.length; i++) {
1597 var w = valueRanges[step][i];
1598 that.axes_[i].valueWindow = [w[0], w[1]];
1599 }
1600 }
1601 if (windows.length) {
1602 that.dateWindow_ = windows[step];
1603 }
1604 that.drawGraph_();
1605 }, steps, Dygraph.ANIMATION_DURATION / steps, callback);
6a1aa64f
DV
1606};
1607
1608/**
857a6931
KW
1609 * Get the current graph's area object.
1610 *
1611 * Returns: {x, y, w, h}
6a1aa64f 1612 */
857a6931
KW
1613Dygraph.prototype.getArea = function() {
1614 return this.plotter_.area;
1615};
e863a17d 1616
857a6931
KW
1617/**
1618 * Convert a mouse event to DOM coordinates relative to the graph origin.
1619 *
1620 * Returns a two-element array: [X, Y].
1621 */
1622Dygraph.prototype.eventToDomCoords = function(event) {
4cac8c7a 1623 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
857a6931
KW
1624 var canvasy = Dygraph.pageY(event) - Dygraph.findPosY(this.mouseEventElement_);
1625 return [canvasx, canvasy];
1626};
4cac8c7a 1627
857a6931
KW
1628/**
1629 * Given a canvas X coordinate, find the closest row.
1630 * @param {Number} domX graph-relative DOM X coordinate
1631 * Returns: row number, integer
1632 * @private
1633 */
1634Dygraph.prototype.findClosestRow = function(domX) {
81cb07d6 1635 var minDistX = Infinity;
a12a78ae
DV
1636 var pointIdx = -1, setIdx = -1;
1637 var sets = this.layout_.points;
1638 for (var i = 0; i < sets.length; i++) {
1639 var points = sets[i];
1640 var len = points.length;
1641 for (var j = 0; j < len; j++) {
1642 var point = points[j];
1643 if (!Dygraph.isValidPoint(point, true)) continue;
1644 var dist = Math.abs(point.canvasx - domX);
1645 if (dist < minDistX) {
1646 minDistX = dist;
1647 setIdx = i;
1648 pointIdx = j;
1649 }
a937d031 1650 }
6a1aa64f 1651 }
a12a78ae
DV
1652
1653 // TODO(danvk): remove this function; it's trivial and has only one use.
1654 return this.idxToRow_(setIdx, pointIdx);
857a6931 1655};
6a1aa64f 1656
857a6931 1657/**
2a02e5dd
KW
1658 * Given canvas X,Y coordinates, find the closest point.
1659 *
1660 * This finds the individual data point across all visible series
1661 * that's closest to the supplied DOM coordinates using the standard
1662 * Euclidean X,Y distance.
1663 *
857a6931
KW
1664 * @param {Number} domX graph-relative DOM X coordinate
1665 * @param {Number} domY graph-relative DOM Y coordinate
1666 * Returns: {row, seriesName, point}
1667 * @private
1668 */
1669Dygraph.prototype.findClosestPoint = function(domX, domY) {
81cb07d6 1670 var minDist = Infinity;
857a6931 1671 var idx = -1;
857a6931 1672 var dist, dx, dy, point, closestPoint, closestSeries;
cc825c7b 1673 for ( var setIdx = this.layout_.datasets.length - 1 ; setIdx >= 0 ; --setIdx ) {
a12a78ae
DV
1674 var points = this.layout_.points[setIdx];
1675 for (var i = 0; i < points.length; ++i) {
1676 var point = points[i];
62c3d2fd 1677 if (!Dygraph.isValidPoint(point)) continue;
857a6931
KW
1678 dx = point.canvasx - domX;
1679 dy = point.canvasy - domY;
1680 dist = dx * dx + dy * dy;
81cb07d6 1681 if (dist < minDist) {
62c3d2fd 1682 minDist = dist;
a937d031
KW
1683 closestPoint = point;
1684 closestSeries = setIdx;
1685 idx = i;
1686 }
857a6931
KW
1687 }
1688 }
1689 var name = this.layout_.setNames[closestSeries];
1690 return {
81cb07d6 1691 row: idx + this.getLeftBoundary_(),
857a6931
KW
1692 seriesName: name,
1693 point: closestPoint
1694 };
1695};
1696
1697/**
1698 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
2a02e5dd
KW
1699 *
1700 * This first finds the X data point closest to the supplied DOM X coordinate,
1701 * then finds the series which puts the Y coordinate on top of its filled area,
1702 * using linear interpolation between adjacent point pairs.
1703 *
857a6931
KW
1704 * @param {Number} domX graph-relative DOM X coordinate
1705 * @param {Number} domY graph-relative DOM Y coordinate
1706 * Returns: {row, seriesName, point}
1707 * @private
1708 */
1709Dygraph.prototype.findStackedPoint = function(domX, domY) {
1710 var row = this.findClosestRow(domX);
81cb07d6
KW
1711 var boundary = this.getLeftBoundary_();
1712 var rowIdx = row - boundary;
a12a78ae 1713 var sets = this.layout_.points;
857a6931
KW
1714 var closestPoint, closestSeries;
1715 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
a12a78ae
DV
1716 var points = this.layout_.points[setIdx];
1717 if (rowIdx >= points.length) continue;
1718 var p1 = points[rowIdx];
62c3d2fd 1719 if (!Dygraph.isValidPoint(p1)) continue;
857a6931 1720 var py = p1.canvasy;
a12a78ae 1721 if (domX > p1.canvasx && rowIdx + 1 < points.length) {
857a6931 1722 // interpolate series Y value using next point
a12a78ae 1723 var p2 = points[rowIdx + 1];
62c3d2fd
KW
1724 if (Dygraph.isValidPoint(p2)) {
1725 var dx = p2.canvasx - p1.canvasx;
1726 if (dx > 0) {
1727 var r = (domX - p1.canvasx) / dx;
1728 py += r * (p2.canvasy - p1.canvasy);
1729 }
416b05ad 1730 }
81cb07d6 1731 } else if (domX < p1.canvasx && rowIdx > 0) {
857a6931 1732 // interpolate series Y value using previous point
a12a78ae 1733 var p0 = points[rowIdx - 1];
62c3d2fd
KW
1734 if (Dygraph.isValidPoint(p0)) {
1735 var dx = p1.canvasx - p0.canvasx;
1736 if (dx > 0) {
1737 var r = (p1.canvasx - domX) / dx;
1738 py += r * (p0.canvasy - p1.canvasy);
1739 }
12e4c741 1740 }
6a1aa64f 1741 }
857a6931 1742 // Stop if the point (domX, py) is above this series' upper edge
42a9ebb8 1743 if (setIdx === 0 || py < domY) {
a937d031
KW
1744 closestPoint = p1;
1745 closestSeries = setIdx;
1746 }
6a1aa64f 1747 }
857a6931
KW
1748 var name = this.layout_.setNames[closestSeries];
1749 return {
1750 row: row,
1751 seriesName: name,
1752 point: closestPoint
1753 };
1754};
6a1aa64f 1755
857a6931 1756/**
6a1aa64f
DV
1757 * When the mouse moves in the canvas, display information about a nearby data
1758 * point and draw dots over those points in the data series. This function
1759 * takes care of cleanup of previously-drawn dots.
1760 * @param {Object} event The mousemove event from the browser.
1761 * @private
1762 */
285a6bda 1763Dygraph.prototype.mouseMove_ = function(event) {
e863a17d 1764 // This prevents JS errors when mousing over the canvas before data loads.
4cac8c7a 1765 var points = this.layout_.points;
a12a78ae 1766 if (points === undefined || points === null) return;
e863a17d 1767
857a6931
KW
1768 var canvasCoords = this.eventToDomCoords(event);
1769 var canvasx = canvasCoords[0];
1770 var canvasy = canvasCoords[1];
6a1aa64f 1771
857a6931
KW
1772 var highlightSeriesOpts = this.attr_("highlightSeriesOpts");
1773 var selectionChanged = false;
3f55b813 1774 if (highlightSeriesOpts && !this.isSeriesLocked()) {
857a6931
KW
1775 var closest;
1776 if (this.attr_("stackedGraph")) {
1777 closest = this.findStackedPoint(canvasx, canvasy);
1778 } else {
1779 closest = this.findClosestPoint(canvasx, canvasy);
43af96e7 1780 }
857a6931 1781 selectionChanged = this.setSelection(closest.row, closest.seriesName);
416b05ad 1782 } else {
857a6931
KW
1783 var idx = this.findClosestRow(canvasx);
1784 selectionChanged = this.setSelection(idx);
12e4c741 1785 }
43af96e7 1786
857a6931
KW
1787 var callback = this.attr_("highlightCallback");
1788 if (callback && selectionChanged) {
1789 callback(event, this.lastx_, this.selPoints_, this.lastRow_, this.highlightSet_);
12e4c741 1790 }
239c712d 1791};
b258a3da 1792
239c712d 1793/**
81cb07d6 1794 * Fetch left offset from first defined boundaryIds record (see bug #236).
e2c21500 1795 * @private
81cb07d6
KW
1796 */
1797Dygraph.prototype.getLeftBoundary_ = function() {
1798 for (var i = 0; i < this.boundaryIds_.length; i++) {
1799 if (this.boundaryIds_[i] !== undefined) {
1800 return this.boundaryIds_[i][0];
1801 }
1802 }
1803 return 0;
1804};
1805
1806/**
1903f1e4 1807 * Transforms layout_.points index into data row number.
2ddb1197 1808 * @param int layout_.points index
1903f1e4 1809 * @return int row number, or -1 if none could be found.
2ddb1197
SC
1810 * @private
1811 */
a12a78ae
DV
1812Dygraph.prototype.idxToRow_ = function(setIdx, rowIdx) {
1813 if (rowIdx < 0) return -1;
2ddb1197 1814
81cb07d6 1815 var boundary = this.getLeftBoundary_();
a12a78ae
DV
1816 return boundary + rowIdx;
1817 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1818 // var set = this.layout_.datasets[setIdx];
1819 // if (idx < set.length) {
1820 // return boundary + idx;
1821 // }
1822 // idx -= set.length;
1823 // }
1824 // return -1;
1903f1e4 1825};
2ddb1197 1826
857a6931
KW
1827Dygraph.prototype.animateSelection_ = function(direction) {
1828 var totalSteps = 10;
1829 var millis = 30;
1d44ee5e
KW
1830 if (this.fadeLevel === undefined) this.fadeLevel = 0;
1831 if (this.animateId === undefined) this.animateId = 0;
857a6931
KW
1832 var start = this.fadeLevel;
1833 var steps = direction < 0 ? start : totalSteps - start;
1834 if (steps <= 0) {
1835 if (this.fadeLevel) {
1836 this.updateSelection_(1.0);
1837 }
1838 return;
1839 }
1840
1841 var thisId = ++this.animateId;
1842 var that = this;
475f7420
KW
1843 Dygraph.repeatAndCleanup(
1844 function(n) {
1845 // ignore simultaneous animations
1846 if (that.animateId != thisId) return;
1847
1848 that.fadeLevel += direction;
1849 if (that.fadeLevel === 0) {
1850 that.clearSelection();
1851 } else {
1852 that.updateSelection_(that.fadeLevel / totalSteps);
1853 }
1854 },
1855 steps, millis, function() {});
857a6931
KW
1856};
1857
2ddb1197 1858/**
239c712d
NAG
1859 * Draw dots over the selectied points in the data series. This function
1860 * takes care of cleanup of previously-drawn dots.
1861 * @private
1862 */
857a6931 1863Dygraph.prototype.updateSelection_ = function(opt_animFraction) {
e2c21500
DV
1864 var defaultPrevented = this.cascadeEvents_('select', {
1865 selectedX: this.lastx_,
1866 selectedPoints: this.selPoints_
1867 });
1868 // TODO(danvk): use defaultPrevented here?
1869
6a1aa64f 1870 // Clear the previously drawn vertical, if there is one
758a629f 1871 var i;
2cf95fff 1872 var ctx = this.canvas_ctx_;
857a6931
KW
1873 if (this.attr_('highlightSeriesOpts')) {
1874 ctx.clearRect(0, 0, this.width_, this.height_);
afdb20d8 1875 var alpha = 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
857a6931 1876 if (alpha) {
2a02e5dd
KW
1877 // Activating background fade includes an animation effect for a gradual
1878 // fade. TODO(klausw): make this independently configurable if it causes
1879 // issues? Use a shared preference to control animations?
1880 var animateBackgroundFade = true;
1881 if (animateBackgroundFade) {
857a6931
KW
1882 if (opt_animFraction === undefined) {
1883 // start a new animation
1884 this.animateSelection_(1);
1885 return;
1886 }
1887 alpha *= opt_animFraction;
1888 }
1889 ctx.fillStyle = 'rgba(255,255,255,' + alpha + ')';
1890 ctx.fillRect(0, 0, this.width_, this.height_);
1891 }
38e3d209
DV
1892
1893 // Redraw only the highlighted series in the interactive canvas (not the
1894 // static plot canvas, which is where series are usually drawn).
1895 this.plotter_._renderLineChart(this.highlightSet_, ctx);
857a6931 1896 } else if (this.previousVerticalX_ >= 0) {
46dde5f9
DV
1897 // Determine the maximum highlight circle size.
1898 var maxCircleSize = 0;
227b93cc 1899 var labels = this.attr_('labels');
758a629f 1900 for (i = 1; i < labels.length; i++) {
227b93cc 1901 var r = this.attr_('highlightCircleSize', labels[i]);
46dde5f9
DV
1902 if (r > maxCircleSize) maxCircleSize = r;
1903 }
6a1aa64f 1904 var px = this.previousVerticalX_;
46dde5f9
DV
1905 ctx.clearRect(px - maxCircleSize - 1, 0,
1906 2 * maxCircleSize + 2, this.height_);
6a1aa64f
DV
1907 }
1908
920208fb
PF
1909 if (this.isUsingExcanvas_ && this.currentZoomRectArgs_) {
1910 Dygraph.prototype.drawZoomRect_.apply(this, this.currentZoomRectArgs_);
1911 }
1912
d160cc3b 1913 if (this.selPoints_.length > 0) {
6a1aa64f 1914 // Draw colored circles over the center of each selected point
e9fe4a2f 1915 var canvasx = this.selPoints_[0].canvasx;
43af96e7 1916 ctx.save();
758a629f 1917 for (i = 0; i < this.selPoints_.length; i++) {
e9fe4a2f
DV
1918 var pt = this.selPoints_[i];
1919 if (!Dygraph.isOK(pt.canvasy)) continue;
1920
1921 var circleSize = this.attr_('highlightCircleSize', pt.name);
5879307d 1922 var callback = this.attr_("drawHighlightPointCallback", pt.name);
a8ef67a8 1923 var color = this.plotter_.colors[pt.name];
78e58af4
RK
1924 if (!callback) {
1925 callback = Dygraph.Circles.DEFAULT;
1926 }
a8ef67a8
KW
1927 ctx.lineWidth = this.attr_('strokeWidth', pt.name);
1928 ctx.strokeStyle = color;
1929 ctx.fillStyle = color;
78e58af4 1930 callback(this.g, pt.name, ctx, canvasx, pt.canvasy,
a8ef67a8 1931 color, circleSize);
6a1aa64f
DV
1932 }
1933 ctx.restore();
1934
1935 this.previousVerticalX_ = canvasx;
1936 }
1937};
1938
1939/**
629a09ae
DV
1940 * Manually set the selected points and display information about them in the
1941 * legend. The selection can be cleared using clearSelection() and queried
1942 * using getSelection().
1943 * @param { Integer } row number that should be highlighted (i.e. appear with
1944 * hover dots on the chart). Set to false to clear any selection.
857a6931
KW
1945 * @param { seriesName } optional series name to highlight that series with the
1946 * the highlightSeriesOpts setting.
b9a3ece4
KW
1947 * @param { locked } optional If true, keep seriesName selected when mousing
1948 * over the graph, disabling closest-series highlighting. Call clearSelection()
1949 * to unlock it.
239c712d 1950 */
b9a3ece4 1951Dygraph.prototype.setSelection = function(row, opt_seriesName, opt_locked) {
239c712d
NAG
1952 // Extract the points we've selected
1953 this.selPoints_ = [];
50360fd0 1954
239c712d 1955 if (row !== false) {
81cb07d6 1956 row -= this.getLeftBoundary_();
16269f6e 1957 }
50360fd0 1958
857a6931 1959 var changed = false;
16269f6e 1960 if (row !== false && row >= 0) {
857a6931
KW
1961 if (row != this.lastRow_) changed = true;
1962 this.lastRow_ = row;
82c6fe4d
KW
1963 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1964 var set = this.layout_.datasets[setIdx];
1965 if (row < set.length) {
a12a78ae 1966 var point = this.layout_.points[setIdx][row];
ccd9d7c2 1967
38f33a44 1968 if (this.attr_("stackedGraph")) {
a12a78ae 1969 point = this.layout_.unstackPointAtIndex(setIdx, row);
38f33a44 1970 }
ccd9d7c2 1971
42a9ebb8 1972 if (point.yval !== null) this.selPoints_.push(point);
16269f6e 1973 }
239c712d 1974 }
857a6931
KW
1975 } else {
1976 if (this.lastRow_ >= 0) changed = true;
1977 this.lastRow_ = -1;
16269f6e 1978 }
50360fd0 1979
16269f6e 1980 if (this.selPoints_.length) {
239c712d 1981 this.lastx_ = this.selPoints_[0].xval;
239c712d 1982 } else {
857a6931 1983 this.lastx_ = -1;
239c712d
NAG
1984 }
1985
857a6931
KW
1986 if (opt_seriesName !== undefined) {
1987 if (this.highlightSet_ !== opt_seriesName) changed = true;
1988 this.highlightSet_ = opt_seriesName;
239c712d
NAG
1989 }
1990
b9a3ece4
KW
1991 if (opt_locked !== undefined) {
1992 this.lockedSet_ = opt_locked;
1993 }
1994
857a6931
KW
1995 if (changed) {
1996 this.updateSelection_(undefined);
1997 }
1998 return changed;
239c712d
NAG
1999};
2000
2001/**
6a1aa64f
DV
2002 * The mouse has left the canvas. Clear out whatever artifacts remain
2003 * @param {Object} event the mouseout event from the browser.
2004 * @private
2005 */
285a6bda 2006Dygraph.prototype.mouseOut_ = function(event) {
a4c6a67c
AV
2007 if (this.attr_("unhighlightCallback")) {
2008 this.attr_("unhighlightCallback")(event);
2009 }
2010
b9a3ece4 2011 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_) {
239c712d 2012 this.clearSelection();
43af96e7 2013 }
6a1aa64f
DV
2014};
2015
239c712d 2016/**
629a09ae
DV
2017 * Clears the current selection (i.e. points that were highlighted by moving
2018 * the mouse over the chart).
239c712d
NAG
2019 */
2020Dygraph.prototype.clearSelection = function() {
e2c21500
DV
2021 this.cascadeEvents_('deselect', {});
2022
b9a3ece4 2023 this.lockedSet_ = false;
239c712d 2024 // Get rid of the overlay data
857a6931
KW
2025 if (this.fadeLevel) {
2026 this.animateSelection_(-1);
2027 return;
2028 }
2cf95fff 2029 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
857a6931 2030 this.fadeLevel = 0;
239c712d
NAG
2031 this.selPoints_ = [];
2032 this.lastx_ = -1;
857a6931
KW
2033 this.lastRow_ = -1;
2034 this.highlightSet_ = null;
758a629f 2035};
239c712d 2036
103b7292 2037/**
629a09ae
DV
2038 * Returns the number of the currently selected row. To get data for this row,
2039 * you can use the getValue method.
2040 * @return { Integer } row number, or -1 if nothing is selected
103b7292
NAG
2041 */
2042Dygraph.prototype.getSelection = function() {
2043 if (!this.selPoints_ || this.selPoints_.length < 1) {
2044 return -1;
2045 }
50360fd0 2046
a12a78ae
DV
2047 for (var setIdx = 0; setIdx < this.layout_.points.length; setIdx++) {
2048 var points = this.layout_.points[setIdx];
2049 for (var row = 0; row < points.length; row++) {
2050 if (points[row].x == this.selPoints_[0].x) {
2051 return row + this.getLeftBoundary_();
2052 }
103b7292
NAG
2053 }
2054 }
2055 return -1;
2e1fcf1a 2056};
103b7292 2057
e2c21500
DV
2058/**
2059 * Returns the name of the currently-highlighted series.
2060 * Only available when the highlightSeriesOpts option is in use.
2061 */
857a6931
KW
2062Dygraph.prototype.getHighlightSeries = function() {
2063 return this.highlightSet_;
2064};
2065
19589a3e 2066/**
3f55b813
KW
2067 * Returns true if the currently-highlighted series was locked
2068 * via setSelection(..., seriesName, true).
2069 */
2070Dygraph.prototype.isSeriesLocked = function() {
2071 return this.lockedSet_;
2072};
2073
2074/**
6a1aa64f
DV
2075 * Fires when there's data available to be graphed.
2076 * @param {String} data Raw CSV data to be plotted
2077 * @private
2078 */
285a6bda 2079Dygraph.prototype.loadedEvent_ = function(data) {
6a1aa64f 2080 this.rawData_ = this.parseCSV_(data);
26ca7938 2081 this.predraw_();
6a1aa64f
DV
2082};
2083
6a1aa64f
DV
2084/**
2085 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2086 * @private
2087 */
285a6bda 2088Dygraph.prototype.addXTicks_ = function() {
6a1aa64f 2089 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
7201b11e 2090 var range;
6a1aa64f 2091 if (this.dateWindow_) {
7201b11e 2092 range = [this.dateWindow_[0], this.dateWindow_[1]];
6a1aa64f 2093 } else {
395e98a3 2094 range = this.fullXRange_();
7201b11e
JB
2095 }
2096
48e614ac
DV
2097 var xAxisOptionsView = this.optionsViewForAxis_('x');
2098 var xTicks = xAxisOptionsView('ticker')(
2099 range[0],
2100 range[1],
2101 this.width_, // TODO(danvk): should be area.width
2102 xAxisOptionsView,
2103 this);
2104 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2105 // console.log(msg);
b2c9222a 2106 this.layout_.setXTicks(xTicks);
32988383
DV
2107};
2108
629a09ae
DV
2109/**
2110 * @private
2111 * Computes the range of the data series (including confidence intervals).
2112 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2113 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2114 * @return [low, high]
2115 */
5011e7a1 2116Dygraph.prototype.extremeValues_ = function(series) {
758a629f 2117 var minY = null, maxY = null, j, y;
5011e7a1 2118
9922b78b 2119 var bars = this.attr_("errorBars") || this.attr_("customBars");
5011e7a1
DV
2120 if (bars) {
2121 // With custom bars, maxY is the max of the high values.
758a629f
DV
2122 for (j = 0; j < series.length; j++) {
2123 y = series[j][1][0];
44477387 2124 if (y === null || isNaN(y)) continue;
5011e7a1
DV
2125 var low = y - series[j][1][1];
2126 var high = y + series[j][1][2];
2127 if (low > y) low = y; // this can happen with custom bars,
2128 if (high < y) high = y; // e.g. in tests/custom-bars.html
758a629f 2129 if (maxY === null || high > maxY) {
5011e7a1
DV
2130 maxY = high;
2131 }
758a629f 2132 if (minY === null || low < minY) {
5011e7a1
DV
2133 minY = low;
2134 }
2135 }
2136 } else {
758a629f
DV
2137 for (j = 0; j < series.length; j++) {
2138 y = series[j][1];
d12999d3 2139 if (y === null || isNaN(y)) continue;
758a629f 2140 if (maxY === null || y > maxY) {
5011e7a1
DV
2141 maxY = y;
2142 }
758a629f 2143 if (minY === null || y < minY) {
5011e7a1
DV
2144 minY = y;
2145 }
2146 }
2147 }
2148
2149 return [minY, maxY];
2150};
2151
6a1aa64f 2152/**
629a09ae 2153 * @private
26ca7938
DV
2154 * This function is called once when the chart's data is changed or the options
2155 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2156 * idea is that values derived from the chart's data can be computed here,
2157 * rather than every time the chart is drawn. This includes things like the
2158 * number of axes, rolling averages, etc.
2159 */
2160Dygraph.prototype.predraw_ = function() {
7153e001
DV
2161 var start = new Date();
2162
26ca7938
DV
2163 // TODO(danvk): move more computations out of drawGraph_ and into here.
2164 this.computeYAxes_();
2165
2166 // Create a new plotter.
f417e3d3 2167 if (this.plotter_) {
1748a51c 2168 this.cascadeEvents_('clearChart');
f417e3d3
DV
2169 this.plotter_.clear();
2170 }
26ca7938 2171 this.plotter_ = new DygraphCanvasRenderer(this,
2cf95fff
RK
2172 this.hidden_,
2173 this.hidden_ctx_,
0e23cfc6 2174 this.layout_);
26ca7938 2175
0abfbd7e
DV
2176 // The roller sits in the bottom left corner of the chart. We don't know where
2177 // this will be until the options are available, so it's positioned here.
8c69de65 2178 this.createRollInterface_();
26ca7938 2179
e2c21500 2180 this.cascadeEvents_('predraw');
0abfbd7e 2181
ccd9d7c2
PF
2182 if (this.rangeSelector_) {
2183 this.rangeSelector_.renderStaticLayer();
2184 }
2185
b1a3b195
DV
2186 // Convert the raw data (a 2D array) into the internal format and compute
2187 // rolling averages.
2188 this.rolledSeries_ = [null]; // x-axis is the first series and it's special
395e98a3 2189 for (var i = 1; i < this.numColumns(); i++) {
04c104d7
KW
2190 var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong
2191 var series = this.extractSeries_(this.rawData_, i, logScale);
b1a3b195
DV
2192 series = this.rollingAverage(series, this.rollPeriod_);
2193 this.rolledSeries_.push(series);
2194 }
2195
26ca7938
DV
2196 // If the data or options have changed, then we'd better redraw.
2197 this.drawGraph_();
4b4d1a63
DV
2198
2199 // This is used to determine whether to do various animations.
2200 var end = new Date();
2201 this.drawingTimeMs_ = (end - start);
26ca7938
DV
2202};
2203
2204/**
b1a3b195
DV
2205 * Loop over all fields and create datasets, calculating extreme y-values for
2206 * each series and extreme x-indices as we go.
fc4e84fa 2207 *
b1a3b195
DV
2208 * dateWindow is passed in as an explicit parameter so that we can compute
2209 * extreme values "speculatively", i.e. without actually setting state on the
2210 * dygraph.
fc4e84fa 2211 *
b1a3b195
DV
2212 * TODO(danvk): make this more of a true function
2213 * @return [ datasets, seriesExtremes, boundaryIds ]
6a1aa64f
DV
2214 * @private
2215 */
b1a3b195
DV
2216Dygraph.prototype.gatherDatasets_ = function(rolledSeries, dateWindow) {
2217 var boundaryIds = [];
354e15ab
DE
2218 var cumulative_y = []; // For stacked series.
2219 var datasets = [];
f09fc545 2220 var extremes = {}; // series name -> [low, high]
758a629f 2221 var i, j, k;
f09fc545 2222
b1a3b195
DV
2223 // Loop over the fields (series). Go from the last to the first,
2224 // because if they're stacked that's how we accumulate the values.
2225 var num_series = rolledSeries.length - 1;
758a629f 2226 for (i = num_series; i >= 1; i--) {
1cf11047
DV
2227 if (!this.visibility()[i - 1]) continue;
2228
16879a6b
DV
2229 // Note: this copy _is_ necessary at the moment.
2230 // If you remove it, it breaks zooming with error bars on.
2231 // TODO(danvk): investigate further & write a test for this.
2232 var series = [];
2233 for (j = 0; j < rolledSeries[i].length; j++) {
2234 series.push(rolledSeries[i][j]);
2235 }
2f5e7e1a 2236
6a1aa64f 2237 // Prune down to the desired range, if necessary (for zooming)
1a26f3fb
DV
2238 // Because there can be lines going to points outside of the visible area,
2239 // we actually prune to visible points, plus one on either side.
9922b78b 2240 var bars = this.attr_("errorBars") || this.attr_("customBars");
b1a3b195
DV
2241 if (dateWindow) {
2242 var low = dateWindow[0];
2243 var high = dateWindow[1];
6a1aa64f 2244 var pruned = [];
1a26f3fb
DV
2245 // TODO(danvk): do binary search instead of linear search.
2246 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2247 var firstIdx = null, lastIdx = null;
758a629f 2248 for (k = 0; k < series.length; k++) {
1a26f3fb
DV
2249 if (series[k][0] >= low && firstIdx === null) {
2250 firstIdx = k;
2251 }
2252 if (series[k][0] <= high) {
2253 lastIdx = k;
6a1aa64f
DV
2254 }
2255 }
1a26f3fb
DV
2256 if (firstIdx === null) firstIdx = 0;
2257 if (firstIdx > 0) firstIdx--;
2258 if (lastIdx === null) lastIdx = series.length - 1;
2259 if (lastIdx < series.length - 1) lastIdx++;
b1a3b195 2260 boundaryIds[i-1] = [firstIdx, lastIdx];
758a629f 2261 for (k = firstIdx; k <= lastIdx; k++) {
1a26f3fb 2262 pruned.push(series[k]);
6a1aa64f
DV
2263 }
2264 series = pruned;
16269f6e 2265 } else {
b1a3b195 2266 boundaryIds[i-1] = [0, series.length-1];
6a1aa64f
DV
2267 }
2268
f09fc545 2269 var seriesExtremes = this.extremeValues_(series);
5011e7a1 2270
6a1aa64f 2271 if (bars) {
758a629f 2272 for (j=0; j<series.length; j++) {
5061b42f
DV
2273 series[j] = [series[j][0],
2274 series[j][1][0],
2275 series[j][1][1],
2276 series[j][1][2]];
354e15ab 2277 }
43af96e7 2278 } else if (this.attr_("stackedGraph")) {
43af96e7
NK
2279 var l = series.length;
2280 var actual_y;
758a629f 2281 for (j = 0; j < l; j++) {
354e15ab
DE
2282 // If one data set has a NaN, let all subsequent stacked
2283 // sets inherit the NaN -- only start at 0 for the first set.
2284 var x = series[j][0];
41b0f691 2285 if (cumulative_y[x] === undefined) {
354e15ab 2286 cumulative_y[x] = 0;
41b0f691 2287 }
43af96e7
NK
2288
2289 actual_y = series[j][1];
04c104d7
KW
2290 if (actual_y === null) {
2291 series[j] = [x, null];
2292 continue;
2293 }
2294
354e15ab 2295 cumulative_y[x] += actual_y;
43af96e7 2296
758a629f 2297 series[j] = [x, cumulative_y[x]];
43af96e7 2298
41b0f691
DV
2299 if (cumulative_y[x] > seriesExtremes[1]) {
2300 seriesExtremes[1] = cumulative_y[x];
2301 }
2302 if (cumulative_y[x] < seriesExtremes[0]) {
2303 seriesExtremes[0] = cumulative_y[x];
2304 }
43af96e7 2305 }
6a1aa64f 2306 }
354e15ab 2307
b1a3b195
DV
2308 var seriesName = this.attr_("labels")[i];
2309 extremes[seriesName] = seriesExtremes;
354e15ab 2310 datasets[i] = series;
6a1aa64f
DV
2311 }
2312
7d463f49
KW
2313 // For stacked graphs, a NaN value for any point in the sum should create a
2314 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2315 if (this.attr_("stackedGraph")) {
2316 for (k = datasets.length - 1; k >= 0; --k) {
2317 // Use the first nonempty dataset to get X values.
2318 if (!datasets[k]) continue;
2319 for (j = 0; j < datasets[k].length; j++) {
2320 var x = datasets[k][j][0];
2321 if (isNaN(cumulative_y[x])) {
2322 // Set all Y values to NaN at that X value.
2323 for (i = datasets.length - 1; i >= 0; i--) {
2324 if (!datasets[i]) continue;
2325 datasets[i][j][1] = NaN;
2326 }
2327 }
2328 }
2329 break;
2330 }
2331 }
2332
b1a3b195
DV
2333 return [ datasets, extremes, boundaryIds ];
2334};
2335
2336/**
2337 * Update the graph with new data. This method is called when the viewing area
2338 * has changed. If the underlying data or options have changed, predraw_ will
2339 * be called before drawGraph_ is called.
2340 *
b1a3b195
DV
2341 * @private
2342 */
e2c21500 2343Dygraph.prototype.drawGraph_ = function() {
b1a3b195
DV
2344 var start = new Date();
2345
b1a3b195
DV
2346 // This is used to set the second parameter to drawCallback, below.
2347 var is_initial_draw = this.is_initial_draw_;
2348 this.is_initial_draw_ = false;
2349
b1a3b195
DV
2350 this.layout_.removeAllDatasets();
2351 this.setColors_();
758a629f 2352 this.attrs_.pointSize = 0.5 * this.attr_('highlightCircleSize');
b1a3b195
DV
2353
2354 var packed = this.gatherDatasets_(this.rolledSeries_, this.dateWindow_);
2355 var datasets = packed[0];
2356 var extremes = packed[1];
2357 this.boundaryIds_ = packed[2];
2358
82c6fe4d
KW
2359 this.setIndexByName_ = {};
2360 var labels = this.attr_("labels");
2361 if (labels.length > 0) {
2362 this.setIndexByName_[labels[0]] = 0;
2363 }
857a6931 2364 var dataIdx = 0;
354e15ab 2365 for (var i = 1; i < datasets.length; i++) {
82c6fe4d 2366 this.setIndexByName_[labels[i]] = i;
4523c1f6 2367 if (!this.visibility()[i - 1]) continue;
82c6fe4d 2368 this.layout_.addDataset(labels[i], datasets[i]);
857a6931 2369 this.datasetIndex_[i] = dataIdx++;
43af96e7
NK
2370 }
2371
6faebb69 2372 this.computeYAxisRanges_(extremes);
b2c9222a
DV
2373 this.layout_.setYAxes(this.axes_);
2374
6a1aa64f
DV
2375 this.addXTicks_();
2376
b2c9222a 2377 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
81856f70 2378 var tmp_zoomed_x = this.zoomed_x_;
6a1aa64f 2379 // Tell PlotKit to use this new data and render itself
b2c9222a 2380 this.layout_.setDateWindow(this.dateWindow_);
81856f70 2381 this.zoomed_x_ = tmp_zoomed_x;
6a1aa64f 2382 this.layout_.evaluateWithError();
e2c21500 2383 this.renderGraph_(is_initial_draw);
9ca829f2
DV
2384
2385 if (this.attr_("timingName")) {
2386 var end = new Date();
2387 if (console) {
758a629f 2388 console.log(this.attr_("timingName") + " - drawGraph: " + (end - start) + "ms");
9ca829f2
DV
2389 }
2390 }
2391};
2392
e2c21500
DV
2393/**
2394 * This does the work of drawing the chart. It assumes that the layout and axis
2395 * scales have already been set (e.g. by predraw_).
2396 *
2397 * @private
2398 */
2399Dygraph.prototype.renderGraph_ = function(is_initial_draw) {
1748a51c 2400 this.cascadeEvents_('clearChart');
6a1aa64f 2401 this.plotter_.clear();
f417e3d3 2402
98eb4713
DV
2403 if (this.attr_('underlayCallback')) {
2404 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2405 // users who expect a deprecated form of this callback.
2406 this.attr_('underlayCallback')(
2407 this.hidden_ctx_, this.layout_.getPlotArea(), this, this);
2408 }
2409
2410 var e = {
189f8030 2411 canvas: this.hidden_,
2de7166c 2412 drawingContext: this.hidden_ctx_
98eb4713
DV
2413 };
2414 this.cascadeEvents_('willDrawChart', e);
6a1aa64f 2415 this.plotter_.render();
98eb4713 2416 this.cascadeEvents_('didDrawChart', e);
8cfe592f
DV
2417
2418 // TODO(danvk): is this a performance bottleneck when panning?
2419 // The interaction canvas should already be empty in that situation.
f6401bf6 2420 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2f5e7e1a 2421 this.canvas_.height);
599fb4ad 2422
4a0cb9c4 2423 // Generate a static legend before any particular point is selected.
2fccd3dc 2424
ccd9d7c2
PF
2425 if (this.rangeSelector_) {
2426 this.rangeSelector_.renderInteractiveLayer();
2427 }
599fb4ad 2428 if (this.attr_("drawCallback") !== null) {
fe0b7c03 2429 this.attr_("drawCallback")(this, is_initial_draw);
599fb4ad 2430 }
6a1aa64f
DV
2431};
2432
2433/**
629a09ae 2434 * @private
26ca7938
DV
2435 * Determine properties of the y-axes which are independent of the data
2436 * currently being displayed. This includes things like the number of axes and
2437 * the style of the axes. It does not include the range of each axis and its
2438 * tick marks.
2439 * This fills in this.axes_ and this.seriesToAxisMap_.
2440 * axes_ = [ { options } ]
2441 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2442 * indices are into the axes_ array.
f09fc545 2443 */
26ca7938 2444Dygraph.prototype.computeYAxes_ = function() {
d64b8fea
RK
2445 // Preserve valueWindow settings if they exist, and if the user hasn't
2446 // specified a new valueRange.
4dd0ac55 2447 var i, valueWindows, seriesName, axis, index, opts, v;
758a629f 2448 if (this.axes_ !== undefined && this.user_attrs_.hasOwnProperty("valueRange") === false) {
d64b8fea 2449 valueWindows = [];
758a629f 2450 for (index = 0; index < this.axes_.length; index++) {
d64b8fea
RK
2451 valueWindows.push(this.axes_[index].valueWindow);
2452 }
2453 }
2454
00aa7f61 2455 this.axes_ = [{ yAxisId : 0, g : this }]; // always have at least one y-axis.
26ca7938
DV
2456 this.seriesToAxisMap_ = {};
2457
2458 // Get a list of series names.
2459 var labels = this.attr_("labels");
1c77a3a1 2460 var series = {};
758a629f 2461 for (i = 1; i < labels.length; i++) series[labels[i]] = (i - 1);
f09fc545
DV
2462
2463 // all options which could be applied per-axis:
2464 var axisOptions = [
2465 'includeZero',
2466 'valueRange',
2467 'labelsKMB',
2468 'labelsKMG2',
2469 'pixelsPerYLabel',
2470 'yAxisLabelWidth',
2471 'axisLabelFontSize',
7d0e7a0d
RK
2472 'axisTickSize',
2473 'logscale'
f09fc545
DV
2474 ];
2475
2476 // Copy global axis options over to the first axis.
758a629f 2477 for (i = 0; i < axisOptions.length; i++) {
f09fc545 2478 var k = axisOptions[i];
4dd0ac55 2479 v = this.attr_(k);
26ca7938 2480 if (v) this.axes_[0][k] = v;
f09fc545
DV
2481 }
2482
2483 // Go through once and add all the axes.
758a629f 2484 for (seriesName in series) {
26ca7938 2485 if (!series.hasOwnProperty(seriesName)) continue;
758a629f
DV
2486 axis = this.attr_("axis", seriesName);
2487 if (axis === null) {
26ca7938 2488 this.seriesToAxisMap_[seriesName] = 0;
f09fc545
DV
2489 continue;
2490 }
2491 if (typeof(axis) == 'object') {
2492 // Add a new axis, making a copy of its per-axis options.
4dd0ac55 2493 opts = {};
26ca7938 2494 Dygraph.update(opts, this.axes_[0]);
f09fc545 2495 Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this.
00aa7f61
RK
2496 var yAxisId = this.axes_.length;
2497 opts.yAxisId = yAxisId;
2498 opts.g = this;
f09fc545 2499 Dygraph.update(opts, axis);
26ca7938 2500 this.axes_.push(opts);
00aa7f61 2501 this.seriesToAxisMap_[seriesName] = yAxisId;
f09fc545
DV
2502 }
2503 }
2504
2505 // Go through one more time and assign series to an axis defined by another
2506 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
758a629f 2507 for (seriesName in series) {
26ca7938 2508 if (!series.hasOwnProperty(seriesName)) continue;
758a629f 2509 axis = this.attr_("axis", seriesName);
f09fc545 2510 if (typeof(axis) == 'string') {
26ca7938 2511 if (!this.seriesToAxisMap_.hasOwnProperty(axis)) {
f09fc545
DV
2512 this.error("Series " + seriesName + " wants to share a y-axis with " +
2513 "series " + axis + ", which does not define its own axis.");
2514 return null;
2515 }
26ca7938
DV
2516 var idx = this.seriesToAxisMap_[axis];
2517 this.seriesToAxisMap_[seriesName] = idx;
f09fc545
DV
2518 }
2519 }
1c77a3a1 2520
758a629f 2521 if (valueWindows !== undefined) {
d64b8fea 2522 // Restore valueWindow settings.
758a629f 2523 for (index = 0; index < valueWindows.length; index++) {
d64b8fea
RK
2524 this.axes_[index].valueWindow = valueWindows[index];
2525 }
2526 }
4dd0ac55
RV
2527
2528 // New axes options
2529 for (axis = 0; axis < this.axes_.length; axis++) {
2530 if (axis === 0) {
2531 opts = this.optionsViewForAxis_('y' + (axis ? '2' : ''));
2532 v = opts("valueRange");
2533 if (v) this.axes_[axis].valueRange = v;
2534 } else { // To keep old behavior
2535 var axes = this.user_attrs_.axes;
2536 if (axes && axes.y2) {
2537 v = axes.y2.valueRange;
2538 if (v) this.axes_[axis].valueRange = v;
2539 }
2540 }
2541 }
2542
26ca7938
DV
2543};
2544
2545/**
2546 * Returns the number of y-axes on the chart.
2547 * @return {Number} the number of axes.
2548 */
2549Dygraph.prototype.numAxes = function() {
2550 var last_axis = 0;
2551 for (var series in this.seriesToAxisMap_) {
2552 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2553 var idx = this.seriesToAxisMap_[series];
2554 if (idx > last_axis) last_axis = idx;
2555 }
2556 return 1 + last_axis;
2557};
2558
2559/**
629a09ae 2560 * @private
b2c9222a
DV
2561 * Returns axis properties for the given series.
2562 * @param { String } setName The name of the series for which to get axis
2563 * properties, e.g. 'Y1'.
2564 * @return { Object } The axis properties.
2565 */
2566Dygraph.prototype.axisPropertiesForSeries = function(series) {
2567 // TODO(danvk): handle errors.
2568 return this.axes_[this.seriesToAxisMap_[series]];
2569};
2570
2571/**
2572 * @private
26ca7938
DV
2573 * Determine the value range and tick marks for each axis.
2574 * @param {Object} extremes A mapping from seriesName -> [low, high]
2575 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2576 */
2577Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2578 // Build a map from axis number -> [list of series names]
758a629f
DV
2579 var seriesForAxis = [], series;
2580 for (series in this.seriesToAxisMap_) {
26ca7938
DV
2581 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2582 var idx = this.seriesToAxisMap_[series];
2583 while (seriesForAxis.length <= idx) seriesForAxis.push([]);
2584 seriesForAxis[idx].push(series);
2585 }
f09fc545
DV
2586
2587 // Compute extreme values, a span and tick marks for each axis.
26ca7938
DV
2588 for (var i = 0; i < this.axes_.length; i++) {
2589 var axis = this.axes_[i];
25f76ae3 2590
06fc69b6
AV
2591 if (!seriesForAxis[i]) {
2592 // If no series are defined or visible then use a reasonable default
2593 axis.extremeRange = [0, 1];
2594 } else {
1c77a3a1 2595 // Calculate the extremes of extremes.
758a629f 2596 series = seriesForAxis[i];
f09fc545
DV
2597 var minY = Infinity; // extremes[series[0]][0];
2598 var maxY = -Infinity; // extremes[series[0]][1];
ba049b89 2599 var extremeMinY, extremeMaxY;
a2da3777 2600
f09fc545 2601 for (var j = 0; j < series.length; j++) {
a2da3777
DV
2602 // this skips invisible series
2603 if (!extremes.hasOwnProperty(series[j])) continue;
2604
ba049b89
NN
2605 // Only use valid extremes to stop null data series' from corrupting the scale.
2606 extremeMinY = extremes[series[j]][0];
758a629f 2607 if (extremeMinY !== null) {
36dfa958 2608 minY = Math.min(extremeMinY, minY);
ba049b89
NN
2609 }
2610 extremeMaxY = extremes[series[j]][1];
758a629f 2611 if (extremeMaxY !== null) {
36dfa958 2612 maxY = Math.max(extremeMaxY, maxY);
ba049b89 2613 }
f09fc545
DV
2614 }
2615 if (axis.includeZero && minY > 0) minY = 0;
2616
a2da3777 2617 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
36dfa958 2618 if (minY == Infinity) minY = 0;
a2da3777 2619 if (maxY == -Infinity) maxY = 1;
ba049b89 2620
f09fc545
DV
2621 // Add some padding and round up to an integer to be human-friendly.
2622 var span = maxY - minY;
2623 // special case: if we have no sense of scale, use +/-10% of the sole value.
758a629f 2624 if (span === 0) { span = maxY; }
f09fc545 2625
758a629f 2626 var maxAxisY, minAxisY;
7d0e7a0d 2627 if (axis.logscale) {
758a629f
DV
2628 maxAxisY = maxY + 0.1 * span;
2629 minAxisY = minY;
ff022deb 2630 } else {
758a629f
DV
2631 maxAxisY = maxY + 0.1 * span;
2632 minAxisY = minY - 0.1 * span;
f09fc545 2633
ff022deb
RK
2634 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2635 if (!this.attr_("avoidMinZero")) {
2636 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2637 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
2638 }
f09fc545 2639
ff022deb
RK
2640 if (this.attr_("includeZero")) {
2641 if (maxY < 0) maxAxisY = 0;
2642 if (minY > 0) minAxisY = 0;
2643 }
f09fc545 2644 }
4cac8c7a
RK
2645 axis.extremeRange = [minAxisY, maxAxisY];
2646 }
2647 if (axis.valueWindow) {
2648 // This is only set if the user has zoomed on the y-axis. It is never set
2649 // by a user. It takes precedence over axis.valueRange because, if you set
2650 // valueRange, you'd still expect to be able to pan.
2651 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
2652 } else if (axis.valueRange) {
2653 // This is a user-set value range for this axis.
2654 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
2655 } else {
2656 axis.computedValueRange = axis.extremeRange;
f09fc545
DV
2657 }
2658
0d64e596
DV
2659 // Add ticks. By default, all axes inherit the tick positions of the
2660 // primary axis. However, if an axis is specifically marked as having
2661 // independent ticks, then that is permissible as well.
48e614ac
DV
2662 var opts = this.optionsViewForAxis_('y' + (i ? '2' : ''));
2663 var ticker = opts('ticker');
758a629f 2664 if (i === 0 || axis.independentTicks) {
48e614ac
DV
2665 axis.ticks = ticker(axis.computedValueRange[0],
2666 axis.computedValueRange[1],
2667 this.height_, // TODO(danvk): should be area.height
2668 opts,
2669 this);
0d64e596
DV
2670 } else {
2671 var p_axis = this.axes_[0];
2672 var p_ticks = p_axis.ticks;
2673 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
2674 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
2675 var tick_values = [];
25f76ae3
DV
2676 for (var k = 0; k < p_ticks.length; k++) {
2677 var y_frac = (p_ticks[k].v - p_axis.computedValueRange[0]) / p_scale;
0d64e596
DV
2678 var y_val = axis.computedValueRange[0] + y_frac * scale;
2679 tick_values.push(y_val);
2680 }
2681
48e614ac
DV
2682 axis.ticks = ticker(axis.computedValueRange[0],
2683 axis.computedValueRange[1],
2684 this.height_, // TODO(danvk): should be area.height
2685 opts,
2686 this,
2687 tick_values);
0d64e596 2688 }
f09fc545 2689 }
f09fc545 2690};
25f76ae3 2691
f09fc545 2692/**
b1a3b195
DV
2693 * Extracts one series from the raw data (a 2D array) into an array of (date,
2694 * value) tuples.
2695 *
2696 * This is where undesirable points (i.e. negative values on log scales and
2697 * missing values through which we wish to connect lines) are dropped.
0604287e 2698 * TODO(danvk): the "missing values" bit above doesn't seem right.
de8f284f 2699 *
b1a3b195
DV
2700 * @private
2701 */
04c104d7 2702Dygraph.prototype.extractSeries_ = function(rawData, i, logScale) {
0604287e 2703 // TODO(danvk): pre-allocate series here.
b1a3b195
DV
2704 var series = [];
2705 for (var j = 0; j < rawData.length; j++) {
2706 var x = rawData[j][0];
2707 var point = rawData[j][i];
2708 if (logScale) {
2709 // On the log scale, points less than zero do not exist.
04c104d7 2710 // This will create a gap in the chart.
b1a3b195
DV
2711 if (point <= 0) {
2712 point = null;
2713 }
b1a3b195 2714 }
04c104d7 2715 series.push([x, point]);
b1a3b195
DV
2716 }
2717 return series;
2718};
2719
2720/**
629a09ae 2721 * @private
6a1aa64f
DV
2722 * Calculates the rolling average of a data set.
2723 * If originalData is [label, val], rolls the average of those.
2724 * If originalData is [label, [, it's interpreted as [value, stddev]
2725 * and the roll is returned in the same form, with appropriately reduced
2726 * stddev for each value.
2727 * Note that this is where fractional input (i.e. '5/10') is converted into
2728 * decimal values.
2729 * @param {Array} originalData The data in the appropriate format (see above)
6faebb69
JB
2730 * @param {Number} rollPeriod The number of points over which to average the
2731 * data
6a1aa64f 2732 */
285a6bda 2733Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
6a1aa64f
DV
2734 if (originalData.length < 2)
2735 return originalData;
758a629f 2736 rollPeriod = Math.min(rollPeriod, originalData.length);
6a1aa64f 2737 var rollingData = [];
285a6bda 2738 var sigma = this.attr_("sigma");
6a1aa64f 2739
758a629f 2740 var low, high, i, j, y, sum, num_ok, stddev;
6a1aa64f
DV
2741 if (this.fractions_) {
2742 var num = 0;
2743 var den = 0; // numerator/denominator
2744 var mult = 100.0;
758a629f 2745 for (i = 0; i < originalData.length; i++) {
6a1aa64f
DV
2746 num += originalData[i][1][0];
2747 den += originalData[i][1][1];
2748 if (i - rollPeriod >= 0) {
2749 num -= originalData[i - rollPeriod][1][0];
2750 den -= originalData[i - rollPeriod][1][1];
2751 }
2752
2753 var date = originalData[i][0];
2754 var value = den ? num / den : 0.0;
285a6bda 2755 if (this.attr_("errorBars")) {
395e98a3 2756 if (this.attr_("wilsonInterval")) {
6a1aa64f
DV
2757 // For more details on this confidence interval, see:
2758 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
2759 if (den) {
2760 var p = value < 0 ? 0 : value, n = den;
2761 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
2762 var denom = 1 + sigma * sigma / den;
758a629f
DV
2763 low = (p + sigma * sigma / (2 * den) - pm) / denom;
2764 high = (p + sigma * sigma / (2 * den) + pm) / denom;
6a1aa64f
DV
2765 rollingData[i] = [date,
2766 [p * mult, (p - low) * mult, (high - p) * mult]];
2767 } else {
2768 rollingData[i] = [date, [0, 0, 0]];
2769 }
2770 } else {
758a629f 2771 stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
6a1aa64f
DV
2772 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
2773 }
2774 } else {
2775 rollingData[i] = [date, mult * value];
2776 }
2777 }
9922b78b 2778 } else if (this.attr_("customBars")) {
758a629f 2779 low = 0;
f6885d6a 2780 var mid = 0;
758a629f 2781 high = 0;
f6885d6a 2782 var count = 0;
758a629f 2783 for (i = 0; i < originalData.length; i++) {
6a1aa64f 2784 var data = originalData[i][1];
758a629f 2785 y = data[1];
6a1aa64f 2786 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
f6885d6a 2787
758a629f 2788 if (y !== null && !isNaN(y)) {
49a7d0d5
DV
2789 low += data[0];
2790 mid += y;
2791 high += data[2];
2792 count += 1;
2793 }
f6885d6a
DV
2794 if (i - rollPeriod >= 0) {
2795 var prev = originalData[i - rollPeriod];
758a629f 2796 if (prev[1][1] !== null && !isNaN(prev[1][1])) {
49a7d0d5
DV
2797 low -= prev[1][0];
2798 mid -= prev[1][1];
2799 high -= prev[1][2];
2800 count -= 1;
2801 }
f6885d6a 2802 }
502d5996
DV
2803 if (count) {
2804 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
2805 1.0 * (mid - low) / count,
2806 1.0 * (high - mid) / count ]];
2807 } else {
2808 rollingData[i] = [originalData[i][0], [null, null, null]];
2809 }
2769de62 2810 }
6a1aa64f
DV
2811 } else {
2812 // Calculate the rolling average for the first rollPeriod - 1 points where
6faebb69 2813 // there is not enough data to roll over the full number of points
285a6bda 2814 if (!this.attr_("errorBars")){
5011e7a1
DV
2815 if (rollPeriod == 1) {
2816 return originalData;
2817 }
2818
758a629f
DV
2819 for (i = 0; i < originalData.length; i++) {
2820 sum = 0;
2821 num_ok = 0;
2822 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2823 y = originalData[j][1];
2824 if (y === null || isNaN(y)) continue;
5011e7a1 2825 num_ok++;
2847c1cf 2826 sum += originalData[j][1];
6a1aa64f 2827 }
5011e7a1 2828 if (num_ok) {
2847c1cf 2829 rollingData[i] = [originalData[i][0], sum / num_ok];
5011e7a1 2830 } else {
2847c1cf 2831 rollingData[i] = [originalData[i][0], null];
5011e7a1 2832 }
6a1aa64f 2833 }
2847c1cf
DV
2834
2835 } else {
758a629f
DV
2836 for (i = 0; i < originalData.length; i++) {
2837 sum = 0;
6a1aa64f 2838 var variance = 0;
758a629f
DV
2839 num_ok = 0;
2840 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2841 y = originalData[j][1][0];
2842 if (y === null || isNaN(y)) continue;
5011e7a1 2843 num_ok++;
6a1aa64f
DV
2844 sum += originalData[j][1][0];
2845 variance += Math.pow(originalData[j][1][1], 2);
2846 }
5011e7a1 2847 if (num_ok) {
758a629f 2848 stddev = Math.sqrt(variance) / num_ok;
5011e7a1
DV
2849 rollingData[i] = [originalData[i][0],
2850 [sum / num_ok, sigma * stddev, sigma * stddev]];
2851 } else {
2852 rollingData[i] = [originalData[i][0], [null, null, null]];
2853 }
6a1aa64f
DV
2854 }
2855 }
2856 }
2857
2858 return rollingData;
2859};
2860
2861/**
285a6bda
DV
2862 * Detects the type of the str (date or numeric) and sets the various
2863 * formatting attributes in this.attrs_ based on this type.
2864 * @param {String} str An x value.
2865 * @private
2866 */
2867Dygraph.prototype.detectTypeFromString_ = function(str) {
2868 var isDate = false;
0842b24b
DV
2869 var dashPos = str.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2870 if ((dashPos > 0 && (str[dashPos-1] != 'e' && str[dashPos-1] != 'E')) ||
285a6bda
DV
2871 str.indexOf('/') >= 0 ||
2872 isNaN(parseFloat(str))) {
2873 isDate = true;
2874 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
2875 // TODO(danvk): remove support for this format.
2876 isDate = true;
2877 }
2878
2879 if (isDate) {
285a6bda 2880 this.attrs_.xValueParser = Dygraph.dateParser;
48e614ac
DV
2881 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2882 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2883 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
285a6bda 2884 } else {
c39e1d93 2885 /** @private (shut up, jsdoc!) */
285a6bda 2886 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
48e614ac
DV
2887 // TODO(danvk): use Dygraph.numberValueFormatter here?
2888 /** @private (shut up, jsdoc!) */
2889 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
44462ba3 2890 this.attrs_.axes.x.ticker = Dygraph.numericLinearTicks;
48e614ac 2891 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
6a1aa64f 2892 }
6a1aa64f
DV
2893};
2894
2895/**
5cd7ac68
DV
2896 * Parses the value as a floating point number. This is like the parseFloat()
2897 * built-in, but with a few differences:
2898 * - the empty string is parsed as null, rather than NaN.
2899 * - if the string cannot be parsed at all, an error is logged.
2900 * If the string can't be parsed, this method returns null.
2901 * @param {String} x The string to be parsed
2902 * @param {Number} opt_line_no The line number from which the string comes.
2903 * @param {String} opt_line The text of the line from which the string comes.
2904 * @private
2905 */
2906
2907// Parse the x as a float or return null if it's not a number.
2908Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) {
2909 var val = parseFloat(x);
2910 if (!isNaN(val)) return val;
2911
2912 // Try to figure out what happeend.
2913 // If the value is the empty string, parse it as null.
2914 if (/^ *$/.test(x)) return null;
2915
2916 // If it was actually "NaN", return it as NaN.
2917 if (/^ *nan *$/i.test(x)) return NaN;
2918
2919 // Looks like a parsing error.
2920 var msg = "Unable to parse '" + x + "' as a number";
2921 if (opt_line !== null && opt_line_no !== null) {
2922 msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV.";
2923 }
2924 this.error(msg);
2925
2926 return null;
2927};
2928
2929/**
629a09ae 2930 * @private
6a1aa64f
DV
2931 * Parses a string in a special csv format. We expect a csv file where each
2932 * line is a date point, and the first field in each line is the date string.
2933 * We also expect that all remaining fields represent series.
285a6bda 2934 * if the errorBars attribute is set, then interpret the fields as:
6a1aa64f 2935 * date, series1, stddev1, series2, stddev2, ...
629a09ae 2936 * @param {[Object]} data See above.
285a6bda 2937 *
629a09ae 2938 * @return [Object] An array with one entry for each row. These entries
285a6bda
DV
2939 * are an array of cells in that row. The first entry is the parsed x-value for
2940 * the row. The second, third, etc. are the y-values. These can take on one of
2941 * three forms, depending on the CSV and constructor parameters:
2942 * 1. numeric value
2943 * 2. [ value, stddev ]
2944 * 3. [ low value, center value, high value ]
6a1aa64f 2945 */
285a6bda 2946Dygraph.prototype.parseCSV_ = function(data) {
6a1aa64f 2947 var ret = [];
e5763589
DV
2948 var line_delimiter = Dygraph.detectLineDelimiter(data);
2949 var lines = data.split(line_delimiter || "\n");
758a629f 2950 var vals, j;
3d67f03b
DV
2951
2952 // Use the default delimiter or fall back to a tab if that makes sense.
2953 var delim = this.attr_('delimiter');
2954 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
2955 delim = '\t';
2956 }
2957
285a6bda 2958 var start = 0;
d7beab6b
DV
2959 if (!('labels' in this.user_attrs_)) {
2960 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
285a6bda 2961 start = 1;
d7beab6b 2962 this.attrs_.labels = lines[0].split(delim); // NOTE: _not_ user_attrs_.
6a1aa64f 2963 }
5cd7ac68 2964 var line_no = 0;
03b522a4 2965
285a6bda
DV
2966 var xParser;
2967 var defaultParserSet = false; // attempt to auto-detect x value type
2968 var expectedCols = this.attr_("labels").length;
987840a2 2969 var outOfOrder = false;
6a1aa64f
DV
2970 for (var i = start; i < lines.length; i++) {
2971 var line = lines[i];
5cd7ac68 2972 line_no = i;
758a629f 2973 if (line.length === 0) continue; // skip blank lines
3d67f03b
DV
2974 if (line[0] == '#') continue; // skip comment lines
2975 var inFields = line.split(delim);
285a6bda 2976 if (inFields.length < 2) continue;
6a1aa64f
DV
2977
2978 var fields = [];
285a6bda
DV
2979 if (!defaultParserSet) {
2980 this.detectTypeFromString_(inFields[0]);
2981 xParser = this.attr_("xValueParser");
2982 defaultParserSet = true;
2983 }
2984 fields[0] = xParser(inFields[0], this);
6a1aa64f
DV
2985
2986 // If fractions are expected, parse the numbers as "A/B"
2987 if (this.fractions_) {
758a629f 2988 for (j = 1; j < inFields.length; j++) {
6a1aa64f 2989 // TODO(danvk): figure out an appropriate way to flag parse errors.
758a629f 2990 vals = inFields[j].split("/");
7219edb3
DV
2991 if (vals.length != 2) {
2992 this.error('Expected fractional "num/den" values in CSV data ' +
2993 "but found a value '" + inFields[j] + "' on line " +
2994 (1 + i) + " ('" + line + "') which is not of this form.");
2995 fields[j] = [0, 0];
2996 } else {
2997 fields[j] = [this.parseFloat_(vals[0], i, line),
2998 this.parseFloat_(vals[1], i, line)];
2999 }
6a1aa64f 3000 }
285a6bda 3001 } else if (this.attr_("errorBars")) {
6a1aa64f 3002 // If there are error bars, values are (value, stddev) pairs
7219edb3
DV
3003 if (inFields.length % 2 != 1) {
3004 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3005 'but line ' + (1 + i) + ' has an odd number of values (' +
3006 (inFields.length - 1) + "): '" + line + "'");
3007 }
758a629f 3008 for (j = 1; j < inFields.length; j += 2) {
5cd7ac68
DV
3009 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3010 this.parseFloat_(inFields[j + 1], i, line)];
7219edb3 3011 }
9922b78b 3012 } else if (this.attr_("customBars")) {
6a1aa64f 3013 // Bars are a low;center;high tuple
758a629f 3014 for (j = 1; j < inFields.length; j++) {
327a9279
DV
3015 var val = inFields[j];
3016 if (/^ *$/.test(val)) {
3017 fields[j] = [null, null, null];
3018 } else {
758a629f 3019 vals = val.split(";");
327a9279
DV
3020 if (vals.length == 3) {
3021 fields[j] = [ this.parseFloat_(vals[0], i, line),
3022 this.parseFloat_(vals[1], i, line),
3023 this.parseFloat_(vals[2], i, line) ];
3024 } else {
1a5dc2af
RK
3025 this.warn('When using customBars, values must be either blank ' +
3026 'or "low;center;high" tuples (got "' + val +
3027 '" on line ' + (1+i));
327a9279
DV
3028 }
3029 }
6a1aa64f
DV
3030 }
3031 } else {
3032 // Values are just numbers
758a629f 3033 for (j = 1; j < inFields.length; j++) {
5cd7ac68 3034 fields[j] = this.parseFloat_(inFields[j], i, line);
285a6bda 3035 }
6a1aa64f 3036 }
987840a2
DV
3037 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3038 outOfOrder = true;
3039 }
285a6bda
DV
3040
3041 if (fields.length != expectedCols) {
3042 this.error("Number of columns in line " + i + " (" + fields.length +
3043 ") does not agree with number of labels (" + expectedCols +
3044 ") " + line);
3045 }
6d0aaa09
DV
3046
3047 // If the user specified the 'labels' option and none of the cells of the
3048 // first row parsed correctly, then they probably double-specified the
3049 // labels. We go with the values set in the option, discard this row and
3050 // log a warning to the JS console.
758a629f 3051 if (i === 0 && this.attr_('labels')) {
6d0aaa09 3052 var all_null = true;
758a629f 3053 for (j = 0; all_null && j < fields.length; j++) {
6d0aaa09
DV
3054 if (fields[j]) all_null = false;
3055 }
3056 if (all_null) {
3057 this.warn("The dygraphs 'labels' option is set, but the first row of " +
3058 "CSV data ('" + line + "') appears to also contain labels. " +
3059 "Will drop the CSV labels and use the option labels.");
3060 continue;
3061 }
3062 }
3063 ret.push(fields);
6a1aa64f 3064 }
987840a2
DV
3065
3066 if (outOfOrder) {
3067 this.warn("CSV is out of order; order it correctly to speed loading.");
758a629f 3068 ret.sort(function(a,b) { return a[0] - b[0]; });
987840a2
DV
3069 }
3070
6a1aa64f
DV
3071 return ret;
3072};
3073
3074/**
629a09ae 3075 * @private
285a6bda
DV
3076 * The user has provided their data as a pre-packaged JS array. If the x values
3077 * are numeric, this is the same as dygraphs' internal format. If the x values
3078 * are dates, we need to convert them from Date objects to ms since epoch.
629a09ae
DV
3079 * @param {[Object]} data
3080 * @return {[Object]} data with numeric x values.
285a6bda
DV
3081 */
3082Dygraph.prototype.parseArray_ = function(data) {
3083 // Peek at the first x value to see if it's numeric.
758a629f 3084 if (data.length === 0) {
285a6bda
DV
3085 this.error("Can't plot empty data set");
3086 return null;
3087 }
758a629f 3088 if (data[0].length === 0) {
285a6bda
DV
3089 this.error("Data set cannot contain an empty row");
3090 return null;
3091 }
3092
758a629f
DV
3093 var i;
3094 if (this.attr_("labels") === null) {
285a6bda
DV
3095 this.warn("Using default labels. Set labels explicitly via 'labels' " +
3096 "in the options parameter");
3097 this.attrs_.labels = [ "X" ];
758a629f 3098 for (i = 1; i < data[0].length; i++) {
285a6bda
DV
3099 this.attrs_.labels.push("Y" + i);
3100 }
debdb88d
DV
3101 } else {
3102 var num_labels = this.attr_("labels");
3103 if (num_labels.length != data[0].length) {
3104 this.error("Mismatch between number of labels (" + num_labels +
3105 ") and number of columns in array (" + data[0].length + ")");
3106 return null;
3107 }
285a6bda
DV
3108 }
3109
2dda3850 3110 if (Dygraph.isDateLike(data[0][0])) {
285a6bda 3111 // Some intelligent defaults for a date x-axis.
48e614ac
DV
3112 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3113 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3114 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
285a6bda
DV
3115
3116 // Assume they're all dates.
e3ab7b40 3117 var parsedData = Dygraph.clone(data);
758a629f
DV
3118 for (i = 0; i < data.length; i++) {
3119 if (parsedData[i].length === 0) {
a323ff4a 3120 this.error("Row " + (1 + i) + " of data is empty");
285a6bda
DV
3121 return null;
3122 }
758a629f
DV
3123 if (parsedData[i][0] === null ||
3124 typeof(parsedData[i][0].getTime) != 'function' ||
3125 isNaN(parsedData[i][0].getTime())) {
be96a1f5 3126 this.error("x value in row " + (1 + i) + " is not a Date");
285a6bda
DV
3127 return null;
3128 }
3129 parsedData[i][0] = parsedData[i][0].getTime();
3130 }
3131 return parsedData;
3132 } else {
3133 // Some intelligent defaults for a numeric x-axis.
c39e1d93 3134 /** @private (shut up, jsdoc!) */
48e614ac
DV
3135 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
3136 this.attrs_.axes.x.axisLabelFormatter = Dygraph.numberAxisLabelFormatter;
44462ba3 3137 this.attrs_.axes.x.ticker = Dygraph.numericLinearTicks;
285a6bda
DV
3138 return data;
3139 }
3140};
3141
3142/**
79420a1e
DV
3143 * Parses a DataTable object from gviz.
3144 * The data is expected to have a first column that is either a date or a
3145 * number. All subsequent columns must be numbers. If there is a clear mismatch
3146 * between this.xValueParser_ and the type of the first column, it will be
a685723c 3147 * fixed. Fills out rawData_.
629a09ae 3148 * @param {[Object]} data See above.
79420a1e
DV
3149 * @private
3150 */
285a6bda 3151Dygraph.prototype.parseDataTable_ = function(data) {
5829af3d 3152 var shortTextForAnnotationNum = function(num) {
3153 // converts [0-9]+ [A-Z][a-z]*
3154 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3155 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3156 var shortText = String.fromCharCode(65 /* A */ + num % 26);
3157 num = Math.floor(num / 26);
3158 while ( num > 0 ) {
3159 shortText = String.fromCharCode(65 /* A */ + (num - 1) % 26 ) + shortText.toLowerCase();
3160 num = Math.floor((num - 1) / 26);
3161 }
3162 return shortText;
42a9ebb8 3163 };
5829af3d 3164
79420a1e
DV
3165 var cols = data.getNumberOfColumns();
3166 var rows = data.getNumberOfRows();
3167
d955e223 3168 var indepType = data.getColumnType(0);
4440f6c8 3169 if (indepType == 'date' || indepType == 'datetime') {
285a6bda 3170 this.attrs_.xValueParser = Dygraph.dateParser;
48e614ac
DV
3171 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3172 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3173 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
33127159 3174 } else if (indepType == 'number') {
285a6bda 3175 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
48e614ac 3176 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
44462ba3 3177 this.attrs_.axes.x.ticker = Dygraph.numericLinearTicks;
48e614ac 3178 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
285a6bda 3179 } else {
987840a2
DV
3180 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3181 "column 1 of DataTable input (Got '" + indepType + "')");
79420a1e
DV
3182 return null;
3183 }
3184
a685723c
DV
3185 // Array of the column indices which contain data (and not annotations).
3186 var colIdx = [];
3187 var annotationCols = {}; // data index -> [annotation cols]
3188 var hasAnnotations = false;
758a629f
DV
3189 var i, j;
3190 for (i = 1; i < cols; i++) {
a685723c
DV
3191 var type = data.getColumnType(i);
3192 if (type == 'number') {
3193 colIdx.push(i);
3194 } else if (type == 'string' && this.attr_('displayAnnotations')) {
3195 // This is OK -- it's an annotation column.
3196 var dataIdx = colIdx[colIdx.length - 1];
3197 if (!annotationCols.hasOwnProperty(dataIdx)) {
3198 annotationCols[dataIdx] = [i];
3199 } else {
3200 annotationCols[dataIdx].push(i);
3201 }
3202 hasAnnotations = true;
3203 } else {
3204 this.error("Only 'number' is supported as a dependent type with Gviz." +
3205 " 'string' is only supported if displayAnnotations is true");
3206 }
3207 }
3208
3209 // Read column labels
3210 // TODO(danvk): add support back for errorBars
3211 var labels = [data.getColumnLabel(0)];
758a629f 3212 for (i = 0; i < colIdx.length; i++) {
a685723c 3213 labels.push(data.getColumnLabel(colIdx[i]));
f9348814 3214 if (this.attr_("errorBars")) i += 1;
a685723c
DV
3215 }
3216 this.attrs_.labels = labels;
3217 cols = labels.length;
3218
79420a1e 3219 var ret = [];
987840a2 3220 var outOfOrder = false;
a685723c 3221 var annotations = [];
758a629f 3222 for (i = 0; i < rows; i++) {
79420a1e 3223 var row = [];
debe4434
DV
3224 if (typeof(data.getValue(i, 0)) === 'undefined' ||
3225 data.getValue(i, 0) === null) {
129569a5
FD
3226 this.warn("Ignoring row " + i +
3227 " of DataTable because of undefined or null first column.");
debe4434
DV
3228 continue;
3229 }
3230
c21d2c2d 3231 if (indepType == 'date' || indepType == 'datetime') {
d955e223
DV
3232 row.push(data.getValue(i, 0).getTime());
3233 } else {
3234 row.push(data.getValue(i, 0));
3235 }
3e3f84e4 3236 if (!this.attr_("errorBars")) {
758a629f 3237 for (j = 0; j < colIdx.length; j++) {
a685723c
DV
3238 var col = colIdx[j];
3239 row.push(data.getValue(i, col));
3240 if (hasAnnotations &&
3241 annotationCols.hasOwnProperty(col) &&
758a629f 3242 data.getValue(i, annotationCols[col][0]) !== null) {
a685723c
DV
3243 var ann = {};
3244 ann.series = data.getColumnLabel(col);
3245 ann.xval = row[0];
5829af3d 3246 ann.shortText = shortTextForAnnotationNum(annotations.length);
a685723c
DV
3247 ann.text = '';
3248 for (var k = 0; k < annotationCols[col].length; k++) {
3249 if (k) ann.text += "\n";
3250 ann.text += data.getValue(i, annotationCols[col][k]);
3251 }
3252 annotations.push(ann);
3253 }
3e3f84e4 3254 }
92fd68d8
DV
3255
3256 // Strip out infinities, which give dygraphs problems later on.
758a629f 3257 for (j = 0; j < row.length; j++) {
92fd68d8
DV
3258 if (!isFinite(row[j])) row[j] = null;
3259 }
3e3f84e4 3260 } else {
758a629f 3261 for (j = 0; j < cols - 1; j++) {
3e3f84e4
DV
3262 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
3263 }
79420a1e 3264 }
987840a2
DV
3265 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
3266 outOfOrder = true;
3267 }
243d96e8 3268 ret.push(row);
79420a1e 3269 }
987840a2
DV
3270
3271 if (outOfOrder) {
3272 this.warn("DataTable is out of order; order it correctly to speed loading.");
758a629f 3273 ret.sort(function(a,b) { return a[0] - b[0]; });
987840a2 3274 }
a685723c
DV
3275 this.rawData_ = ret;
3276
3277 if (annotations.length > 0) {
3278 this.setAnnotations(annotations, true);
3279 }
758a629f 3280};
79420a1e 3281
629a09ae 3282/**
6a1aa64f
DV
3283 * Get the CSV data. If it's in a function, call that function. If it's in a
3284 * file, do an XMLHttpRequest to get it.
3285 * @private
3286 */
285a6bda 3287Dygraph.prototype.start_ = function() {
36d4fabf
RK
3288 var data = this.file_;
3289
3290 // Functions can return references of all other types.
3291 if (typeof data == 'function') {
3292 data = data();
3293 }
3294
3295 if (Dygraph.isArrayLike(data)) {
3296 this.rawData_ = this.parseArray_(data);
26ca7938 3297 this.predraw_();
36d4fabf
RK
3298 } else if (typeof data == 'object' &&
3299 typeof data.getColumnRange == 'function') {
79420a1e 3300 // must be a DataTable from gviz.
36d4fabf 3301 this.parseDataTable_(data);
26ca7938 3302 this.predraw_();
36d4fabf 3303 } else if (typeof data == 'string') {
285a6bda 3304 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
e5763589
DV
3305 var line_delimiter = Dygraph.detectLineDelimiter(data);
3306 if (line_delimiter) {
36d4fabf 3307 this.loadedEvent_(data);
285a6bda
DV
3308 } else {
3309 var req = new XMLHttpRequest();
3310 var caller = this;
3311 req.onreadystatechange = function () {
3312 if (req.readyState == 4) {
758a629f
DV
3313 if (req.status === 200 || // Normal http
3314 req.status === 0) { // Chrome w/ --allow-file-access-from-files
285a6bda
DV
3315 caller.loadedEvent_(req.responseText);
3316 }
6a1aa64f 3317 }
285a6bda 3318 };
6a1aa64f 3319
36d4fabf 3320 req.open("GET", data, true);
285a6bda
DV
3321 req.send(null);
3322 }
3323 } else {
36d4fabf 3324 this.error("Unknown data format: " + (typeof data));
6a1aa64f
DV
3325 }
3326};
3327
3328/**
3329 * Changes various properties of the graph. These can include:
3330 * <ul>
3331 * <li>file: changes the source data for the graph</li>
3332 * <li>errorBars: changes whether the data contains stddev</li>
3333 * </ul>
dcb25130 3334 *
ccfcc169
DV
3335 * There's a huge variety of options that can be passed to this method. For a
3336 * full list, see http://dygraphs.com/options.html.
3337 *
6a1aa64f 3338 * @param {Object} attrs The new properties and values
ccfcc169
DV
3339 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3340 * call to updateOptions(). If you know better, you can pass true to explicitly
3341 * block the redraw. This can be useful for chaining updateOptions() calls,
3342 * avoiding the occasional infinite loop and preventing redraws when it's not
3343 * necessary (e.g. when updating a callback).
6a1aa64f 3344 */
48e614ac 3345Dygraph.prototype.updateOptions = function(input_attrs, block_redraw) {
ccfcc169
DV
3346 if (typeof(block_redraw) == 'undefined') block_redraw = false;
3347
48e614ac 3348 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
758a629f 3349 var file = input_attrs.file;
48e614ac
DV
3350 var attrs = Dygraph.mapLegacyOptions_(input_attrs);
3351
ccfcc169 3352 // TODO(danvk): this is a mess. Move these options into attr_.
c65f2303 3353 if ('rollPeriod' in attrs) {
6a1aa64f
DV
3354 this.rollPeriod_ = attrs.rollPeriod;
3355 }
c65f2303 3356 if ('dateWindow' in attrs) {
6a1aa64f 3357 this.dateWindow_ = attrs.dateWindow;
e5152598 3358 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
758a629f 3359 this.zoomed_x_ = (attrs.dateWindow !== null);
81856f70 3360 }
b7e5862d 3361 }
e5152598 3362 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
758a629f 3363 this.zoomed_y_ = (attrs.valueRange !== null);
6a1aa64f 3364 }
450fe64b
DV
3365
3366 // TODO(danvk): validate per-series options.
46dde5f9
DV
3367 // Supported:
3368 // strokeWidth
3369 // pointSize
3370 // drawPoints
3371 // highlightCircleSize
450fe64b 3372
9ca829f2
DV
3373 // Check if this set options will require new points.
3374 var requiresNewPoints = Dygraph.isPixelChangingOptionList(this.attr_("labels"), attrs);
3375
48e614ac 3376 Dygraph.updateDeep(this.user_attrs_, attrs);
285a6bda 3377
48e614ac
DV
3378 if (file) {
3379 this.file_ = file;
ccfcc169 3380 if (!block_redraw) this.start_();
6a1aa64f 3381 } else {
9ca829f2
DV
3382 if (!block_redraw) {
3383 if (requiresNewPoints) {
48e614ac 3384 this.predraw_();
9ca829f2 3385 } else {
e2c21500 3386 this.renderGraph_(false);
9ca829f2
DV
3387 }
3388 }
6a1aa64f
DV
3389 }
3390};
3391
3392/**
48e614ac
DV
3393 * Returns a copy of the options with deprecated names converted into current
3394 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3395 * interested in that, they should save a copy before calling this.
3396 * @private
3397 */
3398Dygraph.mapLegacyOptions_ = function(attrs) {
3399 var my_attrs = {};
3400 for (var k in attrs) {
3401 if (k == 'file') continue;
3402 if (attrs.hasOwnProperty(k)) my_attrs[k] = attrs[k];
3403 }
3404
3405 var set = function(axis, opt, value) {
3406 if (!my_attrs.axes) my_attrs.axes = {};
3407 if (!my_attrs.axes[axis]) my_attrs.axes[axis] = {};
3408 my_attrs.axes[axis][opt] = value;
3409 };
3410 var map = function(opt, axis, new_opt) {
3411 if (typeof(attrs[opt]) != 'undefined') {
3412 set(axis, new_opt, attrs[opt]);
3413 delete my_attrs[opt];
3414 }
3415 };
3416
3417 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3418 map('xValueFormatter', 'x', 'valueFormatter');
3419 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3420 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3421 map('xTicker', 'x', 'ticker');
3422 map('yValueFormatter', 'y', 'valueFormatter');
3423 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3424 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3425 map('yTicker', 'y', 'ticker');
3426 return my_attrs;
3427};
3428
3429/**
697e70b2
DV
3430 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3431 * containing div (which has presumably changed size since the dygraph was
3432 * instantiated. If the width/height are specified, the div will be resized.
964f30c6
DV
3433 *
3434 * This is far more efficient than destroying and re-instantiating a
3435 * Dygraph, since it doesn't have to reparse the underlying data.
3436 *
629a09ae
DV
3437 * @param {Number} [width] Width (in pixels)
3438 * @param {Number} [height] Height (in pixels)
697e70b2
DV
3439 */
3440Dygraph.prototype.resize = function(width, height) {
e8c7ef86
DV
3441 if (this.resize_lock) {
3442 return;
3443 }
3444 this.resize_lock = true;
3445
697e70b2
DV
3446 if ((width === null) != (height === null)) {
3447 this.warn("Dygraph.resize() should be called with zero parameters or " +
3448 "two non-NULL parameters. Pretending it was zero.");
3449 width = height = null;
3450 }
3451
4b4d1a63
DV
3452 var old_width = this.width_;
3453 var old_height = this.height_;
b16e6369 3454
697e70b2
DV
3455 if (width) {
3456 this.maindiv_.style.width = width + "px";
3457 this.maindiv_.style.height = height + "px";
3458 this.width_ = width;
3459 this.height_ = height;
3460 } else {
ccd9d7c2
PF
3461 this.width_ = this.maindiv_.clientWidth;
3462 this.height_ = this.maindiv_.clientHeight;
697e70b2
DV
3463 }
3464
4b4d1a63
DV
3465 if (old_width != this.width_ || old_height != this.height_) {
3466 // TODO(danvk): there should be a clear() method.
3467 this.maindiv_.innerHTML = "";
77b5e09d 3468 this.roller_ = null;
4b4d1a63
DV
3469 this.attrs_.labelsDiv = null;
3470 this.createInterface_();
c9faeafd
DV
3471 if (this.annotations_.length) {
3472 // createInterface_ reset the layout, so we need to do this.
3473 this.layout_.setAnnotations(this.annotations_);
3474 }
4b4d1a63
DV
3475 this.predraw_();
3476 }
e8c7ef86
DV
3477
3478 this.resize_lock = false;
697e70b2
DV
3479};
3480
3481/**
6faebb69 3482 * Adjusts the number of points in the rolling average. Updates the graph to
6a1aa64f 3483 * reflect the new averaging period.
6faebb69 3484 * @param {Number} length Number of points over which to average the data.
6a1aa64f 3485 */
285a6bda 3486Dygraph.prototype.adjustRoll = function(length) {
6a1aa64f 3487 this.rollPeriod_ = length;
26ca7938 3488 this.predraw_();
6a1aa64f 3489};
540d00f1 3490
f8cfec73 3491/**
1cf11047
DV
3492 * Returns a boolean array of visibility statuses.
3493 */
3494Dygraph.prototype.visibility = function() {
3495 // Do lazy-initialization, so that this happens after we know the number of
3496 // data series.
3497 if (!this.attr_("visibility")) {
758a629f 3498 this.attrs_.visibility = [];
1cf11047 3499 }
758a629f 3500 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs.
395e98a3 3501 while (this.attr_("visibility").length < this.numColumns() - 1) {
758a629f 3502 this.attrs_.visibility.push(true);
1cf11047
DV
3503 }
3504 return this.attr_("visibility");
3505};
3506
3507/**
3508 * Changes the visiblity of a series.
3509 */
3510Dygraph.prototype.setVisibility = function(num, value) {
3511 var x = this.visibility();
a6c109c1 3512 if (num < 0 || num >= x.length) {
1cf11047
DV
3513 this.warn("invalid series number in setVisibility: " + num);
3514 } else {
3515 x[num] = value;
26ca7938 3516 this.predraw_();
1cf11047
DV
3517 }
3518};
3519
3520/**
0cb9bd91
DV
3521 * How large of an area will the dygraph render itself in?
3522 * This is used for testing.
3523 * @return A {width: w, height: h} object.
3524 * @private
3525 */
3526Dygraph.prototype.size = function() {
3527 return { width: this.width_, height: this.height_ };
3528};
3529
3530/**
5c528fa2 3531 * Update the list of annotations and redraw the chart.
41ee764f
DV
3532 * See dygraphs.com/annotations.html for more info on how to use annotations.
3533 * @param ann {Array} An array of annotation objects.
3534 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
5c528fa2 3535 */
a685723c 3536Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3c51ab74
DV
3537 // Only add the annotation CSS rule once we know it will be used.
3538 Dygraph.addAnnotationRule();
5c528fa2
DV
3539 this.annotations_ = ann;
3540 this.layout_.setAnnotations(this.annotations_);
a685723c 3541 if (!suppressDraw) {
26ca7938 3542 this.predraw_();
a685723c 3543 }
5c528fa2
DV
3544};
3545
3546/**
3547 * Return the list of annotations.
3548 */
3549Dygraph.prototype.annotations = function() {
3550 return this.annotations_;
3551};
3552
46dde5f9 3553/**
82c6fe4d
KW
3554 * Get the list of label names for this graph. The first column is the
3555 * x-axis, so the data series names start at index 1.
3556 */
e2c21500 3557Dygraph.prototype.getLabels = function() {
82c6fe4d
KW
3558 return this.attr_("labels").slice();
3559};
3560
3561/**
46dde5f9
DV
3562 * Get the index of a series (column) given its name. The first column is the
3563 * x-axis, so the data series start with index 1.
3564 */
3565Dygraph.prototype.indexFromSetName = function(name) {
82c6fe4d 3566 return this.setIndexByName_[name];
46dde5f9
DV
3567};
3568
629a09ae 3569/**
857a6931
KW
3570 * Get the internal dataset index given its name. These are numbered starting from 0,
3571 * and only count visible sets.
3572 * @private
3573 */
3574Dygraph.prototype.datasetIndexFromSetName_ = function(name) {
3575 return this.datasetIndex_[this.indexFromSetName(name)];
3576};
3577
3578/**
629a09ae
DV
3579 * @private
3580 * Adds a default style for the annotation CSS classes to the document. This is
3581 * only executed when annotations are actually used. It is designed to only be
3582 * called once -- all calls after the first will return immediately.
3583 */
5c528fa2 3584Dygraph.addAnnotationRule = function() {
d38c6191 3585 // TODO(danvk): move this function into plugins/annotations.js?
5c528fa2
DV
3586 if (Dygraph.addedAnnotationCSS) return;
3587
5c528fa2
DV
3588 var rule = "border: 1px solid black; " +
3589 "background-color: white; " +
3590 "text-align: center;";
22186871
DV
3591
3592 var styleSheetElement = document.createElement("style");
3593 styleSheetElement.type = "text/css";
3594 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3595
3596 // Find the first style sheet that we can access.
3597 // We may not add a rule to a style sheet from another domain for security
3598 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3599 // adds its own style sheets from google.com.
3600 for (var i = 0; i < document.styleSheets.length; i++) {
3601 if (document.styleSheets[i].disabled) continue;
3602 var mysheet = document.styleSheets[i];
3603 try {
3604 if (mysheet.insertRule) { // Firefox
3605 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3606 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3607 } else if (mysheet.addRule) { // IE
3608 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3609 }
3610 Dygraph.addedAnnotationCSS = true;
3611 return;
3612 } catch(err) {
3613 // Was likely a security exception.
3614 }
5c528fa2
DV
3615 }
3616
22186871 3617 this.warn("Unable to add default annotation CSS rule; display may be off.");
758a629f 3618};
5c528fa2 3619
285a6bda 3620// Older pages may still use this name.
c0f54d4f 3621var DateGraph = Dygraph;