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