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