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