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