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