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