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