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