add auto_test from Issue 242
[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];
42a9ebb8
DV
1539 newValueRanges.push(axis.valueRange !== null ?
1540 axis.valueRange : axis.extremeRange);
b1a3b195
DV
1541 }
1542 }
1543
1544 var that = this;
1545 this.doAnimatedZoom(oldWindow, newWindow, oldValueRanges, newValueRanges,
1546 function() {
1547 that.dateWindow_ = null;
1548 for (var i = 0; i < that.axes_.length; i++) {
758a629f 1549 if (that.axes_[i].valueWindow !== null) {
b1a3b195
DV
1550 delete that.axes_[i].valueWindow;
1551 }
1552 }
1553 if (that.attr_("zoomCallback")) {
1554 that.attr_("zoomCallback")(minDate, maxDate, that.yAxisRanges());
1555 }
1556 });
1557 }
1558};
1559
1560/**
1561 * Combined animation logic for all zoom functions.
1562 * either the x parameters or y parameters may be null.
1563 * @private
1564 */
1565Dygraph.prototype.doAnimatedZoom = function(oldXRange, newXRange, oldYRanges, newYRanges, callback) {
1566 var steps = this.attr_("animatedZooms") ? Dygraph.ANIMATION_STEPS : 1;
1567
1568 var windows = [];
1569 var valueRanges = [];
758a629f 1570 var step, frac;
b1a3b195 1571
758a629f
DV
1572 if (oldXRange !== null && newXRange !== null) {
1573 for (step = 1; step <= steps; step++) {
1574 frac = Dygraph.zoomAnimationFunction(step, steps);
b1a3b195
DV
1575 windows[step-1] = [oldXRange[0]*(1-frac) + frac*newXRange[0],
1576 oldXRange[1]*(1-frac) + frac*newXRange[1]];
8b83c6cc 1577 }
67e650dc 1578 }
b1a3b195 1579
758a629f
DV
1580 if (oldYRanges !== null && newYRanges !== null) {
1581 for (step = 1; step <= steps; step++) {
1582 frac = Dygraph.zoomAnimationFunction(step, steps);
b1a3b195
DV
1583 var thisRange = [];
1584 for (var j = 0; j < this.axes_.length; j++) {
1585 thisRange.push([oldYRanges[j][0]*(1-frac) + frac*newYRanges[j][0],
1586 oldYRanges[j][1]*(1-frac) + frac*newYRanges[j][1]]);
1587 }
1588 valueRanges[step-1] = thisRange;
1589 }
1590 }
1591
1592 var that = this;
1593 Dygraph.repeatAndCleanup(function(step) {
1594 if (valueRanges.length) {
1595 for (var i = 0; i < that.axes_.length; i++) {
1596 var w = valueRanges[step][i];
1597 that.axes_[i].valueWindow = [w[0], w[1]];
1598 }
1599 }
1600 if (windows.length) {
1601 that.dateWindow_ = windows[step];
1602 }
1603 that.drawGraph_();
1604 }, steps, Dygraph.ANIMATION_DURATION / steps, callback);
6a1aa64f
DV
1605};
1606
1607/**
857a6931
KW
1608 * Get the current graph's area object.
1609 *
1610 * Returns: {x, y, w, h}
6a1aa64f 1611 */
857a6931
KW
1612Dygraph.prototype.getArea = function() {
1613 return this.plotter_.area;
1614};
e863a17d 1615
857a6931
KW
1616/**
1617 * Convert a mouse event to DOM coordinates relative to the graph origin.
1618 *
1619 * Returns a two-element array: [X, Y].
1620 */
1621Dygraph.prototype.eventToDomCoords = function(event) {
4cac8c7a 1622 var canvasx = Dygraph.pageX(event) - Dygraph.findPosX(this.mouseEventElement_);
857a6931
KW
1623 var canvasy = Dygraph.pageY(event) - Dygraph.findPosY(this.mouseEventElement_);
1624 return [canvasx, canvasy];
1625};
4cac8c7a 1626
857a6931
KW
1627/**
1628 * Given a canvas X coordinate, find the closest row.
1629 * @param {Number} domX graph-relative DOM X coordinate
1630 * Returns: row number, integer
1631 * @private
1632 */
1633Dygraph.prototype.findClosestRow = function(domX) {
81cb07d6 1634 var minDistX = Infinity;
a12a78ae
DV
1635 var pointIdx = -1, setIdx = -1;
1636 var sets = this.layout_.points;
1637 for (var i = 0; i < sets.length; i++) {
1638 var points = sets[i];
1639 var len = points.length;
1640 for (var j = 0; j < len; j++) {
1641 var point = points[j];
1642 if (!Dygraph.isValidPoint(point, true)) continue;
1643 var dist = Math.abs(point.canvasx - domX);
1644 if (dist < minDistX) {
1645 minDistX = dist;
1646 setIdx = i;
1647 pointIdx = j;
1648 }
a937d031 1649 }
6a1aa64f 1650 }
a12a78ae
DV
1651
1652 // TODO(danvk): remove this function; it's trivial and has only one use.
1653 return this.idxToRow_(setIdx, pointIdx);
857a6931 1654};
6a1aa64f 1655
857a6931 1656/**
2a02e5dd
KW
1657 * Given canvas X,Y coordinates, find the closest point.
1658 *
1659 * This finds the individual data point across all visible series
1660 * that's closest to the supplied DOM coordinates using the standard
1661 * Euclidean X,Y distance.
1662 *
857a6931
KW
1663 * @param {Number} domX graph-relative DOM X coordinate
1664 * @param {Number} domY graph-relative DOM Y coordinate
1665 * Returns: {row, seriesName, point}
1666 * @private
1667 */
1668Dygraph.prototype.findClosestPoint = function(domX, domY) {
81cb07d6 1669 var minDist = Infinity;
857a6931 1670 var idx = -1;
857a6931
KW
1671 var dist, dx, dy, point, closestPoint, closestSeries;
1672 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
a12a78ae
DV
1673 var points = this.layout_.points[setIdx];
1674 for (var i = 0; i < points.length; ++i) {
1675 var point = points[i];
62c3d2fd 1676 if (!Dygraph.isValidPoint(point)) continue;
857a6931
KW
1677 dx = point.canvasx - domX;
1678 dy = point.canvasy - domY;
1679 dist = dx * dx + dy * dy;
81cb07d6 1680 if (dist < minDist) {
62c3d2fd 1681 minDist = dist;
a937d031
KW
1682 closestPoint = point;
1683 closestSeries = setIdx;
1684 idx = i;
1685 }
857a6931
KW
1686 }
1687 }
1688 var name = this.layout_.setNames[closestSeries];
1689 return {
81cb07d6 1690 row: idx + this.getLeftBoundary_(),
857a6931
KW
1691 seriesName: name,
1692 point: closestPoint
1693 };
1694};
1695
1696/**
1697 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
2a02e5dd
KW
1698 *
1699 * This first finds the X data point closest to the supplied DOM X coordinate,
1700 * then finds the series which puts the Y coordinate on top of its filled area,
1701 * using linear interpolation between adjacent point pairs.
1702 *
857a6931
KW
1703 * @param {Number} domX graph-relative DOM X coordinate
1704 * @param {Number} domY graph-relative DOM Y coordinate
1705 * Returns: {row, seriesName, point}
1706 * @private
1707 */
1708Dygraph.prototype.findStackedPoint = function(domX, domY) {
1709 var row = this.findClosestRow(domX);
81cb07d6
KW
1710 var boundary = this.getLeftBoundary_();
1711 var rowIdx = row - boundary;
a12a78ae 1712 var sets = this.layout_.points;
857a6931
KW
1713 var closestPoint, closestSeries;
1714 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
a12a78ae
DV
1715 var points = this.layout_.points[setIdx];
1716 if (rowIdx >= points.length) continue;
1717 var p1 = points[rowIdx];
62c3d2fd 1718 if (!Dygraph.isValidPoint(p1)) continue;
857a6931 1719 var py = p1.canvasy;
a12a78ae 1720 if (domX > p1.canvasx && rowIdx + 1 < points.length) {
857a6931 1721 // interpolate series Y value using next point
a12a78ae 1722 var p2 = points[rowIdx + 1];
62c3d2fd
KW
1723 if (Dygraph.isValidPoint(p2)) {
1724 var dx = p2.canvasx - p1.canvasx;
1725 if (dx > 0) {
1726 var r = (domX - p1.canvasx) / dx;
1727 py += r * (p2.canvasy - p1.canvasy);
1728 }
416b05ad 1729 }
81cb07d6 1730 } else if (domX < p1.canvasx && rowIdx > 0) {
857a6931 1731 // interpolate series Y value using previous point
a12a78ae 1732 var p0 = points[rowIdx - 1];
62c3d2fd
KW
1733 if (Dygraph.isValidPoint(p0)) {
1734 var dx = p1.canvasx - p0.canvasx;
1735 if (dx > 0) {
1736 var r = (p1.canvasx - domX) / dx;
1737 py += r * (p0.canvasy - p1.canvasy);
1738 }
12e4c741 1739 }
6a1aa64f 1740 }
857a6931 1741 // Stop if the point (domX, py) is above this series' upper edge
42a9ebb8 1742 if (setIdx === 0 || py < domY) {
a937d031
KW
1743 closestPoint = p1;
1744 closestSeries = setIdx;
1745 }
6a1aa64f 1746 }
857a6931
KW
1747 var name = this.layout_.setNames[closestSeries];
1748 return {
1749 row: row,
1750 seriesName: name,
1751 point: closestPoint
1752 };
1753};
6a1aa64f 1754
857a6931 1755/**
6a1aa64f
DV
1756 * When the mouse moves in the canvas, display information about a nearby data
1757 * point and draw dots over those points in the data series. This function
1758 * takes care of cleanup of previously-drawn dots.
1759 * @param {Object} event The mousemove event from the browser.
1760 * @private
1761 */
285a6bda 1762Dygraph.prototype.mouseMove_ = function(event) {
e863a17d 1763 // This prevents JS errors when mousing over the canvas before data loads.
4cac8c7a 1764 var points = this.layout_.points;
a12a78ae 1765 if (points === undefined || points === null) return;
e863a17d 1766
857a6931
KW
1767 var canvasCoords = this.eventToDomCoords(event);
1768 var canvasx = canvasCoords[0];
1769 var canvasy = canvasCoords[1];
6a1aa64f 1770
857a6931
KW
1771 var highlightSeriesOpts = this.attr_("highlightSeriesOpts");
1772 var selectionChanged = false;
b9a3ece4 1773 if (highlightSeriesOpts && !this.lockedSet_) {
857a6931
KW
1774 var closest;
1775 if (this.attr_("stackedGraph")) {
1776 closest = this.findStackedPoint(canvasx, canvasy);
1777 } else {
1778 closest = this.findClosestPoint(canvasx, canvasy);
43af96e7 1779 }
857a6931 1780 selectionChanged = this.setSelection(closest.row, closest.seriesName);
416b05ad 1781 } else {
857a6931
KW
1782 var idx = this.findClosestRow(canvasx);
1783 selectionChanged = this.setSelection(idx);
12e4c741 1784 }
43af96e7 1785
857a6931
KW
1786 var callback = this.attr_("highlightCallback");
1787 if (callback && selectionChanged) {
1788 callback(event, this.lastx_, this.selPoints_, this.lastRow_, this.highlightSet_);
12e4c741 1789 }
239c712d 1790};
b258a3da 1791
239c712d 1792/**
81cb07d6 1793 * Fetch left offset from first defined boundaryIds record (see bug #236).
e2c21500 1794 * @private
81cb07d6
KW
1795 */
1796Dygraph.prototype.getLeftBoundary_ = function() {
1797 for (var i = 0; i < this.boundaryIds_.length; i++) {
1798 if (this.boundaryIds_[i] !== undefined) {
1799 return this.boundaryIds_[i][0];
1800 }
1801 }
1802 return 0;
1803};
1804
1805/**
1903f1e4 1806 * Transforms layout_.points index into data row number.
2ddb1197 1807 * @param int layout_.points index
1903f1e4 1808 * @return int row number, or -1 if none could be found.
2ddb1197
SC
1809 * @private
1810 */
a12a78ae
DV
1811Dygraph.prototype.idxToRow_ = function(setIdx, rowIdx) {
1812 if (rowIdx < 0) return -1;
2ddb1197 1813
81cb07d6 1814 var boundary = this.getLeftBoundary_();
a12a78ae
DV
1815 return boundary + rowIdx;
1816 // for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1817 // var set = this.layout_.datasets[setIdx];
1818 // if (idx < set.length) {
1819 // return boundary + idx;
1820 // }
1821 // idx -= set.length;
1822 // }
1823 // return -1;
1903f1e4 1824};
2ddb1197 1825
857a6931
KW
1826Dygraph.prototype.animateSelection_ = function(direction) {
1827 var totalSteps = 10;
1828 var millis = 30;
1d44ee5e
KW
1829 if (this.fadeLevel === undefined) this.fadeLevel = 0;
1830 if (this.animateId === undefined) this.animateId = 0;
857a6931
KW
1831 var start = this.fadeLevel;
1832 var steps = direction < 0 ? start : totalSteps - start;
1833 if (steps <= 0) {
1834 if (this.fadeLevel) {
1835 this.updateSelection_(1.0);
1836 }
1837 return;
1838 }
1839
1840 var thisId = ++this.animateId;
1841 var that = this;
475f7420
KW
1842 Dygraph.repeatAndCleanup(
1843 function(n) {
1844 // ignore simultaneous animations
1845 if (that.animateId != thisId) return;
1846
1847 that.fadeLevel += direction;
1848 if (that.fadeLevel === 0) {
1849 that.clearSelection();
1850 } else {
1851 that.updateSelection_(that.fadeLevel / totalSteps);
1852 }
1853 },
1854 steps, millis, function() {});
857a6931
KW
1855};
1856
2ddb1197 1857/**
239c712d
NAG
1858 * Draw dots over the selectied points in the data series. This function
1859 * takes care of cleanup of previously-drawn dots.
1860 * @private
1861 */
857a6931 1862Dygraph.prototype.updateSelection_ = function(opt_animFraction) {
e2c21500
DV
1863 var defaultPrevented = this.cascadeEvents_('select', {
1864 selectedX: this.lastx_,
1865 selectedPoints: this.selPoints_
1866 });
1867 // TODO(danvk): use defaultPrevented here?
1868
6a1aa64f 1869 // Clear the previously drawn vertical, if there is one
758a629f 1870 var i;
2cf95fff 1871 var ctx = this.canvas_ctx_;
857a6931
KW
1872 if (this.attr_('highlightSeriesOpts')) {
1873 ctx.clearRect(0, 0, this.width_, this.height_);
afdb20d8 1874 var alpha = 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
857a6931 1875 if (alpha) {
2a02e5dd
KW
1876 // Activating background fade includes an animation effect for a gradual
1877 // fade. TODO(klausw): make this independently configurable if it causes
1878 // issues? Use a shared preference to control animations?
1879 var animateBackgroundFade = true;
1880 if (animateBackgroundFade) {
857a6931
KW
1881 if (opt_animFraction === undefined) {
1882 // start a new animation
1883 this.animateSelection_(1);
1884 return;
1885 }
1886 alpha *= opt_animFraction;
1887 }
1888 ctx.fillStyle = 'rgba(255,255,255,' + alpha + ')';
1889 ctx.fillRect(0, 0, this.width_, this.height_);
1890 }
38e3d209
DV
1891
1892 // Redraw only the highlighted series in the interactive canvas (not the
1893 // static plot canvas, which is where series are usually drawn).
1894 this.plotter_._renderLineChart(this.highlightSet_, ctx);
857a6931 1895 } else if (this.previousVerticalX_ >= 0) {
46dde5f9
DV
1896 // Determine the maximum highlight circle size.
1897 var maxCircleSize = 0;
227b93cc 1898 var labels = this.attr_('labels');
758a629f 1899 for (i = 1; i < labels.length; i++) {
227b93cc 1900 var r = this.attr_('highlightCircleSize', labels[i]);
46dde5f9
DV
1901 if (r > maxCircleSize) maxCircleSize = r;
1902 }
6a1aa64f 1903 var px = this.previousVerticalX_;
46dde5f9
DV
1904 ctx.clearRect(px - maxCircleSize - 1, 0,
1905 2 * maxCircleSize + 2, this.height_);
6a1aa64f
DV
1906 }
1907
920208fb
PF
1908 if (this.isUsingExcanvas_ && this.currentZoomRectArgs_) {
1909 Dygraph.prototype.drawZoomRect_.apply(this, this.currentZoomRectArgs_);
1910 }
1911
d160cc3b 1912 if (this.selPoints_.length > 0) {
6a1aa64f 1913 // Draw colored circles over the center of each selected point
e9fe4a2f 1914 var canvasx = this.selPoints_[0].canvasx;
43af96e7 1915 ctx.save();
758a629f 1916 for (i = 0; i < this.selPoints_.length; i++) {
e9fe4a2f
DV
1917 var pt = this.selPoints_[i];
1918 if (!Dygraph.isOK(pt.canvasy)) continue;
1919
1920 var circleSize = this.attr_('highlightCircleSize', pt.name);
5879307d 1921 var callback = this.attr_("drawHighlightPointCallback", pt.name);
a8ef67a8 1922 var color = this.plotter_.colors[pt.name];
78e58af4
RK
1923 if (!callback) {
1924 callback = Dygraph.Circles.DEFAULT;
1925 }
a8ef67a8
KW
1926 ctx.lineWidth = this.attr_('strokeWidth', pt.name);
1927 ctx.strokeStyle = color;
1928 ctx.fillStyle = color;
78e58af4 1929 callback(this.g, pt.name, ctx, canvasx, pt.canvasy,
a8ef67a8 1930 color, circleSize);
6a1aa64f
DV
1931 }
1932 ctx.restore();
1933
1934 this.previousVerticalX_ = canvasx;
1935 }
1936};
1937
1938/**
629a09ae
DV
1939 * Manually set the selected points and display information about them in the
1940 * legend. The selection can be cleared using clearSelection() and queried
1941 * using getSelection().
1942 * @param { Integer } row number that should be highlighted (i.e. appear with
1943 * hover dots on the chart). Set to false to clear any selection.
857a6931
KW
1944 * @param { seriesName } optional series name to highlight that series with the
1945 * the highlightSeriesOpts setting.
b9a3ece4
KW
1946 * @param { locked } optional If true, keep seriesName selected when mousing
1947 * over the graph, disabling closest-series highlighting. Call clearSelection()
1948 * to unlock it.
239c712d 1949 */
b9a3ece4 1950Dygraph.prototype.setSelection = function(row, opt_seriesName, opt_locked) {
239c712d
NAG
1951 // Extract the points we've selected
1952 this.selPoints_ = [];
50360fd0 1953
239c712d 1954 if (row !== false) {
81cb07d6 1955 row -= this.getLeftBoundary_();
16269f6e 1956 }
50360fd0 1957
857a6931 1958 var changed = false;
16269f6e 1959 if (row !== false && row >= 0) {
857a6931
KW
1960 if (row != this.lastRow_) changed = true;
1961 this.lastRow_ = row;
82c6fe4d
KW
1962 for (var setIdx = 0; setIdx < this.layout_.datasets.length; ++setIdx) {
1963 var set = this.layout_.datasets[setIdx];
1964 if (row < set.length) {
a12a78ae 1965 var point = this.layout_.points[setIdx][row];
ccd9d7c2 1966
38f33a44 1967 if (this.attr_("stackedGraph")) {
a12a78ae 1968 point = this.layout_.unstackPointAtIndex(setIdx, row);
38f33a44 1969 }
ccd9d7c2 1970
42a9ebb8 1971 if (point.yval !== null) this.selPoints_.push(point);
16269f6e 1972 }
239c712d 1973 }
857a6931
KW
1974 } else {
1975 if (this.lastRow_ >= 0) changed = true;
1976 this.lastRow_ = -1;
16269f6e 1977 }
50360fd0 1978
16269f6e 1979 if (this.selPoints_.length) {
239c712d 1980 this.lastx_ = this.selPoints_[0].xval;
239c712d 1981 } else {
857a6931 1982 this.lastx_ = -1;
239c712d
NAG
1983 }
1984
857a6931
KW
1985 if (opt_seriesName !== undefined) {
1986 if (this.highlightSet_ !== opt_seriesName) changed = true;
1987 this.highlightSet_ = opt_seriesName;
239c712d
NAG
1988 }
1989
b9a3ece4
KW
1990 if (opt_locked !== undefined) {
1991 this.lockedSet_ = opt_locked;
1992 }
1993
857a6931
KW
1994 if (changed) {
1995 this.updateSelection_(undefined);
1996 }
1997 return changed;
239c712d
NAG
1998};
1999
2000/**
6a1aa64f
DV
2001 * The mouse has left the canvas. Clear out whatever artifacts remain
2002 * @param {Object} event the mouseout event from the browser.
2003 * @private
2004 */
285a6bda 2005Dygraph.prototype.mouseOut_ = function(event) {
a4c6a67c
AV
2006 if (this.attr_("unhighlightCallback")) {
2007 this.attr_("unhighlightCallback")(event);
2008 }
2009
b9a3ece4 2010 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_) {
239c712d 2011 this.clearSelection();
43af96e7 2012 }
6a1aa64f
DV
2013};
2014
239c712d 2015/**
629a09ae
DV
2016 * Clears the current selection (i.e. points that were highlighted by moving
2017 * the mouse over the chart).
239c712d
NAG
2018 */
2019Dygraph.prototype.clearSelection = function() {
e2c21500
DV
2020 this.cascadeEvents_('deselect', {});
2021
b9a3ece4 2022 this.lockedSet_ = false;
239c712d 2023 // Get rid of the overlay data
857a6931
KW
2024 if (this.fadeLevel) {
2025 this.animateSelection_(-1);
2026 return;
2027 }
2cf95fff 2028 this.canvas_ctx_.clearRect(0, 0, this.width_, this.height_);
857a6931 2029 this.fadeLevel = 0;
239c712d
NAG
2030 this.selPoints_ = [];
2031 this.lastx_ = -1;
857a6931
KW
2032 this.lastRow_ = -1;
2033 this.highlightSet_ = null;
758a629f 2034};
239c712d 2035
103b7292 2036/**
629a09ae
DV
2037 * Returns the number of the currently selected row. To get data for this row,
2038 * you can use the getValue method.
2039 * @return { Integer } row number, or -1 if nothing is selected
103b7292
NAG
2040 */
2041Dygraph.prototype.getSelection = function() {
2042 if (!this.selPoints_ || this.selPoints_.length < 1) {
2043 return -1;
2044 }
50360fd0 2045
a12a78ae
DV
2046 for (var setIdx = 0; setIdx < this.layout_.points.length; setIdx++) {
2047 var points = this.layout_.points[setIdx];
2048 for (var row = 0; row < points.length; row++) {
2049 if (points[row].x == this.selPoints_[0].x) {
2050 return row + this.getLeftBoundary_();
2051 }
103b7292
NAG
2052 }
2053 }
2054 return -1;
2e1fcf1a 2055};
103b7292 2056
e2c21500
DV
2057/**
2058 * Returns the name of the currently-highlighted series.
2059 * Only available when the highlightSeriesOpts option is in use.
2060 */
857a6931
KW
2061Dygraph.prototype.getHighlightSeries = function() {
2062 return this.highlightSet_;
2063};
2064
19589a3e 2065/**
6a1aa64f
DV
2066 * Fires when there's data available to be graphed.
2067 * @param {String} data Raw CSV data to be plotted
2068 * @private
2069 */
285a6bda 2070Dygraph.prototype.loadedEvent_ = function(data) {
6a1aa64f 2071 this.rawData_ = this.parseCSV_(data);
26ca7938 2072 this.predraw_();
6a1aa64f
DV
2073};
2074
6a1aa64f
DV
2075/**
2076 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2077 * @private
2078 */
285a6bda 2079Dygraph.prototype.addXTicks_ = function() {
6a1aa64f 2080 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
7201b11e 2081 var range;
6a1aa64f 2082 if (this.dateWindow_) {
7201b11e 2083 range = [this.dateWindow_[0], this.dateWindow_[1]];
6a1aa64f 2084 } else {
395e98a3 2085 range = this.fullXRange_();
7201b11e
JB
2086 }
2087
48e614ac
DV
2088 var xAxisOptionsView = this.optionsViewForAxis_('x');
2089 var xTicks = xAxisOptionsView('ticker')(
2090 range[0],
2091 range[1],
2092 this.width_, // TODO(danvk): should be area.width
2093 xAxisOptionsView,
2094 this);
2095 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2096 // console.log(msg);
b2c9222a 2097 this.layout_.setXTicks(xTicks);
32988383
DV
2098};
2099
629a09ae
DV
2100/**
2101 * @private
2102 * Computes the range of the data series (including confidence intervals).
2103 * @param { [Array] } series either [ [x1, y1], [x2, y2], ... ] or
2104 * [ [x1, [y1, dev_low, dev_high]], [x2, [y2, dev_low, dev_high]], ...
2105 * @return [low, high]
2106 */
5011e7a1 2107Dygraph.prototype.extremeValues_ = function(series) {
758a629f 2108 var minY = null, maxY = null, j, y;
5011e7a1 2109
9922b78b 2110 var bars = this.attr_("errorBars") || this.attr_("customBars");
5011e7a1
DV
2111 if (bars) {
2112 // With custom bars, maxY is the max of the high values.
758a629f
DV
2113 for (j = 0; j < series.length; j++) {
2114 y = series[j][1][0];
44477387 2115 if (y === null || isNaN(y)) continue;
5011e7a1
DV
2116 var low = y - series[j][1][1];
2117 var high = y + series[j][1][2];
2118 if (low > y) low = y; // this can happen with custom bars,
2119 if (high < y) high = y; // e.g. in tests/custom-bars.html
758a629f 2120 if (maxY === null || high > maxY) {
5011e7a1
DV
2121 maxY = high;
2122 }
758a629f 2123 if (minY === null || low < minY) {
5011e7a1
DV
2124 minY = low;
2125 }
2126 }
2127 } else {
758a629f
DV
2128 for (j = 0; j < series.length; j++) {
2129 y = series[j][1];
d12999d3 2130 if (y === null || isNaN(y)) continue;
758a629f 2131 if (maxY === null || y > maxY) {
5011e7a1
DV
2132 maxY = y;
2133 }
758a629f 2134 if (minY === null || y < minY) {
5011e7a1
DV
2135 minY = y;
2136 }
2137 }
2138 }
2139
2140 return [minY, maxY];
2141};
2142
6a1aa64f 2143/**
629a09ae 2144 * @private
26ca7938
DV
2145 * This function is called once when the chart's data is changed or the options
2146 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2147 * idea is that values derived from the chart's data can be computed here,
2148 * rather than every time the chart is drawn. This includes things like the
2149 * number of axes, rolling averages, etc.
2150 */
2151Dygraph.prototype.predraw_ = function() {
7153e001
DV
2152 var start = new Date();
2153
26ca7938
DV
2154 // TODO(danvk): move more computations out of drawGraph_ and into here.
2155 this.computeYAxes_();
2156
2157 // Create a new plotter.
f417e3d3 2158 if (this.plotter_) {
1748a51c 2159 this.cascadeEvents_('clearChart');
f417e3d3
DV
2160 this.plotter_.clear();
2161 }
26ca7938 2162 this.plotter_ = new DygraphCanvasRenderer(this,
2cf95fff
RK
2163 this.hidden_,
2164 this.hidden_ctx_,
0e23cfc6 2165 this.layout_);
26ca7938 2166
0abfbd7e
DV
2167 // The roller sits in the bottom left corner of the chart. We don't know where
2168 // this will be until the options are available, so it's positioned here.
8c69de65 2169 this.createRollInterface_();
26ca7938 2170
e2c21500 2171 this.cascadeEvents_('predraw');
0abfbd7e 2172
ccd9d7c2
PF
2173 if (this.rangeSelector_) {
2174 this.rangeSelector_.renderStaticLayer();
2175 }
2176
b1a3b195
DV
2177 // Convert the raw data (a 2D array) into the internal format and compute
2178 // rolling averages.
2179 this.rolledSeries_ = [null]; // x-axis is the first series and it's special
395e98a3 2180 for (var i = 1; i < this.numColumns(); i++) {
04c104d7
KW
2181 var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong
2182 var series = this.extractSeries_(this.rawData_, i, logScale);
b1a3b195
DV
2183 series = this.rollingAverage(series, this.rollPeriod_);
2184 this.rolledSeries_.push(series);
2185 }
2186
26ca7938
DV
2187 // If the data or options have changed, then we'd better redraw.
2188 this.drawGraph_();
4b4d1a63
DV
2189
2190 // This is used to determine whether to do various animations.
2191 var end = new Date();
2192 this.drawingTimeMs_ = (end - start);
26ca7938
DV
2193};
2194
2195/**
b1a3b195
DV
2196 * Loop over all fields and create datasets, calculating extreme y-values for
2197 * each series and extreme x-indices as we go.
fc4e84fa 2198 *
b1a3b195
DV
2199 * dateWindow is passed in as an explicit parameter so that we can compute
2200 * extreme values "speculatively", i.e. without actually setting state on the
2201 * dygraph.
fc4e84fa 2202 *
b1a3b195
DV
2203 * TODO(danvk): make this more of a true function
2204 * @return [ datasets, seriesExtremes, boundaryIds ]
6a1aa64f
DV
2205 * @private
2206 */
b1a3b195
DV
2207Dygraph.prototype.gatherDatasets_ = function(rolledSeries, dateWindow) {
2208 var boundaryIds = [];
354e15ab
DE
2209 var cumulative_y = []; // For stacked series.
2210 var datasets = [];
f09fc545 2211 var extremes = {}; // series name -> [low, high]
758a629f 2212 var i, j, k;
f09fc545 2213
b1a3b195
DV
2214 // Loop over the fields (series). Go from the last to the first,
2215 // because if they're stacked that's how we accumulate the values.
2216 var num_series = rolledSeries.length - 1;
758a629f 2217 for (i = num_series; i >= 1; i--) {
1cf11047
DV
2218 if (!this.visibility()[i - 1]) continue;
2219
16879a6b
DV
2220 // Note: this copy _is_ necessary at the moment.
2221 // If you remove it, it breaks zooming with error bars on.
2222 // TODO(danvk): investigate further & write a test for this.
2223 var series = [];
2224 for (j = 0; j < rolledSeries[i].length; j++) {
2225 series.push(rolledSeries[i][j]);
2226 }
2f5e7e1a 2227
6a1aa64f 2228 // Prune down to the desired range, if necessary (for zooming)
1a26f3fb
DV
2229 // Because there can be lines going to points outside of the visible area,
2230 // we actually prune to visible points, plus one on either side.
9922b78b 2231 var bars = this.attr_("errorBars") || this.attr_("customBars");
b1a3b195
DV
2232 if (dateWindow) {
2233 var low = dateWindow[0];
2234 var high = dateWindow[1];
6a1aa64f 2235 var pruned = [];
1a26f3fb
DV
2236 // TODO(danvk): do binary search instead of linear search.
2237 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2238 var firstIdx = null, lastIdx = null;
758a629f 2239 for (k = 0; k < series.length; k++) {
1a26f3fb
DV
2240 if (series[k][0] >= low && firstIdx === null) {
2241 firstIdx = k;
2242 }
2243 if (series[k][0] <= high) {
2244 lastIdx = k;
6a1aa64f
DV
2245 }
2246 }
1a26f3fb
DV
2247 if (firstIdx === null) firstIdx = 0;
2248 if (firstIdx > 0) firstIdx--;
2249 if (lastIdx === null) lastIdx = series.length - 1;
2250 if (lastIdx < series.length - 1) lastIdx++;
b1a3b195 2251 boundaryIds[i-1] = [firstIdx, lastIdx];
758a629f 2252 for (k = firstIdx; k <= lastIdx; k++) {
1a26f3fb 2253 pruned.push(series[k]);
6a1aa64f
DV
2254 }
2255 series = pruned;
16269f6e 2256 } else {
b1a3b195 2257 boundaryIds[i-1] = [0, series.length-1];
6a1aa64f
DV
2258 }
2259
f09fc545 2260 var seriesExtremes = this.extremeValues_(series);
5011e7a1 2261
6a1aa64f 2262 if (bars) {
758a629f 2263 for (j=0; j<series.length; j++) {
5061b42f
DV
2264 series[j] = [series[j][0],
2265 series[j][1][0],
2266 series[j][1][1],
2267 series[j][1][2]];
354e15ab 2268 }
43af96e7 2269 } else if (this.attr_("stackedGraph")) {
43af96e7
NK
2270 var l = series.length;
2271 var actual_y;
758a629f 2272 for (j = 0; j < l; j++) {
354e15ab
DE
2273 // If one data set has a NaN, let all subsequent stacked
2274 // sets inherit the NaN -- only start at 0 for the first set.
2275 var x = series[j][0];
41b0f691 2276 if (cumulative_y[x] === undefined) {
354e15ab 2277 cumulative_y[x] = 0;
41b0f691 2278 }
43af96e7
NK
2279
2280 actual_y = series[j][1];
04c104d7
KW
2281 if (actual_y === null) {
2282 series[j] = [x, null];
2283 continue;
2284 }
2285
354e15ab 2286 cumulative_y[x] += actual_y;
43af96e7 2287
758a629f 2288 series[j] = [x, cumulative_y[x]];
43af96e7 2289
41b0f691
DV
2290 if (cumulative_y[x] > seriesExtremes[1]) {
2291 seriesExtremes[1] = cumulative_y[x];
2292 }
2293 if (cumulative_y[x] < seriesExtremes[0]) {
2294 seriesExtremes[0] = cumulative_y[x];
2295 }
43af96e7 2296 }
6a1aa64f 2297 }
354e15ab 2298
b1a3b195
DV
2299 var seriesName = this.attr_("labels")[i];
2300 extremes[seriesName] = seriesExtremes;
354e15ab 2301 datasets[i] = series;
6a1aa64f
DV
2302 }
2303
7d463f49
KW
2304 // For stacked graphs, a NaN value for any point in the sum should create a
2305 // clean gap in the graph. Back-propagate NaNs to all points at this X value.
2306 if (this.attr_("stackedGraph")) {
2307 for (k = datasets.length - 1; k >= 0; --k) {
2308 // Use the first nonempty dataset to get X values.
2309 if (!datasets[k]) continue;
2310 for (j = 0; j < datasets[k].length; j++) {
2311 var x = datasets[k][j][0];
2312 if (isNaN(cumulative_y[x])) {
2313 // Set all Y values to NaN at that X value.
2314 for (i = datasets.length - 1; i >= 0; i--) {
2315 if (!datasets[i]) continue;
2316 datasets[i][j][1] = NaN;
2317 }
2318 }
2319 }
2320 break;
2321 }
2322 }
2323
b1a3b195
DV
2324 return [ datasets, extremes, boundaryIds ];
2325};
2326
2327/**
2328 * Update the graph with new data. This method is called when the viewing area
2329 * has changed. If the underlying data or options have changed, predraw_ will
2330 * be called before drawGraph_ is called.
2331 *
b1a3b195
DV
2332 * @private
2333 */
e2c21500 2334Dygraph.prototype.drawGraph_ = function() {
b1a3b195
DV
2335 var start = new Date();
2336
b1a3b195
DV
2337 // This is used to set the second parameter to drawCallback, below.
2338 var is_initial_draw = this.is_initial_draw_;
2339 this.is_initial_draw_ = false;
2340
b1a3b195
DV
2341 this.layout_.removeAllDatasets();
2342 this.setColors_();
758a629f 2343 this.attrs_.pointSize = 0.5 * this.attr_('highlightCircleSize');
b1a3b195
DV
2344
2345 var packed = this.gatherDatasets_(this.rolledSeries_, this.dateWindow_);
2346 var datasets = packed[0];
2347 var extremes = packed[1];
2348 this.boundaryIds_ = packed[2];
2349
82c6fe4d
KW
2350 this.setIndexByName_ = {};
2351 var labels = this.attr_("labels");
2352 if (labels.length > 0) {
2353 this.setIndexByName_[labels[0]] = 0;
2354 }
857a6931 2355 var dataIdx = 0;
354e15ab 2356 for (var i = 1; i < datasets.length; i++) {
82c6fe4d 2357 this.setIndexByName_[labels[i]] = i;
4523c1f6 2358 if (!this.visibility()[i - 1]) continue;
82c6fe4d 2359 this.layout_.addDataset(labels[i], datasets[i]);
857a6931 2360 this.datasetIndex_[i] = dataIdx++;
43af96e7
NK
2361 }
2362
6faebb69 2363 this.computeYAxisRanges_(extremes);
b2c9222a
DV
2364 this.layout_.setYAxes(this.axes_);
2365
6a1aa64f
DV
2366 this.addXTicks_();
2367
b2c9222a 2368 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
81856f70 2369 var tmp_zoomed_x = this.zoomed_x_;
6a1aa64f 2370 // Tell PlotKit to use this new data and render itself
b2c9222a 2371 this.layout_.setDateWindow(this.dateWindow_);
81856f70 2372 this.zoomed_x_ = tmp_zoomed_x;
6a1aa64f 2373 this.layout_.evaluateWithError();
e2c21500 2374 this.renderGraph_(is_initial_draw);
9ca829f2
DV
2375
2376 if (this.attr_("timingName")) {
2377 var end = new Date();
2378 if (console) {
758a629f 2379 console.log(this.attr_("timingName") + " - drawGraph: " + (end - start) + "ms");
9ca829f2
DV
2380 }
2381 }
2382};
2383
e2c21500
DV
2384/**
2385 * This does the work of drawing the chart. It assumes that the layout and axis
2386 * scales have already been set (e.g. by predraw_).
2387 *
2388 * @private
2389 */
2390Dygraph.prototype.renderGraph_ = function(is_initial_draw) {
1748a51c 2391 this.cascadeEvents_('clearChart');
6a1aa64f 2392 this.plotter_.clear();
f417e3d3 2393
98eb4713
DV
2394 if (this.attr_('underlayCallback')) {
2395 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2396 // users who expect a deprecated form of this callback.
2397 this.attr_('underlayCallback')(
2398 this.hidden_ctx_, this.layout_.getPlotArea(), this, this);
2399 }
2400
2401 var e = {
189f8030 2402 canvas: this.hidden_,
2de7166c 2403 drawingContext: this.hidden_ctx_
98eb4713
DV
2404 };
2405 this.cascadeEvents_('willDrawChart', e);
6a1aa64f 2406 this.plotter_.render();
98eb4713 2407 this.cascadeEvents_('didDrawChart', e);
8cfe592f
DV
2408
2409 // TODO(danvk): is this a performance bottleneck when panning?
2410 // The interaction canvas should already be empty in that situation.
f6401bf6 2411 this.canvas_.getContext('2d').clearRect(0, 0, this.canvas_.width,
2f5e7e1a 2412 this.canvas_.height);
599fb4ad 2413
4a0cb9c4 2414 // Generate a static legend before any particular point is selected.
2fccd3dc 2415
ccd9d7c2
PF
2416 if (this.rangeSelector_) {
2417 this.rangeSelector_.renderInteractiveLayer();
2418 }
599fb4ad 2419 if (this.attr_("drawCallback") !== null) {
fe0b7c03 2420 this.attr_("drawCallback")(this, is_initial_draw);
599fb4ad 2421 }
6a1aa64f
DV
2422};
2423
2424/**
629a09ae 2425 * @private
26ca7938
DV
2426 * Determine properties of the y-axes which are independent of the data
2427 * currently being displayed. This includes things like the number of axes and
2428 * the style of the axes. It does not include the range of each axis and its
2429 * tick marks.
2430 * This fills in this.axes_ and this.seriesToAxisMap_.
2431 * axes_ = [ { options } ]
2432 * seriesToAxisMap_ = { seriesName: 0, seriesName2: 1, ... }
2433 * indices are into the axes_ array.
f09fc545 2434 */
26ca7938 2435Dygraph.prototype.computeYAxes_ = function() {
d64b8fea
RK
2436 // Preserve valueWindow settings if they exist, and if the user hasn't
2437 // specified a new valueRange.
4dd0ac55 2438 var i, valueWindows, seriesName, axis, index, opts, v;
758a629f 2439 if (this.axes_ !== undefined && this.user_attrs_.hasOwnProperty("valueRange") === false) {
d64b8fea 2440 valueWindows = [];
758a629f 2441 for (index = 0; index < this.axes_.length; index++) {
d64b8fea
RK
2442 valueWindows.push(this.axes_[index].valueWindow);
2443 }
2444 }
2445
00aa7f61 2446 this.axes_ = [{ yAxisId : 0, g : this }]; // always have at least one y-axis.
26ca7938
DV
2447 this.seriesToAxisMap_ = {};
2448
2449 // Get a list of series names.
2450 var labels = this.attr_("labels");
1c77a3a1 2451 var series = {};
758a629f 2452 for (i = 1; i < labels.length; i++) series[labels[i]] = (i - 1);
f09fc545
DV
2453
2454 // all options which could be applied per-axis:
2455 var axisOptions = [
2456 'includeZero',
2457 'valueRange',
2458 'labelsKMB',
2459 'labelsKMG2',
2460 'pixelsPerYLabel',
2461 'yAxisLabelWidth',
2462 'axisLabelFontSize',
7d0e7a0d
RK
2463 'axisTickSize',
2464 'logscale'
f09fc545
DV
2465 ];
2466
2467 // Copy global axis options over to the first axis.
758a629f 2468 for (i = 0; i < axisOptions.length; i++) {
f09fc545 2469 var k = axisOptions[i];
4dd0ac55 2470 v = this.attr_(k);
26ca7938 2471 if (v) this.axes_[0][k] = v;
f09fc545
DV
2472 }
2473
2474 // Go through once and add all the axes.
758a629f 2475 for (seriesName in series) {
26ca7938 2476 if (!series.hasOwnProperty(seriesName)) continue;
758a629f
DV
2477 axis = this.attr_("axis", seriesName);
2478 if (axis === null) {
26ca7938 2479 this.seriesToAxisMap_[seriesName] = 0;
f09fc545
DV
2480 continue;
2481 }
2482 if (typeof(axis) == 'object') {
2483 // Add a new axis, making a copy of its per-axis options.
4dd0ac55 2484 opts = {};
26ca7938 2485 Dygraph.update(opts, this.axes_[0]);
f09fc545 2486 Dygraph.update(opts, { valueRange: null }); // shouldn't inherit this.
00aa7f61
RK
2487 var yAxisId = this.axes_.length;
2488 opts.yAxisId = yAxisId;
2489 opts.g = this;
f09fc545 2490 Dygraph.update(opts, axis);
26ca7938 2491 this.axes_.push(opts);
00aa7f61 2492 this.seriesToAxisMap_[seriesName] = yAxisId;
f09fc545
DV
2493 }
2494 }
2495
2496 // Go through one more time and assign series to an axis defined by another
2497 // series, e.g. { 'Y1: { axis: {} }, 'Y2': { axis: 'Y1' } }
758a629f 2498 for (seriesName in series) {
26ca7938 2499 if (!series.hasOwnProperty(seriesName)) continue;
758a629f 2500 axis = this.attr_("axis", seriesName);
f09fc545 2501 if (typeof(axis) == 'string') {
26ca7938 2502 if (!this.seriesToAxisMap_.hasOwnProperty(axis)) {
f09fc545
DV
2503 this.error("Series " + seriesName + " wants to share a y-axis with " +
2504 "series " + axis + ", which does not define its own axis.");
2505 return null;
2506 }
26ca7938
DV
2507 var idx = this.seriesToAxisMap_[axis];
2508 this.seriesToAxisMap_[seriesName] = idx;
f09fc545
DV
2509 }
2510 }
1c77a3a1 2511
758a629f 2512 if (valueWindows !== undefined) {
d64b8fea 2513 // Restore valueWindow settings.
758a629f 2514 for (index = 0; index < valueWindows.length; index++) {
d64b8fea
RK
2515 this.axes_[index].valueWindow = valueWindows[index];
2516 }
2517 }
4dd0ac55
RV
2518
2519 // New axes options
2520 for (axis = 0; axis < this.axes_.length; axis++) {
2521 if (axis === 0) {
2522 opts = this.optionsViewForAxis_('y' + (axis ? '2' : ''));
2523 v = opts("valueRange");
2524 if (v) this.axes_[axis].valueRange = v;
2525 } else { // To keep old behavior
2526 var axes = this.user_attrs_.axes;
2527 if (axes && axes.y2) {
2528 v = axes.y2.valueRange;
2529 if (v) this.axes_[axis].valueRange = v;
2530 }
2531 }
2532 }
2533
26ca7938
DV
2534};
2535
2536/**
2537 * Returns the number of y-axes on the chart.
2538 * @return {Number} the number of axes.
2539 */
2540Dygraph.prototype.numAxes = function() {
2541 var last_axis = 0;
2542 for (var series in this.seriesToAxisMap_) {
2543 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2544 var idx = this.seriesToAxisMap_[series];
2545 if (idx > last_axis) last_axis = idx;
2546 }
2547 return 1 + last_axis;
2548};
2549
2550/**
629a09ae 2551 * @private
b2c9222a
DV
2552 * Returns axis properties for the given series.
2553 * @param { String } setName The name of the series for which to get axis
2554 * properties, e.g. 'Y1'.
2555 * @return { Object } The axis properties.
2556 */
2557Dygraph.prototype.axisPropertiesForSeries = function(series) {
2558 // TODO(danvk): handle errors.
2559 return this.axes_[this.seriesToAxisMap_[series]];
2560};
2561
2562/**
2563 * @private
26ca7938
DV
2564 * Determine the value range and tick marks for each axis.
2565 * @param {Object} extremes A mapping from seriesName -> [low, high]
2566 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2567 */
2568Dygraph.prototype.computeYAxisRanges_ = function(extremes) {
2569 // Build a map from axis number -> [list of series names]
758a629f
DV
2570 var seriesForAxis = [], series;
2571 for (series in this.seriesToAxisMap_) {
26ca7938
DV
2572 if (!this.seriesToAxisMap_.hasOwnProperty(series)) continue;
2573 var idx = this.seriesToAxisMap_[series];
2574 while (seriesForAxis.length <= idx) seriesForAxis.push([]);
2575 seriesForAxis[idx].push(series);
2576 }
f09fc545
DV
2577
2578 // Compute extreme values, a span and tick marks for each axis.
26ca7938
DV
2579 for (var i = 0; i < this.axes_.length; i++) {
2580 var axis = this.axes_[i];
25f76ae3 2581
06fc69b6
AV
2582 if (!seriesForAxis[i]) {
2583 // If no series are defined or visible then use a reasonable default
2584 axis.extremeRange = [0, 1];
2585 } else {
1c77a3a1 2586 // Calculate the extremes of extremes.
758a629f 2587 series = seriesForAxis[i];
f09fc545
DV
2588 var minY = Infinity; // extremes[series[0]][0];
2589 var maxY = -Infinity; // extremes[series[0]][1];
ba049b89 2590 var extremeMinY, extremeMaxY;
a2da3777 2591
f09fc545 2592 for (var j = 0; j < series.length; j++) {
a2da3777
DV
2593 // this skips invisible series
2594 if (!extremes.hasOwnProperty(series[j])) continue;
2595
ba049b89
NN
2596 // Only use valid extremes to stop null data series' from corrupting the scale.
2597 extremeMinY = extremes[series[j]][0];
758a629f 2598 if (extremeMinY !== null) {
36dfa958 2599 minY = Math.min(extremeMinY, minY);
ba049b89
NN
2600 }
2601 extremeMaxY = extremes[series[j]][1];
758a629f 2602 if (extremeMaxY !== null) {
36dfa958 2603 maxY = Math.max(extremeMaxY, maxY);
ba049b89 2604 }
f09fc545
DV
2605 }
2606 if (axis.includeZero && minY > 0) minY = 0;
2607
a2da3777 2608 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
36dfa958 2609 if (minY == Infinity) minY = 0;
a2da3777 2610 if (maxY == -Infinity) maxY = 1;
ba049b89 2611
f09fc545
DV
2612 // Add some padding and round up to an integer to be human-friendly.
2613 var span = maxY - minY;
2614 // special case: if we have no sense of scale, use +/-10% of the sole value.
758a629f 2615 if (span === 0) { span = maxY; }
f09fc545 2616
758a629f 2617 var maxAxisY, minAxisY;
7d0e7a0d 2618 if (axis.logscale) {
758a629f
DV
2619 maxAxisY = maxY + 0.1 * span;
2620 minAxisY = minY;
ff022deb 2621 } else {
758a629f
DV
2622 maxAxisY = maxY + 0.1 * span;
2623 minAxisY = minY - 0.1 * span;
f09fc545 2624
ff022deb
RK
2625 // Try to include zero and make it minAxisY (or maxAxisY) if it makes sense.
2626 if (!this.attr_("avoidMinZero")) {
2627 if (minAxisY < 0 && minY >= 0) minAxisY = 0;
2628 if (maxAxisY > 0 && maxY <= 0) maxAxisY = 0;
2629 }
f09fc545 2630
ff022deb
RK
2631 if (this.attr_("includeZero")) {
2632 if (maxY < 0) maxAxisY = 0;
2633 if (minY > 0) minAxisY = 0;
2634 }
f09fc545 2635 }
4cac8c7a
RK
2636 axis.extremeRange = [minAxisY, maxAxisY];
2637 }
2638 if (axis.valueWindow) {
2639 // This is only set if the user has zoomed on the y-axis. It is never set
2640 // by a user. It takes precedence over axis.valueRange because, if you set
2641 // valueRange, you'd still expect to be able to pan.
2642 axis.computedValueRange = [axis.valueWindow[0], axis.valueWindow[1]];
2643 } else if (axis.valueRange) {
2644 // This is a user-set value range for this axis.
2645 axis.computedValueRange = [axis.valueRange[0], axis.valueRange[1]];
2646 } else {
2647 axis.computedValueRange = axis.extremeRange;
f09fc545
DV
2648 }
2649
0d64e596
DV
2650 // Add ticks. By default, all axes inherit the tick positions of the
2651 // primary axis. However, if an axis is specifically marked as having
2652 // independent ticks, then that is permissible as well.
48e614ac
DV
2653 var opts = this.optionsViewForAxis_('y' + (i ? '2' : ''));
2654 var ticker = opts('ticker');
758a629f 2655 if (i === 0 || axis.independentTicks) {
48e614ac
DV
2656 axis.ticks = ticker(axis.computedValueRange[0],
2657 axis.computedValueRange[1],
2658 this.height_, // TODO(danvk): should be area.height
2659 opts,
2660 this);
0d64e596
DV
2661 } else {
2662 var p_axis = this.axes_[0];
2663 var p_ticks = p_axis.ticks;
2664 var p_scale = p_axis.computedValueRange[1] - p_axis.computedValueRange[0];
2665 var scale = axis.computedValueRange[1] - axis.computedValueRange[0];
2666 var tick_values = [];
25f76ae3
DV
2667 for (var k = 0; k < p_ticks.length; k++) {
2668 var y_frac = (p_ticks[k].v - p_axis.computedValueRange[0]) / p_scale;
0d64e596
DV
2669 var y_val = axis.computedValueRange[0] + y_frac * scale;
2670 tick_values.push(y_val);
2671 }
2672
48e614ac
DV
2673 axis.ticks = ticker(axis.computedValueRange[0],
2674 axis.computedValueRange[1],
2675 this.height_, // TODO(danvk): should be area.height
2676 opts,
2677 this,
2678 tick_values);
0d64e596 2679 }
f09fc545 2680 }
f09fc545 2681};
25f76ae3 2682
f09fc545 2683/**
b1a3b195
DV
2684 * Extracts one series from the raw data (a 2D array) into an array of (date,
2685 * value) tuples.
2686 *
2687 * This is where undesirable points (i.e. negative values on log scales and
2688 * missing values through which we wish to connect lines) are dropped.
0604287e 2689 * TODO(danvk): the "missing values" bit above doesn't seem right.
de8f284f 2690 *
b1a3b195
DV
2691 * @private
2692 */
04c104d7 2693Dygraph.prototype.extractSeries_ = function(rawData, i, logScale) {
0604287e 2694 // TODO(danvk): pre-allocate series here.
b1a3b195
DV
2695 var series = [];
2696 for (var j = 0; j < rawData.length; j++) {
2697 var x = rawData[j][0];
2698 var point = rawData[j][i];
2699 if (logScale) {
2700 // On the log scale, points less than zero do not exist.
04c104d7 2701 // This will create a gap in the chart.
b1a3b195
DV
2702 if (point <= 0) {
2703 point = null;
2704 }
b1a3b195 2705 }
04c104d7 2706 series.push([x, point]);
b1a3b195
DV
2707 }
2708 return series;
2709};
2710
2711/**
629a09ae 2712 * @private
6a1aa64f
DV
2713 * Calculates the rolling average of a data set.
2714 * If originalData is [label, val], rolls the average of those.
2715 * If originalData is [label, [, it's interpreted as [value, stddev]
2716 * and the roll is returned in the same form, with appropriately reduced
2717 * stddev for each value.
2718 * Note that this is where fractional input (i.e. '5/10') is converted into
2719 * decimal values.
2720 * @param {Array} originalData The data in the appropriate format (see above)
6faebb69
JB
2721 * @param {Number} rollPeriod The number of points over which to average the
2722 * data
6a1aa64f 2723 */
285a6bda 2724Dygraph.prototype.rollingAverage = function(originalData, rollPeriod) {
6a1aa64f
DV
2725 if (originalData.length < 2)
2726 return originalData;
758a629f 2727 rollPeriod = Math.min(rollPeriod, originalData.length);
6a1aa64f 2728 var rollingData = [];
285a6bda 2729 var sigma = this.attr_("sigma");
6a1aa64f 2730
758a629f 2731 var low, high, i, j, y, sum, num_ok, stddev;
6a1aa64f
DV
2732 if (this.fractions_) {
2733 var num = 0;
2734 var den = 0; // numerator/denominator
2735 var mult = 100.0;
758a629f 2736 for (i = 0; i < originalData.length; i++) {
6a1aa64f
DV
2737 num += originalData[i][1][0];
2738 den += originalData[i][1][1];
2739 if (i - rollPeriod >= 0) {
2740 num -= originalData[i - rollPeriod][1][0];
2741 den -= originalData[i - rollPeriod][1][1];
2742 }
2743
2744 var date = originalData[i][0];
2745 var value = den ? num / den : 0.0;
285a6bda 2746 if (this.attr_("errorBars")) {
395e98a3 2747 if (this.attr_("wilsonInterval")) {
6a1aa64f
DV
2748 // For more details on this confidence interval, see:
2749 // http://en.wikipedia.org/wiki/Binomial_confidence_interval
2750 if (den) {
2751 var p = value < 0 ? 0 : value, n = den;
2752 var pm = sigma * Math.sqrt(p*(1-p)/n + sigma*sigma/(4*n*n));
2753 var denom = 1 + sigma * sigma / den;
758a629f
DV
2754 low = (p + sigma * sigma / (2 * den) - pm) / denom;
2755 high = (p + sigma * sigma / (2 * den) + pm) / denom;
6a1aa64f
DV
2756 rollingData[i] = [date,
2757 [p * mult, (p - low) * mult, (high - p) * mult]];
2758 } else {
2759 rollingData[i] = [date, [0, 0, 0]];
2760 }
2761 } else {
758a629f 2762 stddev = den ? sigma * Math.sqrt(value * (1 - value) / den) : 1.0;
6a1aa64f
DV
2763 rollingData[i] = [date, [mult * value, mult * stddev, mult * stddev]];
2764 }
2765 } else {
2766 rollingData[i] = [date, mult * value];
2767 }
2768 }
9922b78b 2769 } else if (this.attr_("customBars")) {
758a629f 2770 low = 0;
f6885d6a 2771 var mid = 0;
758a629f 2772 high = 0;
f6885d6a 2773 var count = 0;
758a629f 2774 for (i = 0; i < originalData.length; i++) {
6a1aa64f 2775 var data = originalData[i][1];
758a629f 2776 y = data[1];
6a1aa64f 2777 rollingData[i] = [originalData[i][0], [y, y - data[0], data[2] - y]];
f6885d6a 2778
758a629f 2779 if (y !== null && !isNaN(y)) {
49a7d0d5
DV
2780 low += data[0];
2781 mid += y;
2782 high += data[2];
2783 count += 1;
2784 }
f6885d6a
DV
2785 if (i - rollPeriod >= 0) {
2786 var prev = originalData[i - rollPeriod];
758a629f 2787 if (prev[1][1] !== null && !isNaN(prev[1][1])) {
49a7d0d5
DV
2788 low -= prev[1][0];
2789 mid -= prev[1][1];
2790 high -= prev[1][2];
2791 count -= 1;
2792 }
f6885d6a 2793 }
502d5996
DV
2794 if (count) {
2795 rollingData[i] = [originalData[i][0], [ 1.0 * mid / count,
2796 1.0 * (mid - low) / count,
2797 1.0 * (high - mid) / count ]];
2798 } else {
2799 rollingData[i] = [originalData[i][0], [null, null, null]];
2800 }
2769de62 2801 }
6a1aa64f
DV
2802 } else {
2803 // Calculate the rolling average for the first rollPeriod - 1 points where
6faebb69 2804 // there is not enough data to roll over the full number of points
285a6bda 2805 if (!this.attr_("errorBars")){
5011e7a1
DV
2806 if (rollPeriod == 1) {
2807 return originalData;
2808 }
2809
758a629f
DV
2810 for (i = 0; i < originalData.length; i++) {
2811 sum = 0;
2812 num_ok = 0;
2813 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2814 y = originalData[j][1];
2815 if (y === null || isNaN(y)) continue;
5011e7a1 2816 num_ok++;
2847c1cf 2817 sum += originalData[j][1];
6a1aa64f 2818 }
5011e7a1 2819 if (num_ok) {
2847c1cf 2820 rollingData[i] = [originalData[i][0], sum / num_ok];
5011e7a1 2821 } else {
2847c1cf 2822 rollingData[i] = [originalData[i][0], null];
5011e7a1 2823 }
6a1aa64f 2824 }
2847c1cf
DV
2825
2826 } else {
758a629f
DV
2827 for (i = 0; i < originalData.length; i++) {
2828 sum = 0;
6a1aa64f 2829 var variance = 0;
758a629f
DV
2830 num_ok = 0;
2831 for (j = Math.max(0, i - rollPeriod + 1); j < i + 1; j++) {
2832 y = originalData[j][1][0];
2833 if (y === null || isNaN(y)) continue;
5011e7a1 2834 num_ok++;
6a1aa64f
DV
2835 sum += originalData[j][1][0];
2836 variance += Math.pow(originalData[j][1][1], 2);
2837 }
5011e7a1 2838 if (num_ok) {
758a629f 2839 stddev = Math.sqrt(variance) / num_ok;
5011e7a1
DV
2840 rollingData[i] = [originalData[i][0],
2841 [sum / num_ok, sigma * stddev, sigma * stddev]];
2842 } else {
2843 rollingData[i] = [originalData[i][0], [null, null, null]];
2844 }
6a1aa64f
DV
2845 }
2846 }
2847 }
2848
2849 return rollingData;
2850};
2851
2852/**
285a6bda
DV
2853 * Detects the type of the str (date or numeric) and sets the various
2854 * formatting attributes in this.attrs_ based on this type.
2855 * @param {String} str An x value.
2856 * @private
2857 */
2858Dygraph.prototype.detectTypeFromString_ = function(str) {
2859 var isDate = false;
0842b24b
DV
2860 var dashPos = str.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2861 if ((dashPos > 0 && (str[dashPos-1] != 'e' && str[dashPos-1] != 'E')) ||
285a6bda
DV
2862 str.indexOf('/') >= 0 ||
2863 isNaN(parseFloat(str))) {
2864 isDate = true;
2865 } else if (str.length == 8 && str > '19700101' && str < '20371231') {
2866 // TODO(danvk): remove support for this format.
2867 isDate = true;
2868 }
2869
2870 if (isDate) {
285a6bda 2871 this.attrs_.xValueParser = Dygraph.dateParser;
48e614ac
DV
2872 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
2873 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
2874 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
285a6bda 2875 } else {
c39e1d93 2876 /** @private (shut up, jsdoc!) */
285a6bda 2877 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
48e614ac
DV
2878 // TODO(danvk): use Dygraph.numberValueFormatter here?
2879 /** @private (shut up, jsdoc!) */
2880 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
44462ba3 2881 this.attrs_.axes.x.ticker = Dygraph.numericLinearTicks;
48e614ac 2882 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
6a1aa64f 2883 }
6a1aa64f
DV
2884};
2885
2886/**
5cd7ac68
DV
2887 * Parses the value as a floating point number. This is like the parseFloat()
2888 * built-in, but with a few differences:
2889 * - the empty string is parsed as null, rather than NaN.
2890 * - if the string cannot be parsed at all, an error is logged.
2891 * If the string can't be parsed, this method returns null.
2892 * @param {String} x The string to be parsed
2893 * @param {Number} opt_line_no The line number from which the string comes.
2894 * @param {String} opt_line The text of the line from which the string comes.
2895 * @private
2896 */
2897
2898// Parse the x as a float or return null if it's not a number.
2899Dygraph.prototype.parseFloat_ = function(x, opt_line_no, opt_line) {
2900 var val = parseFloat(x);
2901 if (!isNaN(val)) return val;
2902
2903 // Try to figure out what happeend.
2904 // If the value is the empty string, parse it as null.
2905 if (/^ *$/.test(x)) return null;
2906
2907 // If it was actually "NaN", return it as NaN.
2908 if (/^ *nan *$/i.test(x)) return NaN;
2909
2910 // Looks like a parsing error.
2911 var msg = "Unable to parse '" + x + "' as a number";
2912 if (opt_line !== null && opt_line_no !== null) {
2913 msg += " on line " + (1+opt_line_no) + " ('" + opt_line + "') of CSV.";
2914 }
2915 this.error(msg);
2916
2917 return null;
2918};
2919
2920/**
629a09ae 2921 * @private
6a1aa64f
DV
2922 * Parses a string in a special csv format. We expect a csv file where each
2923 * line is a date point, and the first field in each line is the date string.
2924 * We also expect that all remaining fields represent series.
285a6bda 2925 * if the errorBars attribute is set, then interpret the fields as:
6a1aa64f 2926 * date, series1, stddev1, series2, stddev2, ...
629a09ae 2927 * @param {[Object]} data See above.
285a6bda 2928 *
629a09ae 2929 * @return [Object] An array with one entry for each row. These entries
285a6bda
DV
2930 * are an array of cells in that row. The first entry is the parsed x-value for
2931 * the row. The second, third, etc. are the y-values. These can take on one of
2932 * three forms, depending on the CSV and constructor parameters:
2933 * 1. numeric value
2934 * 2. [ value, stddev ]
2935 * 3. [ low value, center value, high value ]
6a1aa64f 2936 */
285a6bda 2937Dygraph.prototype.parseCSV_ = function(data) {
6a1aa64f
DV
2938 var ret = [];
2939 var lines = data.split("\n");
758a629f 2940 var vals, j;
3d67f03b
DV
2941
2942 // Use the default delimiter or fall back to a tab if that makes sense.
2943 var delim = this.attr_('delimiter');
2944 if (lines[0].indexOf(delim) == -1 && lines[0].indexOf('\t') >= 0) {
2945 delim = '\t';
2946 }
2947
285a6bda 2948 var start = 0;
d7beab6b
DV
2949 if (!('labels' in this.user_attrs_)) {
2950 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
285a6bda 2951 start = 1;
d7beab6b 2952 this.attrs_.labels = lines[0].split(delim); // NOTE: _not_ user_attrs_.
6a1aa64f 2953 }
5cd7ac68 2954 var line_no = 0;
03b522a4 2955
285a6bda
DV
2956 var xParser;
2957 var defaultParserSet = false; // attempt to auto-detect x value type
2958 var expectedCols = this.attr_("labels").length;
987840a2 2959 var outOfOrder = false;
6a1aa64f
DV
2960 for (var i = start; i < lines.length; i++) {
2961 var line = lines[i];
5cd7ac68 2962 line_no = i;
758a629f 2963 if (line.length === 0) continue; // skip blank lines
3d67f03b
DV
2964 if (line[0] == '#') continue; // skip comment lines
2965 var inFields = line.split(delim);
285a6bda 2966 if (inFields.length < 2) continue;
6a1aa64f
DV
2967
2968 var fields = [];
285a6bda
DV
2969 if (!defaultParserSet) {
2970 this.detectTypeFromString_(inFields[0]);
2971 xParser = this.attr_("xValueParser");
2972 defaultParserSet = true;
2973 }
2974 fields[0] = xParser(inFields[0], this);
6a1aa64f
DV
2975
2976 // If fractions are expected, parse the numbers as "A/B"
2977 if (this.fractions_) {
758a629f 2978 for (j = 1; j < inFields.length; j++) {
6a1aa64f 2979 // TODO(danvk): figure out an appropriate way to flag parse errors.
758a629f 2980 vals = inFields[j].split("/");
7219edb3
DV
2981 if (vals.length != 2) {
2982 this.error('Expected fractional "num/den" values in CSV data ' +
2983 "but found a value '" + inFields[j] + "' on line " +
2984 (1 + i) + " ('" + line + "') which is not of this form.");
2985 fields[j] = [0, 0];
2986 } else {
2987 fields[j] = [this.parseFloat_(vals[0], i, line),
2988 this.parseFloat_(vals[1], i, line)];
2989 }
6a1aa64f 2990 }
285a6bda 2991 } else if (this.attr_("errorBars")) {
6a1aa64f 2992 // If there are error bars, values are (value, stddev) pairs
7219edb3
DV
2993 if (inFields.length % 2 != 1) {
2994 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2995 'but line ' + (1 + i) + ' has an odd number of values (' +
2996 (inFields.length - 1) + "): '" + line + "'");
2997 }
758a629f 2998 for (j = 1; j < inFields.length; j += 2) {
5cd7ac68
DV
2999 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3000 this.parseFloat_(inFields[j + 1], i, line)];
7219edb3 3001 }
9922b78b 3002 } else if (this.attr_("customBars")) {
6a1aa64f 3003 // Bars are a low;center;high tuple
758a629f 3004 for (j = 1; j < inFields.length; j++) {
327a9279
DV
3005 var val = inFields[j];
3006 if (/^ *$/.test(val)) {
3007 fields[j] = [null, null, null];
3008 } else {
758a629f 3009 vals = val.split(";");
327a9279
DV
3010 if (vals.length == 3) {
3011 fields[j] = [ this.parseFloat_(vals[0], i, line),
3012 this.parseFloat_(vals[1], i, line),
3013 this.parseFloat_(vals[2], i, line) ];
3014 } else {
1a5dc2af
RK
3015 this.warn('When using customBars, values must be either blank ' +
3016 'or "low;center;high" tuples (got "' + val +
3017 '" on line ' + (1+i));
327a9279
DV
3018 }
3019 }
6a1aa64f
DV
3020 }
3021 } else {
3022 // Values are just numbers
758a629f 3023 for (j = 1; j < inFields.length; j++) {
5cd7ac68 3024 fields[j] = this.parseFloat_(inFields[j], i, line);
285a6bda 3025 }
6a1aa64f 3026 }
987840a2
DV
3027 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3028 outOfOrder = true;
3029 }
285a6bda
DV
3030
3031 if (fields.length != expectedCols) {
3032 this.error("Number of columns in line " + i + " (" + fields.length +
3033 ") does not agree with number of labels (" + expectedCols +
3034 ") " + line);
3035 }
6d0aaa09
DV
3036
3037 // If the user specified the 'labels' option and none of the cells of the
3038 // first row parsed correctly, then they probably double-specified the
3039 // labels. We go with the values set in the option, discard this row and
3040 // log a warning to the JS console.
758a629f 3041 if (i === 0 && this.attr_('labels')) {
6d0aaa09 3042 var all_null = true;
758a629f 3043 for (j = 0; all_null && j < fields.length; j++) {
6d0aaa09
DV
3044 if (fields[j]) all_null = false;
3045 }
3046 if (all_null) {
3047 this.warn("The dygraphs 'labels' option is set, but the first row of " +
3048 "CSV data ('" + line + "') appears to also contain labels. " +
3049 "Will drop the CSV labels and use the option labels.");
3050 continue;
3051 }
3052 }
3053 ret.push(fields);
6a1aa64f 3054 }
987840a2
DV
3055
3056 if (outOfOrder) {
3057 this.warn("CSV is out of order; order it correctly to speed loading.");
758a629f 3058 ret.sort(function(a,b) { return a[0] - b[0]; });
987840a2
DV
3059 }
3060
6a1aa64f
DV
3061 return ret;
3062};
3063
3064/**
629a09ae 3065 * @private
285a6bda
DV
3066 * The user has provided their data as a pre-packaged JS array. If the x values
3067 * are numeric, this is the same as dygraphs' internal format. If the x values
3068 * are dates, we need to convert them from Date objects to ms since epoch.
629a09ae
DV
3069 * @param {[Object]} data
3070 * @return {[Object]} data with numeric x values.
285a6bda
DV
3071 */
3072Dygraph.prototype.parseArray_ = function(data) {
3073 // Peek at the first x value to see if it's numeric.
758a629f 3074 if (data.length === 0) {
285a6bda
DV
3075 this.error("Can't plot empty data set");
3076 return null;
3077 }
758a629f 3078 if (data[0].length === 0) {
285a6bda
DV
3079 this.error("Data set cannot contain an empty row");
3080 return null;
3081 }
3082
758a629f
DV
3083 var i;
3084 if (this.attr_("labels") === null) {
285a6bda
DV
3085 this.warn("Using default labels. Set labels explicitly via 'labels' " +
3086 "in the options parameter");
3087 this.attrs_.labels = [ "X" ];
758a629f 3088 for (i = 1; i < data[0].length; i++) {
285a6bda
DV
3089 this.attrs_.labels.push("Y" + i);
3090 }
debdb88d
DV
3091 } else {
3092 var num_labels = this.attr_("labels");
3093 if (num_labels.length != data[0].length) {
3094 this.error("Mismatch between number of labels (" + num_labels +
3095 ") and number of columns in array (" + data[0].length + ")");
3096 return null;
3097 }
285a6bda
DV
3098 }
3099
2dda3850 3100 if (Dygraph.isDateLike(data[0][0])) {
285a6bda 3101 // Some intelligent defaults for a date x-axis.
48e614ac
DV
3102 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3103 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3104 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
285a6bda
DV
3105
3106 // Assume they're all dates.
e3ab7b40 3107 var parsedData = Dygraph.clone(data);
758a629f
DV
3108 for (i = 0; i < data.length; i++) {
3109 if (parsedData[i].length === 0) {
a323ff4a 3110 this.error("Row " + (1 + i) + " of data is empty");
285a6bda
DV
3111 return null;
3112 }
758a629f
DV
3113 if (parsedData[i][0] === null ||
3114 typeof(parsedData[i][0].getTime) != 'function' ||
3115 isNaN(parsedData[i][0].getTime())) {
be96a1f5 3116 this.error("x value in row " + (1 + i) + " is not a Date");
285a6bda
DV
3117 return null;
3118 }
3119 parsedData[i][0] = parsedData[i][0].getTime();
3120 }
3121 return parsedData;
3122 } else {
3123 // Some intelligent defaults for a numeric x-axis.
c39e1d93 3124 /** @private (shut up, jsdoc!) */
48e614ac
DV
3125 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
3126 this.attrs_.axes.x.axisLabelFormatter = Dygraph.numberAxisLabelFormatter;
44462ba3 3127 this.attrs_.axes.x.ticker = Dygraph.numericLinearTicks;
285a6bda
DV
3128 return data;
3129 }
3130};
3131
3132/**
79420a1e
DV
3133 * Parses a DataTable object from gviz.
3134 * The data is expected to have a first column that is either a date or a
3135 * number. All subsequent columns must be numbers. If there is a clear mismatch
3136 * between this.xValueParser_ and the type of the first column, it will be
a685723c 3137 * fixed. Fills out rawData_.
629a09ae 3138 * @param {[Object]} data See above.
79420a1e
DV
3139 * @private
3140 */
285a6bda 3141Dygraph.prototype.parseDataTable_ = function(data) {
5829af3d 3142 var shortTextForAnnotationNum = function(num) {
3143 // converts [0-9]+ [A-Z][a-z]*
3144 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3145 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3146 var shortText = String.fromCharCode(65 /* A */ + num % 26);
3147 num = Math.floor(num / 26);
3148 while ( num > 0 ) {
3149 shortText = String.fromCharCode(65 /* A */ + (num - 1) % 26 ) + shortText.toLowerCase();
3150 num = Math.floor((num - 1) / 26);
3151 }
3152 return shortText;
42a9ebb8 3153 };
5829af3d 3154
79420a1e
DV
3155 var cols = data.getNumberOfColumns();
3156 var rows = data.getNumberOfRows();
3157
d955e223 3158 var indepType = data.getColumnType(0);
4440f6c8 3159 if (indepType == 'date' || indepType == 'datetime') {
285a6bda 3160 this.attrs_.xValueParser = Dygraph.dateParser;
48e614ac
DV
3161 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3162 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3163 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
33127159 3164 } else if (indepType == 'number') {
285a6bda 3165 this.attrs_.xValueParser = function(x) { return parseFloat(x); };
48e614ac 3166 this.attrs_.axes.x.valueFormatter = function(x) { return x; };
44462ba3 3167 this.attrs_.axes.x.ticker = Dygraph.numericLinearTicks;
48e614ac 3168 this.attrs_.axes.x.axisLabelFormatter = this.attrs_.axes.x.valueFormatter;
285a6bda 3169 } else {
987840a2
DV
3170 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3171 "column 1 of DataTable input (Got '" + indepType + "')");
79420a1e
DV
3172 return null;
3173 }
3174
a685723c
DV
3175 // Array of the column indices which contain data (and not annotations).
3176 var colIdx = [];
3177 var annotationCols = {}; // data index -> [annotation cols]
3178 var hasAnnotations = false;
758a629f
DV
3179 var i, j;
3180 for (i = 1; i < cols; i++) {
a685723c
DV
3181 var type = data.getColumnType(i);
3182 if (type == 'number') {
3183 colIdx.push(i);
3184 } else if (type == 'string' && this.attr_('displayAnnotations')) {
3185 // This is OK -- it's an annotation column.
3186 var dataIdx = colIdx[colIdx.length - 1];
3187 if (!annotationCols.hasOwnProperty(dataIdx)) {
3188 annotationCols[dataIdx] = [i];
3189 } else {
3190 annotationCols[dataIdx].push(i);
3191 }
3192 hasAnnotations = true;
3193 } else {
3194 this.error("Only 'number' is supported as a dependent type with Gviz." +
3195 " 'string' is only supported if displayAnnotations is true");
3196 }
3197 }
3198
3199 // Read column labels
3200 // TODO(danvk): add support back for errorBars
3201 var labels = [data.getColumnLabel(0)];
758a629f 3202 for (i = 0; i < colIdx.length; i++) {
a685723c 3203 labels.push(data.getColumnLabel(colIdx[i]));
f9348814 3204 if (this.attr_("errorBars")) i += 1;
a685723c
DV
3205 }
3206 this.attrs_.labels = labels;
3207 cols = labels.length;
3208
79420a1e 3209 var ret = [];
987840a2 3210 var outOfOrder = false;
a685723c 3211 var annotations = [];
758a629f 3212 for (i = 0; i < rows; i++) {
79420a1e 3213 var row = [];
debe4434
DV
3214 if (typeof(data.getValue(i, 0)) === 'undefined' ||
3215 data.getValue(i, 0) === null) {
129569a5
FD
3216 this.warn("Ignoring row " + i +
3217 " of DataTable because of undefined or null first column.");
debe4434
DV
3218 continue;
3219 }
3220
c21d2c2d 3221 if (indepType == 'date' || indepType == 'datetime') {
d955e223
DV
3222 row.push(data.getValue(i, 0).getTime());
3223 } else {
3224 row.push(data.getValue(i, 0));
3225 }
3e3f84e4 3226 if (!this.attr_("errorBars")) {
758a629f 3227 for (j = 0; j < colIdx.length; j++) {
a685723c
DV
3228 var col = colIdx[j];
3229 row.push(data.getValue(i, col));
3230 if (hasAnnotations &&
3231 annotationCols.hasOwnProperty(col) &&
758a629f 3232 data.getValue(i, annotationCols[col][0]) !== null) {
a685723c
DV
3233 var ann = {};
3234 ann.series = data.getColumnLabel(col);
3235 ann.xval = row[0];
5829af3d 3236 ann.shortText = shortTextForAnnotationNum(annotations.length);
a685723c
DV
3237 ann.text = '';
3238 for (var k = 0; k < annotationCols[col].length; k++) {
3239 if (k) ann.text += "\n";
3240 ann.text += data.getValue(i, annotationCols[col][k]);
3241 }
3242 annotations.push(ann);
3243 }
3e3f84e4 3244 }
92fd68d8
DV
3245
3246 // Strip out infinities, which give dygraphs problems later on.
758a629f 3247 for (j = 0; j < row.length; j++) {
92fd68d8
DV
3248 if (!isFinite(row[j])) row[j] = null;
3249 }
3e3f84e4 3250 } else {
758a629f 3251 for (j = 0; j < cols - 1; j++) {
3e3f84e4
DV
3252 row.push([ data.getValue(i, 1 + 2 * j), data.getValue(i, 2 + 2 * j) ]);
3253 }
79420a1e 3254 }
987840a2
DV
3255 if (ret.length > 0 && row[0] < ret[ret.length - 1][0]) {
3256 outOfOrder = true;
3257 }
243d96e8 3258 ret.push(row);
79420a1e 3259 }
987840a2
DV
3260
3261 if (outOfOrder) {
3262 this.warn("DataTable is out of order; order it correctly to speed loading.");
758a629f 3263 ret.sort(function(a,b) { return a[0] - b[0]; });
987840a2 3264 }
a685723c
DV
3265 this.rawData_ = ret;
3266
3267 if (annotations.length > 0) {
3268 this.setAnnotations(annotations, true);
3269 }
758a629f 3270};
79420a1e 3271
629a09ae 3272/**
6a1aa64f
DV
3273 * Get the CSV data. If it's in a function, call that function. If it's in a
3274 * file, do an XMLHttpRequest to get it.
3275 * @private
3276 */
285a6bda 3277Dygraph.prototype.start_ = function() {
36d4fabf
RK
3278 var data = this.file_;
3279
3280 // Functions can return references of all other types.
3281 if (typeof data == 'function') {
3282 data = data();
3283 }
3284
3285 if (Dygraph.isArrayLike(data)) {
3286 this.rawData_ = this.parseArray_(data);
26ca7938 3287 this.predraw_();
36d4fabf
RK
3288 } else if (typeof data == 'object' &&
3289 typeof data.getColumnRange == 'function') {
79420a1e 3290 // must be a DataTable from gviz.
36d4fabf 3291 this.parseDataTable_(data);
26ca7938 3292 this.predraw_();
36d4fabf 3293 } else if (typeof data == 'string') {
285a6bda 3294 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
36d4fabf
RK
3295 if (data.indexOf('\n') >= 0) {
3296 this.loadedEvent_(data);
285a6bda
DV
3297 } else {
3298 var req = new XMLHttpRequest();
3299 var caller = this;
3300 req.onreadystatechange = function () {
3301 if (req.readyState == 4) {
758a629f
DV
3302 if (req.status === 200 || // Normal http
3303 req.status === 0) { // Chrome w/ --allow-file-access-from-files
285a6bda
DV
3304 caller.loadedEvent_(req.responseText);
3305 }
6a1aa64f 3306 }
285a6bda 3307 };
6a1aa64f 3308
36d4fabf 3309 req.open("GET", data, true);
285a6bda
DV
3310 req.send(null);
3311 }
3312 } else {
36d4fabf 3313 this.error("Unknown data format: " + (typeof data));
6a1aa64f
DV
3314 }
3315};
3316
3317/**
3318 * Changes various properties of the graph. These can include:
3319 * <ul>
3320 * <li>file: changes the source data for the graph</li>
3321 * <li>errorBars: changes whether the data contains stddev</li>
3322 * </ul>
dcb25130 3323 *
ccfcc169
DV
3324 * There's a huge variety of options that can be passed to this method. For a
3325 * full list, see http://dygraphs.com/options.html.
3326 *
6a1aa64f 3327 * @param {Object} attrs The new properties and values
ccfcc169
DV
3328 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3329 * call to updateOptions(). If you know better, you can pass true to explicitly
3330 * block the redraw. This can be useful for chaining updateOptions() calls,
3331 * avoiding the occasional infinite loop and preventing redraws when it's not
3332 * necessary (e.g. when updating a callback).
6a1aa64f 3333 */
48e614ac 3334Dygraph.prototype.updateOptions = function(input_attrs, block_redraw) {
ccfcc169
DV
3335 if (typeof(block_redraw) == 'undefined') block_redraw = false;
3336
48e614ac 3337 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
758a629f 3338 var file = input_attrs.file;
48e614ac
DV
3339 var attrs = Dygraph.mapLegacyOptions_(input_attrs);
3340
ccfcc169 3341 // TODO(danvk): this is a mess. Move these options into attr_.
c65f2303 3342 if ('rollPeriod' in attrs) {
6a1aa64f
DV
3343 this.rollPeriod_ = attrs.rollPeriod;
3344 }
c65f2303 3345 if ('dateWindow' in attrs) {
6a1aa64f 3346 this.dateWindow_ = attrs.dateWindow;
e5152598 3347 if (!('isZoomedIgnoreProgrammaticZoom' in attrs)) {
758a629f 3348 this.zoomed_x_ = (attrs.dateWindow !== null);
81856f70 3349 }
b7e5862d 3350 }
e5152598 3351 if ('valueRange' in attrs && !('isZoomedIgnoreProgrammaticZoom' in attrs)) {
758a629f 3352 this.zoomed_y_ = (attrs.valueRange !== null);
6a1aa64f 3353 }
450fe64b
DV
3354
3355 // TODO(danvk): validate per-series options.
46dde5f9
DV
3356 // Supported:
3357 // strokeWidth
3358 // pointSize
3359 // drawPoints
3360 // highlightCircleSize
450fe64b 3361
9ca829f2
DV
3362 // Check if this set options will require new points.
3363 var requiresNewPoints = Dygraph.isPixelChangingOptionList(this.attr_("labels"), attrs);
3364
48e614ac 3365 Dygraph.updateDeep(this.user_attrs_, attrs);
285a6bda 3366
48e614ac
DV
3367 if (file) {
3368 this.file_ = file;
ccfcc169 3369 if (!block_redraw) this.start_();
6a1aa64f 3370 } else {
9ca829f2
DV
3371 if (!block_redraw) {
3372 if (requiresNewPoints) {
48e614ac 3373 this.predraw_();
9ca829f2 3374 } else {
e2c21500 3375 this.renderGraph_(false);
9ca829f2
DV
3376 }
3377 }
6a1aa64f
DV
3378 }
3379};
3380
3381/**
48e614ac
DV
3382 * Returns a copy of the options with deprecated names converted into current
3383 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3384 * interested in that, they should save a copy before calling this.
3385 * @private
3386 */
3387Dygraph.mapLegacyOptions_ = function(attrs) {
3388 var my_attrs = {};
3389 for (var k in attrs) {
3390 if (k == 'file') continue;
3391 if (attrs.hasOwnProperty(k)) my_attrs[k] = attrs[k];
3392 }
3393
3394 var set = function(axis, opt, value) {
3395 if (!my_attrs.axes) my_attrs.axes = {};
3396 if (!my_attrs.axes[axis]) my_attrs.axes[axis] = {};
3397 my_attrs.axes[axis][opt] = value;
3398 };
3399 var map = function(opt, axis, new_opt) {
3400 if (typeof(attrs[opt]) != 'undefined') {
3401 set(axis, new_opt, attrs[opt]);
3402 delete my_attrs[opt];
3403 }
3404 };
3405
3406 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3407 map('xValueFormatter', 'x', 'valueFormatter');
3408 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3409 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3410 map('xTicker', 'x', 'ticker');
3411 map('yValueFormatter', 'y', 'valueFormatter');
3412 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3413 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3414 map('yTicker', 'y', 'ticker');
3415 return my_attrs;
3416};
3417
3418/**
697e70b2
DV
3419 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3420 * containing div (which has presumably changed size since the dygraph was
3421 * instantiated. If the width/height are specified, the div will be resized.
964f30c6
DV
3422 *
3423 * This is far more efficient than destroying and re-instantiating a
3424 * Dygraph, since it doesn't have to reparse the underlying data.
3425 *
629a09ae
DV
3426 * @param {Number} [width] Width (in pixels)
3427 * @param {Number} [height] Height (in pixels)
697e70b2
DV
3428 */
3429Dygraph.prototype.resize = function(width, height) {
e8c7ef86
DV
3430 if (this.resize_lock) {
3431 return;
3432 }
3433 this.resize_lock = true;
3434
697e70b2
DV
3435 if ((width === null) != (height === null)) {
3436 this.warn("Dygraph.resize() should be called with zero parameters or " +
3437 "two non-NULL parameters. Pretending it was zero.");
3438 width = height = null;
3439 }
3440
4b4d1a63
DV
3441 var old_width = this.width_;
3442 var old_height = this.height_;
b16e6369 3443
697e70b2
DV
3444 if (width) {
3445 this.maindiv_.style.width = width + "px";
3446 this.maindiv_.style.height = height + "px";
3447 this.width_ = width;
3448 this.height_ = height;
3449 } else {
ccd9d7c2
PF
3450 this.width_ = this.maindiv_.clientWidth;
3451 this.height_ = this.maindiv_.clientHeight;
697e70b2
DV
3452 }
3453
4b4d1a63
DV
3454 if (old_width != this.width_ || old_height != this.height_) {
3455 // TODO(danvk): there should be a clear() method.
3456 this.maindiv_.innerHTML = "";
77b5e09d 3457 this.roller_ = null;
4b4d1a63
DV
3458 this.attrs_.labelsDiv = null;
3459 this.createInterface_();
c9faeafd
DV
3460 if (this.annotations_.length) {
3461 // createInterface_ reset the layout, so we need to do this.
3462 this.layout_.setAnnotations(this.annotations_);
3463 }
4b4d1a63
DV
3464 this.predraw_();
3465 }
e8c7ef86
DV
3466
3467 this.resize_lock = false;
697e70b2
DV
3468};
3469
3470/**
6faebb69 3471 * Adjusts the number of points in the rolling average. Updates the graph to
6a1aa64f 3472 * reflect the new averaging period.
6faebb69 3473 * @param {Number} length Number of points over which to average the data.
6a1aa64f 3474 */
285a6bda 3475Dygraph.prototype.adjustRoll = function(length) {
6a1aa64f 3476 this.rollPeriod_ = length;
26ca7938 3477 this.predraw_();
6a1aa64f 3478};
540d00f1 3479
f8cfec73 3480/**
1cf11047
DV
3481 * Returns a boolean array of visibility statuses.
3482 */
3483Dygraph.prototype.visibility = function() {
3484 // Do lazy-initialization, so that this happens after we know the number of
3485 // data series.
3486 if (!this.attr_("visibility")) {
758a629f 3487 this.attrs_.visibility = [];
1cf11047 3488 }
758a629f 3489 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs.
395e98a3 3490 while (this.attr_("visibility").length < this.numColumns() - 1) {
758a629f 3491 this.attrs_.visibility.push(true);
1cf11047
DV
3492 }
3493 return this.attr_("visibility");
3494};
3495
3496/**
3497 * Changes the visiblity of a series.
3498 */
3499Dygraph.prototype.setVisibility = function(num, value) {
3500 var x = this.visibility();
a6c109c1 3501 if (num < 0 || num >= x.length) {
1cf11047
DV
3502 this.warn("invalid series number in setVisibility: " + num);
3503 } else {
3504 x[num] = value;
26ca7938 3505 this.predraw_();
1cf11047
DV
3506 }
3507};
3508
3509/**
0cb9bd91
DV
3510 * How large of an area will the dygraph render itself in?
3511 * This is used for testing.
3512 * @return A {width: w, height: h} object.
3513 * @private
3514 */
3515Dygraph.prototype.size = function() {
3516 return { width: this.width_, height: this.height_ };
3517};
3518
3519/**
5c528fa2 3520 * Update the list of annotations and redraw the chart.
41ee764f
DV
3521 * See dygraphs.com/annotations.html for more info on how to use annotations.
3522 * @param ann {Array} An array of annotation objects.
3523 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
5c528fa2 3524 */
a685723c 3525Dygraph.prototype.setAnnotations = function(ann, suppressDraw) {
3c51ab74
DV
3526 // Only add the annotation CSS rule once we know it will be used.
3527 Dygraph.addAnnotationRule();
5c528fa2
DV
3528 this.annotations_ = ann;
3529 this.layout_.setAnnotations(this.annotations_);
a685723c 3530 if (!suppressDraw) {
26ca7938 3531 this.predraw_();
a685723c 3532 }
5c528fa2
DV
3533};
3534
3535/**
3536 * Return the list of annotations.
3537 */
3538Dygraph.prototype.annotations = function() {
3539 return this.annotations_;
3540};
3541
46dde5f9 3542/**
82c6fe4d
KW
3543 * Get the list of label names for this graph. The first column is the
3544 * x-axis, so the data series names start at index 1.
3545 */
e2c21500 3546Dygraph.prototype.getLabels = function() {
82c6fe4d
KW
3547 return this.attr_("labels").slice();
3548};
3549
3550/**
46dde5f9
DV
3551 * Get the index of a series (column) given its name. The first column is the
3552 * x-axis, so the data series start with index 1.
3553 */
3554Dygraph.prototype.indexFromSetName = function(name) {
82c6fe4d 3555 return this.setIndexByName_[name];
46dde5f9
DV
3556};
3557
629a09ae 3558/**
857a6931
KW
3559 * Get the internal dataset index given its name. These are numbered starting from 0,
3560 * and only count visible sets.
3561 * @private
3562 */
3563Dygraph.prototype.datasetIndexFromSetName_ = function(name) {
3564 return this.datasetIndex_[this.indexFromSetName(name)];
3565};
3566
3567/**
629a09ae
DV
3568 * @private
3569 * Adds a default style for the annotation CSS classes to the document. This is
3570 * only executed when annotations are actually used. It is designed to only be
3571 * called once -- all calls after the first will return immediately.
3572 */
5c528fa2 3573Dygraph.addAnnotationRule = function() {
d38c6191 3574 // TODO(danvk): move this function into plugins/annotations.js?
5c528fa2
DV
3575 if (Dygraph.addedAnnotationCSS) return;
3576
5c528fa2
DV
3577 var rule = "border: 1px solid black; " +
3578 "background-color: white; " +
3579 "text-align: center;";
22186871
DV
3580
3581 var styleSheetElement = document.createElement("style");
3582 styleSheetElement.type = "text/css";
3583 document.getElementsByTagName("head")[0].appendChild(styleSheetElement);
3584
3585 // Find the first style sheet that we can access.
3586 // We may not add a rule to a style sheet from another domain for security
3587 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3588 // adds its own style sheets from google.com.
3589 for (var i = 0; i < document.styleSheets.length; i++) {
3590 if (document.styleSheets[i].disabled) continue;
3591 var mysheet = document.styleSheets[i];
3592 try {
3593 if (mysheet.insertRule) { // Firefox
3594 var idx = mysheet.cssRules ? mysheet.cssRules.length : 0;
3595 mysheet.insertRule(".dygraphDefaultAnnotation { " + rule + " }", idx);
3596 } else if (mysheet.addRule) { // IE
3597 mysheet.addRule(".dygraphDefaultAnnotation", rule);
3598 }
3599 Dygraph.addedAnnotationCSS = true;
3600 return;
3601 } catch(err) {
3602 // Was likely a security exception.
3603 }
5c528fa2
DV
3604 }
3605
22186871 3606 this.warn("Unable to add default annotation CSS rule; display may be off.");
758a629f 3607};
5c528fa2 3608
285a6bda 3609// Older pages may still use this name.
c0f54d4f 3610var DateGraph = Dygraph;