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