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