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