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