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