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