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