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