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