Merge pull request #245 from sauter-hq/custom-bar-data-gaps-459
[dygraphs.git] / dygraph-utils.js
... / ...
CommitLineData
1/**
2 * @license
3 * Copyright 2011 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
5 */
6
7/**
8 * @fileoverview This file contains utility functions used by dygraphs. These
9 * are typically static (i.e. not related to any particular dygraph). Examples
10 * include date/time formatting functions, basic algorithms (e.g. binary
11 * search) and generic DOM-manipulation functions.
12 */
13
14/*jshint globalstrict: true */
15/*global Dygraph:false, G_vmlCanvasManager:false, Node:false, printStackTrace: false */
16"use strict";
17
18Dygraph.LOG_SCALE = 10;
19Dygraph.LN_TEN = Math.log(Dygraph.LOG_SCALE);
20
21/**
22 * @private
23 * @param {number} x
24 * @return {number}
25 */
26Dygraph.log10 = function(x) {
27 return Math.log(x) / Dygraph.LN_TEN;
28};
29
30// Various logging levels.
31Dygraph.DEBUG = 1;
32Dygraph.INFO = 2;
33Dygraph.WARNING = 3;
34Dygraph.ERROR = 3;
35
36// Set this to log stack traces on warnings, etc.
37// This requires stacktrace.js, which is up to you to provide.
38// A copy can be found in the dygraphs repo, or at
39// https://github.com/eriwen/javascript-stacktrace
40Dygraph.LOG_STACK_TRACES = false;
41
42/** A dotted line stroke pattern. */
43Dygraph.DOTTED_LINE = [2, 2];
44/** A dashed line stroke pattern. */
45Dygraph.DASHED_LINE = [7, 3];
46/** A dot dash stroke pattern. */
47Dygraph.DOT_DASH_LINE = [7, 2, 2, 2];
48
49/**
50 * Log an error on the JS console at the given severity.
51 * @param {number} severity One of Dygraph.{DEBUG,INFO,WARNING,ERROR}
52 * @param {string} message The message to log.
53 * @private
54 */
55Dygraph.log = function(severity, message) {
56 var st;
57 if (typeof(printStackTrace) != 'undefined') {
58 try {
59 // Remove uninteresting bits: logging functions and paths.
60 st = printStackTrace({guess:false});
61 while (st[0].indexOf("stacktrace") != -1) {
62 st.splice(0, 1);
63 }
64
65 st.splice(0, 2);
66 for (var i = 0; i < st.length; i++) {
67 st[i] = st[i].replace(/\([^)]*\/(.*)\)/, '@$1')
68 .replace(/\@.*\/([^\/]*)/, '@$1')
69 .replace('[object Object].', '');
70 }
71 var top_msg = st.splice(0, 1)[0];
72 message += ' (' + top_msg.replace(/^.*@ ?/, '') + ')';
73 } catch(e) {
74 // Oh well, it was worth a shot!
75 }
76 }
77
78 if (typeof(window.console) != 'undefined') {
79 // In older versions of Firefox, only console.log is defined.
80 var console = window.console;
81 var log = function(console, method, msg) {
82 if (method && typeof(method) == 'function') {
83 method.call(console, msg);
84 } else {
85 console.log(msg);
86 }
87 };
88
89 switch (severity) {
90 case Dygraph.DEBUG:
91 log(console, console.debug, 'dygraphs: ' + message);
92 break;
93 case Dygraph.INFO:
94 log(console, console.info, 'dygraphs: ' + message);
95 break;
96 case Dygraph.WARNING:
97 log(console, console.warn, 'dygraphs: ' + message);
98 break;
99 case Dygraph.ERROR:
100 log(console, console.error, 'dygraphs: ' + message);
101 break;
102 }
103 }
104
105 if (Dygraph.LOG_STACK_TRACES) {
106 window.console.log(st.join('\n'));
107 }
108};
109
110/**
111 * @param {string} message
112 * @private
113 */
114Dygraph.info = function(message) {
115 Dygraph.log(Dygraph.INFO, message);
116};
117/**
118 * @param {string} message
119 * @private
120 */
121Dygraph.prototype.info = Dygraph.info;
122
123/**
124 * @param {string} message
125 * @private
126 */
127Dygraph.warn = function(message) {
128 Dygraph.log(Dygraph.WARNING, message);
129};
130/**
131 * @param {string} message
132 * @private
133 */
134Dygraph.prototype.warn = Dygraph.warn;
135
136/**
137 * @param {string} message
138 */
139Dygraph.error = function(message) {
140 Dygraph.log(Dygraph.ERROR, message);
141};
142/**
143 * @param {string} message
144 * @private
145 */
146Dygraph.prototype.error = Dygraph.error;
147
148/**
149 * Return the 2d context for a dygraph canvas.
150 *
151 * This method is only exposed for the sake of replacing the function in
152 * automated tests, e.g.
153 *
154 * var oldFunc = Dygraph.getContext();
155 * Dygraph.getContext = function(canvas) {
156 * var realContext = oldFunc(canvas);
157 * return new Proxy(realContext);
158 * };
159 * @param {!HTMLCanvasElement} canvas
160 * @return {!CanvasRenderingContext2D}
161 * @private
162 */
163Dygraph.getContext = function(canvas) {
164 return /** @type{!CanvasRenderingContext2D}*/(canvas.getContext("2d"));
165};
166
167/**
168 * Add an event handler. This smooths a difference between IE and the rest of
169 * the world.
170 * @param { !Element } elem The element to add the event to.
171 * @param { string } type The type of the event, e.g. 'click' or 'mousemove'.
172 * @param { function(Event):(boolean|undefined) } fn The function to call
173 * on the event. The function takes one parameter: the event object.
174 * @private
175 */
176Dygraph.addEvent = function addEvent(elem, type, fn) {
177 if (elem.addEventListener) {
178 elem.addEventListener(type, fn, false);
179 } else {
180 elem[type+fn] = function(){fn(window.event);};
181 elem.attachEvent('on'+type, elem[type+fn]);
182 }
183};
184
185/**
186 * Add an event handler. This event handler is kept until the graph is
187 * destroyed with a call to graph.destroy().
188 *
189 * @param { !Element } elem The element to add the event to.
190 * @param { string } type The type of the event, e.g. 'click' or 'mousemove'.
191 * @param { function(Event):(boolean|undefined) } fn The function to call
192 * on the event. The function takes one parameter: the event object.
193 * @private
194 */
195Dygraph.prototype.addEvent = function(elem, type, fn) {
196 Dygraph.addEvent(elem, type, fn);
197 this.registeredEvents_.push({ elem : elem, type : type, fn : fn });
198};
199
200/**
201 * Remove an event handler. This smooths a difference between IE and the rest
202 * of the world.
203 * @param {!Element} elem The element to add the event to.
204 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
205 * @param {function(Event):(boolean|undefined)} fn The function to call
206 * on the event. The function takes one parameter: the event object.
207 * @private
208 */
209Dygraph.removeEvent = function(elem, type, fn) {
210 if (elem.removeEventListener) {
211 elem.removeEventListener(type, fn, false);
212 } else {
213 try {
214 elem.detachEvent('on'+type, elem[type+fn]);
215 } catch(e) {
216 // We only detach event listeners on a "best effort" basis in IE. See:
217 // http://stackoverflow.com/questions/2553632/detachevent-not-working-with-named-inline-functions
218 }
219 elem[type+fn] = null;
220 }
221};
222
223/**
224 * Cancels further processing of an event. This is useful to prevent default
225 * browser actions, e.g. highlighting text on a double-click.
226 * Based on the article at
227 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
228 * @param { !Event } e The event whose normal behavior should be canceled.
229 * @private
230 */
231Dygraph.cancelEvent = function(e) {
232 e = e ? e : window.event;
233 if (e.stopPropagation) {
234 e.stopPropagation();
235 }
236 if (e.preventDefault) {
237 e.preventDefault();
238 }
239 e.cancelBubble = true;
240 e.cancel = true;
241 e.returnValue = false;
242 return false;
243};
244
245/**
246 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
247 * is used to generate default series colors which are evenly spaced on the
248 * color wheel.
249 * @param { number } hue Range is 0.0-1.0.
250 * @param { number } saturation Range is 0.0-1.0.
251 * @param { number } value Range is 0.0-1.0.
252 * @return { string } "rgb(r,g,b)" where r, g and b range from 0-255.
253 * @private
254 */
255Dygraph.hsvToRGB = function (hue, saturation, value) {
256 var red;
257 var green;
258 var blue;
259 if (saturation === 0) {
260 red = value;
261 green = value;
262 blue = value;
263 } else {
264 var i = Math.floor(hue * 6);
265 var f = (hue * 6) - i;
266 var p = value * (1 - saturation);
267 var q = value * (1 - (saturation * f));
268 var t = value * (1 - (saturation * (1 - f)));
269 switch (i) {
270 case 1: red = q; green = value; blue = p; break;
271 case 2: red = p; green = value; blue = t; break;
272 case 3: red = p; green = q; blue = value; break;
273 case 4: red = t; green = p; blue = value; break;
274 case 5: red = value; green = p; blue = q; break;
275 case 6: // fall through
276 case 0: red = value; green = t; blue = p; break;
277 }
278 }
279 red = Math.floor(255 * red + 0.5);
280 green = Math.floor(255 * green + 0.5);
281 blue = Math.floor(255 * blue + 0.5);
282 return 'rgb(' + red + ',' + green + ',' + blue + ')';
283};
284
285// The following functions are from quirksmode.org with a modification for Safari from
286// http://blog.firetree.net/2005/07/04/javascript-find-position/
287// http://www.quirksmode.org/js/findpos.html
288// ... and modifications to support scrolling divs.
289
290/**
291 * Find the x-coordinate of the supplied object relative to the left side
292 * of the page.
293 * TODO(danvk): change obj type from Node -&gt; !Node
294 * @param {Node} obj
295 * @return {number}
296 * @private
297 */
298Dygraph.findPosX = function(obj) {
299 var curleft = 0;
300 if(obj.offsetParent) {
301 var copyObj = obj;
302 while(1) {
303 // NOTE: the if statement here is for IE8.
304 var borderLeft = "0";
305 if (window.getComputedStyle) {
306 borderLeft = window.getComputedStyle(copyObj, null).borderLeft || "0";
307 }
308 curleft += parseInt(borderLeft, 10) ;
309 curleft += copyObj.offsetLeft;
310 if(!copyObj.offsetParent) {
311 break;
312 }
313 copyObj = copyObj.offsetParent;
314 }
315 } else if(obj.x) {
316 curleft += obj.x;
317 }
318 // This handles the case where the object is inside a scrolled div.
319 while(obj && obj != document.body) {
320 curleft -= obj.scrollLeft;
321 obj = obj.parentNode;
322 }
323 return curleft;
324};
325
326/**
327 * Find the y-coordinate of the supplied object relative to the top of the
328 * page.
329 * TODO(danvk): change obj type from Node -&gt; !Node
330 * TODO(danvk): consolidate with findPosX and return an {x, y} object.
331 * @param {Node} obj
332 * @return {number}
333 * @private
334 */
335Dygraph.findPosY = function(obj) {
336 var curtop = 0;
337 if(obj.offsetParent) {
338 var copyObj = obj;
339 while(1) {
340 // NOTE: the if statement here is for IE8.
341 var borderTop = "0";
342 if (window.getComputedStyle) {
343 borderTop = window.getComputedStyle(copyObj, null).borderTop || "0";
344 }
345 curtop += parseInt(borderTop, 10) ;
346 curtop += copyObj.offsetTop;
347 if(!copyObj.offsetParent) {
348 break;
349 }
350 copyObj = copyObj.offsetParent;
351 }
352 } else if(obj.y) {
353 curtop += obj.y;
354 }
355 // This handles the case where the object is inside a scrolled div.
356 while(obj && obj != document.body) {
357 curtop -= obj.scrollTop;
358 obj = obj.parentNode;
359 }
360 return curtop;
361};
362
363/**
364 * Returns the x-coordinate of the event in a coordinate system where the
365 * top-left corner of the page (not the window) is (0,0).
366 * Taken from MochiKit.Signal
367 * @param {!Event} e
368 * @return {number}
369 * @private
370 */
371Dygraph.pageX = function(e) {
372 if (e.pageX) {
373 return (!e.pageX || e.pageX < 0) ? 0 : e.pageX;
374 } else {
375 var de = document.documentElement;
376 var b = document.body;
377 return e.clientX +
378 (de.scrollLeft || b.scrollLeft) -
379 (de.clientLeft || 0);
380 }
381};
382
383/**
384 * Returns the y-coordinate of the event in a coordinate system where the
385 * top-left corner of the page (not the window) is (0,0).
386 * Taken from MochiKit.Signal
387 * @param {!Event} e
388 * @return {number}
389 * @private
390 */
391Dygraph.pageY = function(e) {
392 if (e.pageY) {
393 return (!e.pageY || e.pageY < 0) ? 0 : e.pageY;
394 } else {
395 var de = document.documentElement;
396 var b = document.body;
397 return e.clientY +
398 (de.scrollTop || b.scrollTop) -
399 (de.clientTop || 0);
400 }
401};
402
403/**
404 * This returns true unless the parameter is 0, null, undefined or NaN.
405 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
406 *
407 * @param {number} x The number to consider.
408 * @return {boolean} Whether the number is zero or NaN.
409 * @private
410 */
411Dygraph.isOK = function(x) {
412 return !!x && !isNaN(x);
413};
414
415/**
416 * @param { {x:?number,y:?number,yval:?number} } p The point to consider, valid
417 * points are {x, y} objects
418 * @param { boolean } allowNaNY Treat point with y=NaN as valid
419 * @return { boolean } Whether the point has numeric x and y.
420 * @private
421 */
422Dygraph.isValidPoint = function(p, allowNaNY) {
423 if (!p) return false; // null or undefined object
424 if (p.yval === null) return false; // missing point
425 if (p.x === null || p.x === undefined) return false;
426 if (p.y === null || p.y === undefined) return false;
427 if (isNaN(p.x) || (!allowNaNY && isNaN(p.y))) return false;
428 return true;
429};
430
431/**
432 * Number formatting function which mimicks the behavior of %g in printf, i.e.
433 * either exponential or fixed format (without trailing 0s) is used depending on
434 * the length of the generated string. The advantage of this format is that
435 * there is a predictable upper bound on the resulting string length,
436 * significant figures are not dropped, and normal numbers are not displayed in
437 * exponential notation.
438 *
439 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
440 * It creates strings which are too long for absolute values between 10^-4 and
441 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
442 * output examples.
443 *
444 * @param {number} x The number to format
445 * @param {number=} opt_precision The precision to use, default 2.
446 * @return {string} A string formatted like %g in printf. The max generated
447 * string length should be precision + 6 (e.g 1.123e+300).
448 */
449Dygraph.floatFormat = function(x, opt_precision) {
450 // Avoid invalid precision values; [1, 21] is the valid range.
451 var p = Math.min(Math.max(1, opt_precision || 2), 21);
452
453 // This is deceptively simple. The actual algorithm comes from:
454 //
455 // Max allowed length = p + 4
456 // where 4 comes from 'e+n' and '.'.
457 //
458 // Length of fixed format = 2 + y + p
459 // where 2 comes from '0.' and y = # of leading zeroes.
460 //
461 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
462 // 1.0e-3.
463 //
464 // Since the behavior of toPrecision() is identical for larger numbers, we
465 // don't have to worry about the other bound.
466 //
467 // Finally, the argument for toExponential() is the number of trailing digits,
468 // so we take off 1 for the value before the '.'.
469 return (Math.abs(x) < 1.0e-3 && x !== 0.0) ?
470 x.toExponential(p - 1) : x.toPrecision(p);
471};
472
473/**
474 * Converts '9' to '09' (useful for dates)
475 * @param {number} x
476 * @return {string}
477 * @private
478 */
479Dygraph.zeropad = function(x) {
480 if (x < 10) return "0" + x; else return "" + x;
481};
482
483/**
484 * Return a string version of the hours, minutes and seconds portion of a date.
485 *
486 * @param {number} date The JavaScript date (ms since epoch)
487 * @return {string} A time of the form "HH:MM:SS"
488 * @private
489 */
490Dygraph.hmsString_ = function(date) {
491 var zeropad = Dygraph.zeropad;
492 var d = new Date(date);
493 if (d.getSeconds()) {
494 return zeropad(d.getHours()) + ":" +
495 zeropad(d.getMinutes()) + ":" +
496 zeropad(d.getSeconds());
497 } else {
498 return zeropad(d.getHours()) + ":" + zeropad(d.getMinutes());
499 }
500};
501
502/**
503 * Round a number to the specified number of digits past the decimal point.
504 * @param {number} num The number to round
505 * @param {number} places The number of decimals to which to round
506 * @return {number} The rounded number
507 * @private
508 */
509Dygraph.round_ = function(num, places) {
510 var shift = Math.pow(10, places);
511 return Math.round(num * shift)/shift;
512};
513
514/**
515 * Implementation of binary search over an array.
516 * Currently does not work when val is outside the range of arry's values.
517 * @param {number} val the value to search for
518 * @param {Array.<number>} arry is the value over which to search
519 * @param {number} abs If abs > 0, find the lowest entry greater than val
520 * If abs < 0, find the highest entry less than val.
521 * If abs == 0, find the entry that equals val.
522 * @param {number=} low The first index in arry to consider (optional)
523 * @param {number=} high The last index in arry to consider (optional)
524 * @return {number} Index of the element, or -1 if it isn't found.
525 * @private
526 */
527Dygraph.binarySearch = function(val, arry, abs, low, high) {
528 if (low === null || low === undefined ||
529 high === null || high === undefined) {
530 low = 0;
531 high = arry.length - 1;
532 }
533 if (low > high) {
534 return -1;
535 }
536 if (abs === null || abs === undefined) {
537 abs = 0;
538 }
539 var validIndex = function(idx) {
540 return idx >= 0 && idx < arry.length;
541 };
542 var mid = parseInt((low + high) / 2, 10);
543 var element = arry[mid];
544 var idx;
545 if (element == val) {
546 return mid;
547 } else if (element > val) {
548 if (abs > 0) {
549 // Accept if element > val, but also if prior element < val.
550 idx = mid - 1;
551 if (validIndex(idx) && arry[idx] < val) {
552 return mid;
553 }
554 }
555 return Dygraph.binarySearch(val, arry, abs, low, mid - 1);
556 } else if (element < val) {
557 if (abs < 0) {
558 // Accept if element < val, but also if prior element > val.
559 idx = mid + 1;
560 if (validIndex(idx) && arry[idx] > val) {
561 return mid;
562 }
563 }
564 return Dygraph.binarySearch(val, arry, abs, mid + 1, high);
565 }
566 return -1; // can't actually happen, but makes closure compiler happy
567};
568
569/**
570 * Parses a date, returning the number of milliseconds since epoch. This can be
571 * passed in as an xValueParser in the Dygraph constructor.
572 * TODO(danvk): enumerate formats that this understands.
573 *
574 * @param {string} dateStr A date in a variety of possible string formats.
575 * @return {number} Milliseconds since epoch.
576 * @private
577 */
578Dygraph.dateParser = function(dateStr) {
579 var dateStrSlashed;
580 var d;
581
582 // Let the system try the format first, with one caveat:
583 // YYYY-MM-DD[ HH:MM:SS] is interpreted as UTC by a variety of browsers.
584 // dygraphs displays dates in local time, so this will result in surprising
585 // inconsistencies. But if you specify "T" or "Z" (i.e. YYYY-MM-DDTHH:MM:SS),
586 // then you probably know what you're doing, so we'll let you go ahead.
587 // Issue: http://code.google.com/p/dygraphs/issues/detail?id=255
588 if (dateStr.search("-") == -1 ||
589 dateStr.search("T") != -1 || dateStr.search("Z") != -1) {
590 d = Dygraph.dateStrToMillis(dateStr);
591 if (d && !isNaN(d)) return d;
592 }
593
594 if (dateStr.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
595 dateStrSlashed = dateStr.replace("-", "/", "g");
596 while (dateStrSlashed.search("-") != -1) {
597 dateStrSlashed = dateStrSlashed.replace("-", "/");
598 }
599 d = Dygraph.dateStrToMillis(dateStrSlashed);
600 } else if (dateStr.length == 8) { // e.g. '20090712'
601 // TODO(danvk): remove support for this format. It's confusing.
602 dateStrSlashed = dateStr.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
603 dateStr.substr(6,2);
604 d = Dygraph.dateStrToMillis(dateStrSlashed);
605 } else {
606 // Any format that Date.parse will accept, e.g. "2009/07/12" or
607 // "2009/07/12 12:34:56"
608 d = Dygraph.dateStrToMillis(dateStr);
609 }
610
611 if (!d || isNaN(d)) {
612 Dygraph.error("Couldn't parse " + dateStr + " as a date");
613 }
614 return d;
615};
616
617/**
618 * This is identical to JavaScript's built-in Date.parse() method, except that
619 * it doesn't get replaced with an incompatible method by aggressive JS
620 * libraries like MooTools or Joomla.
621 * @param {string} str The date string, e.g. "2011/05/06"
622 * @return {number} millis since epoch
623 * @private
624 */
625Dygraph.dateStrToMillis = function(str) {
626 return new Date(str).getTime();
627};
628
629// These functions are all based on MochiKit.
630/**
631 * Copies all the properties from o to self.
632 *
633 * @param {!Object} self
634 * @param {!Object} o
635 * @return {!Object}
636 */
637Dygraph.update = function(self, o) {
638 if (typeof(o) != 'undefined' && o !== null) {
639 for (var k in o) {
640 if (o.hasOwnProperty(k)) {
641 self[k] = o[k];
642 }
643 }
644 }
645 return self;
646};
647
648/**
649 * Copies all the properties from o to self.
650 *
651 * @param {!Object} self
652 * @param {!Object} o
653 * @return {!Object}
654 * @private
655 */
656Dygraph.updateDeep = function (self, o) {
657 // Taken from http://stackoverflow.com/questions/384286/javascript-isdom-how-do-you-check-if-a-javascript-object-is-a-dom-object
658 function isNode(o) {
659 return (
660 typeof Node === "object" ? o instanceof Node :
661 typeof o === "object" && typeof o.nodeType === "number" && typeof o.nodeName==="string"
662 );
663 }
664
665 if (typeof(o) != 'undefined' && o !== null) {
666 for (var k in o) {
667 if (o.hasOwnProperty(k)) {
668 if (o[k] === null) {
669 self[k] = null;
670 } else if (Dygraph.isArrayLike(o[k])) {
671 self[k] = o[k].slice();
672 } else if (isNode(o[k])) {
673 // DOM objects are shallowly-copied.
674 self[k] = o[k];
675 } else if (typeof(o[k]) == 'object') {
676 if (typeof(self[k]) != 'object' || self[k] === null) {
677 self[k] = {};
678 }
679 Dygraph.updateDeep(self[k], o[k]);
680 } else {
681 self[k] = o[k];
682 }
683 }
684 }
685 }
686 return self;
687};
688
689/**
690 * @param {Object} o
691 * @return {boolean}
692 * @private
693 */
694Dygraph.isArrayLike = function(o) {
695 var typ = typeof(o);
696 if (
697 (typ != 'object' && !(typ == 'function' &&
698 typeof(o.item) == 'function')) ||
699 o === null ||
700 typeof(o.length) != 'number' ||
701 o.nodeType === 3
702 ) {
703 return false;
704 }
705 return true;
706};
707
708/**
709 * @param {Object} o
710 * @return {boolean}
711 * @private
712 */
713Dygraph.isDateLike = function (o) {
714 if (typeof(o) != "object" || o === null ||
715 typeof(o.getTime) != 'function') {
716 return false;
717 }
718 return true;
719};
720
721/**
722 * Note: this only seems to work for arrays.
723 * @param {!Array} o
724 * @return {!Array}
725 * @private
726 */
727Dygraph.clone = function(o) {
728 // TODO(danvk): figure out how MochiKit's version works
729 var r = [];
730 for (var i = 0; i < o.length; i++) {
731 if (Dygraph.isArrayLike(o[i])) {
732 r.push(Dygraph.clone(o[i]));
733 } else {
734 r.push(o[i]);
735 }
736 }
737 return r;
738};
739
740/**
741 * Create a new canvas element. This is more complex than a simple
742 * document.createElement("canvas") because of IE and excanvas.
743 *
744 * @return {!HTMLCanvasElement}
745 * @private
746 */
747Dygraph.createCanvas = function() {
748 var canvas = document.createElement("canvas");
749
750 var isIE = (/MSIE/.test(navigator.userAgent) && !window.opera);
751 if (isIE && (typeof(G_vmlCanvasManager) != 'undefined')) {
752 canvas = G_vmlCanvasManager.initElement(
753 /**@type{!HTMLCanvasElement}*/(canvas));
754 }
755
756 return canvas;
757};
758
759/**
760 * Checks whether the user is on an Android browser.
761 * Android does not fully support the <canvas> tag, e.g. w/r/t/ clipping.
762 * @return {boolean}
763 * @private
764 */
765Dygraph.isAndroid = function() {
766 return (/Android/).test(navigator.userAgent);
767};
768
769
770/**
771 * TODO(danvk): use @template here when it's better supported for classes.
772 * @param {!Array} array
773 * @param {number} start
774 * @param {number} length
775 * @param {function(!Array,?):boolean=} predicate
776 * @constructor
777 */
778Dygraph.Iterator = function(array, start, length, predicate) {
779 start = start || 0;
780 length = length || array.length;
781 this.hasNext = true; // Use to identify if there's another element.
782 this.peek = null; // Use for look-ahead
783 this.start_ = start;
784 this.array_ = array;
785 this.predicate_ = predicate;
786 this.end_ = Math.min(array.length, start + length);
787 this.nextIdx_ = start - 1; // use -1 so initial advance works.
788 this.next(); // ignoring result.
789};
790
791/**
792 * @return {Object}
793 */
794Dygraph.Iterator.prototype.next = function() {
795 if (!this.hasNext) {
796 return null;
797 }
798 var obj = this.peek;
799
800 var nextIdx = this.nextIdx_ + 1;
801 var found = false;
802 while (nextIdx < this.end_) {
803 if (!this.predicate_ || this.predicate_(this.array_, nextIdx)) {
804 this.peek = this.array_[nextIdx];
805 found = true;
806 break;
807 }
808 nextIdx++;
809 }
810 this.nextIdx_ = nextIdx;
811 if (!found) {
812 this.hasNext = false;
813 this.peek = null;
814 }
815 return obj;
816};
817
818/**
819 * Returns a new iterator over array, between indexes start and
820 * start + length, and only returns entries that pass the accept function
821 *
822 * @param {!Array} array the array to iterate over.
823 * @param {number} start the first index to iterate over, 0 if absent.
824 * @param {number} length the number of elements in the array to iterate over.
825 * This, along with start, defines a slice of the array, and so length
826 * doesn't imply the number of elements in the iterator when accept doesn't
827 * always accept all values. array.length when absent.
828 * @param {function(?):boolean=} opt_predicate a function that takes
829 * parameters array and idx, which returns true when the element should be
830 * returned. If omitted, all elements are accepted.
831 * @private
832 */
833Dygraph.createIterator = function(array, start, length, opt_predicate) {
834 return new Dygraph.Iterator(array, start, length, opt_predicate);
835};
836
837// Shim layer with setTimeout fallback.
838// From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
839// Should be called with the window context:
840// Dygraph.requestAnimFrame.call(window, function() {})
841Dygraph.requestAnimFrame = (function() {
842 return window.requestAnimationFrame ||
843 window.webkitRequestAnimationFrame ||
844 window.mozRequestAnimationFrame ||
845 window.oRequestAnimationFrame ||
846 window.msRequestAnimationFrame ||
847 function (callback) {
848 window.setTimeout(callback, 1000 / 60);
849 };
850})();
851
852/**
853 * Call a function at most maxFrames times at an attempted interval of
854 * framePeriodInMillis, then call a cleanup function once. repeatFn is called
855 * once immediately, then at most (maxFrames - 1) times asynchronously. If
856 * maxFrames==1, then cleanup_fn() is also called synchronously. This function
857 * is used to sequence animation.
858 * @param {function(number)} repeatFn Called repeatedly -- takes the frame
859 * number (from 0 to maxFrames-1) as an argument.
860 * @param {number} maxFrames The max number of times to call repeatFn
861 * @param {number} framePeriodInMillis Max requested time between frames.
862 * @param {function()} cleanupFn A function to call after all repeatFn calls.
863 * @private
864 */
865Dygraph.repeatAndCleanup = function(repeatFn, maxFrames, framePeriodInMillis,
866 cleanupFn) {
867 var frameNumber = 0;
868 var previousFrameNumber;
869 var startTime = new Date().getTime();
870 repeatFn(frameNumber);
871 if (maxFrames == 1) {
872 cleanupFn();
873 return;
874 }
875 var maxFrameArg = maxFrames - 1;
876
877 (function loop() {
878 if (frameNumber >= maxFrames) return;
879 Dygraph.requestAnimFrame.call(window, function() {
880 // Determine which frame to draw based on the delay so far. Will skip
881 // frames if necessary.
882 var currentTime = new Date().getTime();
883 var delayInMillis = currentTime - startTime;
884 previousFrameNumber = frameNumber;
885 frameNumber = Math.floor(delayInMillis / framePeriodInMillis);
886 var frameDelta = frameNumber - previousFrameNumber;
887 // If we predict that the subsequent repeatFn call will overshoot our
888 // total frame target, so our last call will cause a stutter, then jump to
889 // the last call immediately. If we're going to cause a stutter, better
890 // to do it faster than slower.
891 var predictOvershootStutter = (frameNumber + frameDelta) > maxFrameArg;
892 if (predictOvershootStutter || (frameNumber >= maxFrameArg)) {
893 repeatFn(maxFrameArg); // Ensure final call with maxFrameArg.
894 cleanupFn();
895 } else {
896 if (frameDelta !== 0) { // Don't call repeatFn with duplicate frames.
897 repeatFn(frameNumber);
898 }
899 loop();
900 }
901 });
902 })();
903};
904
905/**
906 * This function will scan the option list and determine if they
907 * require us to recalculate the pixel positions of each point.
908 * @param {!Array.<string>} labels a list of options to check.
909 * @param {!Object} attrs
910 * @return {boolean} true if the graph needs new points else false.
911 * @private
912 */
913Dygraph.isPixelChangingOptionList = function(labels, attrs) {
914 // A whitelist of options that do not change pixel positions.
915 var pixelSafeOptions = {
916 'annotationClickHandler': true,
917 'annotationDblClickHandler': true,
918 'annotationMouseOutHandler': true,
919 'annotationMouseOverHandler': true,
920 'axisLabelColor': true,
921 'axisLineColor': true,
922 'axisLineWidth': true,
923 'clickCallback': true,
924 'digitsAfterDecimal': true,
925 'drawCallback': true,
926 'drawHighlightPointCallback': true,
927 'drawPoints': true,
928 'drawPointCallback': true,
929 'drawXGrid': true,
930 'drawYGrid': true,
931 'fillAlpha': true,
932 'gridLineColor': true,
933 'gridLineWidth': true,
934 'hideOverlayOnMouseOut': true,
935 'highlightCallback': true,
936 'highlightCircleSize': true,
937 'interactionModel': true,
938 'isZoomedIgnoreProgrammaticZoom': true,
939 'labelsDiv': true,
940 'labelsDivStyles': true,
941 'labelsDivWidth': true,
942 'labelsKMB': true,
943 'labelsKMG2': true,
944 'labelsSeparateLines': true,
945 'labelsShowZeroValues': true,
946 'legend': true,
947 'maxNumberWidth': true,
948 'panEdgeFraction': true,
949 'pixelsPerYLabel': true,
950 'pointClickCallback': true,
951 'pointSize': true,
952 'rangeSelectorPlotFillColor': true,
953 'rangeSelectorPlotStrokeColor': true,
954 'showLabelsOnHighlight': true,
955 'showRoller': true,
956 'sigFigs': true,
957 'strokeWidth': true,
958 'underlayCallback': true,
959 'unhighlightCallback': true,
960 'xAxisLabelFormatter': true,
961 'xTicker': true,
962 'xValueFormatter': true,
963 'yAxisLabelFormatter': true,
964 'yValueFormatter': true,
965 'zoomCallback': true
966 };
967
968 // Assume that we do not require new points.
969 // This will change to true if we actually do need new points.
970 var requiresNewPoints = false;
971
972 // Create a dictionary of series names for faster lookup.
973 // If there are no labels, then the dictionary stays empty.
974 var seriesNamesDictionary = { };
975 if (labels) {
976 for (var i = 1; i < labels.length; i++) {
977 seriesNamesDictionary[labels[i]] = true;
978 }
979 }
980
981 // Iterate through the list of updated options.
982 for (var property in attrs) {
983 // Break early if we already know we need new points from a previous option.
984 if (requiresNewPoints) {
985 break;
986 }
987 if (attrs.hasOwnProperty(property)) {
988 // Find out of this field is actually a series specific options list.
989 if (seriesNamesDictionary[property]) {
990 // This property value is a list of options for this series.
991 // If any of these sub properties are not pixel safe, set the flag.
992 for (var subProperty in attrs[property]) {
993 // Break early if we already know we need new points from a previous option.
994 if (requiresNewPoints) {
995 break;
996 }
997 if (attrs[property].hasOwnProperty(subProperty) && !pixelSafeOptions[subProperty]) {
998 requiresNewPoints = true;
999 }
1000 }
1001 // If this was not a series specific option list, check if its a pixel changing property.
1002 } else if (!pixelSafeOptions[property]) {
1003 requiresNewPoints = true;
1004 }
1005 }
1006 }
1007
1008 return requiresNewPoints;
1009};
1010
1011/**
1012 * Compares two arrays to see if they are equal. If either parameter is not an
1013 * array it will return false. Does a shallow compare
1014 * Dygraph.compareArrays([[1,2], [3, 4]], [[1,2], [3,4]]) === false.
1015 * @param {!Array.<T>} array1 first array
1016 * @param {!Array.<T>} array2 second array
1017 * @return {boolean} True if both parameters are arrays, and contents are equal.
1018 * @template T
1019 */
1020Dygraph.compareArrays = function(array1, array2) {
1021 if (!Dygraph.isArrayLike(array1) || !Dygraph.isArrayLike(array2)) {
1022 return false;
1023 }
1024 if (array1.length !== array2.length) {
1025 return false;
1026 }
1027 for (var i = 0; i < array1.length; i++) {
1028 if (array1[i] !== array2[i]) {
1029 return false;
1030 }
1031 }
1032 return true;
1033};
1034
1035/**
1036 * @param {!CanvasRenderingContext2D} ctx the canvas context
1037 * @param {number} sides the number of sides in the shape.
1038 * @param {number} radius the radius of the image.
1039 * @param {number} cx center x coordate
1040 * @param {number} cy center y coordinate
1041 * @param {number=} rotationRadians the shift of the initial angle, in radians.
1042 * @param {number=} delta the angle shift for each line. If missing, creates a
1043 * regular polygon.
1044 * @private
1045 */
1046Dygraph.regularShape_ = function(
1047 ctx, sides, radius, cx, cy, rotationRadians, delta) {
1048 rotationRadians = rotationRadians || 0;
1049 delta = delta || Math.PI * 2 / sides;
1050
1051 ctx.beginPath();
1052 var initialAngle = rotationRadians;
1053 var angle = initialAngle;
1054
1055 var computeCoordinates = function() {
1056 var x = cx + (Math.sin(angle) * radius);
1057 var y = cy + (-Math.cos(angle) * radius);
1058 return [x, y];
1059 };
1060
1061 var initialCoordinates = computeCoordinates();
1062 var x = initialCoordinates[0];
1063 var y = initialCoordinates[1];
1064 ctx.moveTo(x, y);
1065
1066 for (var idx = 0; idx < sides; idx++) {
1067 angle = (idx == sides - 1) ? initialAngle : (angle + delta);
1068 var coords = computeCoordinates();
1069 ctx.lineTo(coords[0], coords[1]);
1070 }
1071 ctx.fill();
1072 ctx.stroke();
1073};
1074
1075/**
1076 * TODO(danvk): be more specific on the return type.
1077 * @param {number} sides
1078 * @param {number=} rotationRadians
1079 * @param {number=} delta
1080 * @return {Function}
1081 * @private
1082 */
1083Dygraph.shapeFunction_ = function(sides, rotationRadians, delta) {
1084 return function(g, name, ctx, cx, cy, color, radius) {
1085 ctx.strokeStyle = color;
1086 ctx.fillStyle = "white";
1087 Dygraph.regularShape_(ctx, sides, radius, cx, cy, rotationRadians, delta);
1088 };
1089};
1090
1091Dygraph.Circles = {
1092 DEFAULT : function(g, name, ctx, canvasx, canvasy, color, radius) {
1093 ctx.beginPath();
1094 ctx.fillStyle = color;
1095 ctx.arc(canvasx, canvasy, radius, 0, 2 * Math.PI, false);
1096 ctx.fill();
1097 },
1098 TRIANGLE : Dygraph.shapeFunction_(3),
1099 SQUARE : Dygraph.shapeFunction_(4, Math.PI / 4),
1100 DIAMOND : Dygraph.shapeFunction_(4),
1101 PENTAGON : Dygraph.shapeFunction_(5),
1102 HEXAGON : Dygraph.shapeFunction_(6),
1103 CIRCLE : function(g, name, ctx, cx, cy, color, radius) {
1104 ctx.beginPath();
1105 ctx.strokeStyle = color;
1106 ctx.fillStyle = "white";
1107 ctx.arc(cx, cy, radius, 0, 2 * Math.PI, false);
1108 ctx.fill();
1109 ctx.stroke();
1110 },
1111 STAR : Dygraph.shapeFunction_(5, 0, 4 * Math.PI / 5),
1112 PLUS : function(g, name, ctx, cx, cy, color, radius) {
1113 ctx.strokeStyle = color;
1114
1115 ctx.beginPath();
1116 ctx.moveTo(cx + radius, cy);
1117 ctx.lineTo(cx - radius, cy);
1118 ctx.closePath();
1119 ctx.stroke();
1120
1121 ctx.beginPath();
1122 ctx.moveTo(cx, cy + radius);
1123 ctx.lineTo(cx, cy - radius);
1124 ctx.closePath();
1125 ctx.stroke();
1126 },
1127 EX : function(g, name, ctx, cx, cy, color, radius) {
1128 ctx.strokeStyle = color;
1129
1130 ctx.beginPath();
1131 ctx.moveTo(cx + radius, cy + radius);
1132 ctx.lineTo(cx - radius, cy - radius);
1133 ctx.closePath();
1134 ctx.stroke();
1135
1136 ctx.beginPath();
1137 ctx.moveTo(cx + radius, cy - radius);
1138 ctx.lineTo(cx - radius, cy + radius);
1139 ctx.closePath();
1140 ctx.stroke();
1141 }
1142};
1143
1144/**
1145 * To create a "drag" interaction, you typically register a mousedown event
1146 * handler on the element where the drag begins. In that handler, you register a
1147 * mouseup handler on the window to determine when the mouse is released,
1148 * wherever that release happens. This works well, except when the user releases
1149 * the mouse over an off-domain iframe. In that case, the mouseup event is
1150 * handled by the iframe and never bubbles up to the window handler.
1151 *
1152 * To deal with this issue, we cover iframes with high z-index divs to make sure
1153 * they don't capture mouseup.
1154 *
1155 * Usage:
1156 * element.addEventListener('mousedown', function() {
1157 * var tarper = new Dygraph.IFrameTarp();
1158 * tarper.cover();
1159 * var mouseUpHandler = function() {
1160 * ...
1161 * window.removeEventListener(mouseUpHandler);
1162 * tarper.uncover();
1163 * };
1164 * window.addEventListener('mouseup', mouseUpHandler);
1165 * };
1166 *
1167 * @constructor
1168 */
1169Dygraph.IFrameTarp = function() {
1170 /** @type {Array.<!HTMLDivElement>} */
1171 this.tarps = [];
1172};
1173
1174/**
1175 * Find all the iframes in the document and cover them with high z-index
1176 * transparent divs.
1177 */
1178Dygraph.IFrameTarp.prototype.cover = function() {
1179 var iframes = document.getElementsByTagName("iframe");
1180 for (var i = 0; i < iframes.length; i++) {
1181 var iframe = iframes[i];
1182 var x = Dygraph.findPosX(iframe),
1183 y = Dygraph.findPosY(iframe),
1184 width = iframe.offsetWidth,
1185 height = iframe.offsetHeight;
1186
1187 var div = document.createElement("div");
1188 div.style.position = "absolute";
1189 div.style.left = x + 'px';
1190 div.style.top = y + 'px';
1191 div.style.width = width + 'px';
1192 div.style.height = height + 'px';
1193 div.style.zIndex = 999;
1194 document.body.appendChild(div);
1195 this.tarps.push(div);
1196 }
1197};
1198
1199/**
1200 * Remove all the iframe covers. You should call this in a mouseup handler.
1201 */
1202Dygraph.IFrameTarp.prototype.uncover = function() {
1203 for (var i = 0; i < this.tarps.length; i++) {
1204 this.tarps[i].parentNode.removeChild(this.tarps[i]);
1205 }
1206 this.tarps = [];
1207};
1208
1209/**
1210 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
1211 * @param {string} data
1212 * @return {?string} the delimiter that was detected (or null on failure).
1213 */
1214Dygraph.detectLineDelimiter = function(data) {
1215 for (var i = 0; i < data.length; i++) {
1216 var code = data.charAt(i);
1217 if (code === '\r') {
1218 // Might actually be "\r\n".
1219 if (((i + 1) < data.length) && (data.charAt(i + 1) === '\n')) {
1220 return '\r\n';
1221 }
1222 return code;
1223 }
1224 if (code === '\n') {
1225 // Might actually be "\n\r".
1226 if (((i + 1) < data.length) && (data.charAt(i + 1) === '\r')) {
1227 return '\n\r';
1228 }
1229 return code;
1230 }
1231 }
1232
1233 return null;
1234};
1235
1236/**
1237 * Is one node contained by another?
1238 * @param {Node} containee The contained node.
1239 * @param {Node} container The container node.
1240 * @return {boolean} Whether containee is inside (or equal to) container.
1241 * @private
1242 */
1243Dygraph.isNodeContainedBy = function(containee, container) {
1244 if (container === null || containee === null) {
1245 return false;
1246 }
1247 var containeeNode = /** @type {Node} */ (containee);
1248 while (containeeNode && containeeNode !== container) {
1249 containeeNode = containeeNode.parentNode;
1250 }
1251 return (containeeNode === container);
1252};
1253
1254
1255// This masks some numeric issues in older versions of Firefox,
1256// where 1.0/Math.pow(10,2) != Math.pow(10,-2).
1257/** @type {function(number,number):number} */
1258Dygraph.pow = function(base, exp) {
1259 if (exp < 0) {
1260 return 1.0 / Math.pow(base, -exp);
1261 }
1262 return Math.pow(base, exp);
1263};
1264
1265// For Dygraph.setDateSameTZ, below.
1266Dygraph.dateSetters = {
1267 ms: Date.prototype.setMilliseconds,
1268 s: Date.prototype.setSeconds,
1269 m: Date.prototype.setMinutes,
1270 h: Date.prototype.setHours
1271};
1272
1273/**
1274 * This is like calling d.setSeconds(), d.setMinutes(), etc, except that it
1275 * adjusts for time zone changes to keep the date/time parts consistent.
1276 *
1277 * For example, d.getSeconds(), d.getMinutes() and d.getHours() will all be
1278 * the same before/after you call setDateSameTZ(d, {ms: 0}). The same is not
1279 * true if you call d.setMilliseconds(0).
1280 *
1281 * @type {function(!Date, Object.<number>)}
1282 */
1283Dygraph.setDateSameTZ = function(d, parts) {
1284 var tz = d.getTimezoneOffset();
1285 for (var k in parts) {
1286 if (!parts.hasOwnProperty(k)) continue;
1287 var setter = Dygraph.dateSetters[k];
1288 if (!setter) throw "Invalid setter: " + k;
1289 setter.call(d, parts[k]);
1290 if (d.getTimezoneOffset() != tz) {
1291 d.setTime(d.getTime() + (tz - d.getTimezoneOffset()) * 60 * 1000);
1292 }
1293 }
1294};