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