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