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