3 * Copyright 2011 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
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.
14 /*jshint globalstrict: true */
15 /*global Dygraph:false, G_vmlCanvasManager:false, Node:false, printStackTrace: false */
18 Dygraph
.LOG_SCALE
= 10;
19 Dygraph
.LN_TEN
= Math
.log(Dygraph
.LOG_SCALE
);
26 Dygraph
.log10
= function(x
) {
27 return Math
.log(x
) / Dygraph
.LN_TEN
;
30 // Various logging levels.
36 // <REMOVE_FOR_COMBINED>
37 // Set this to log stack traces on warnings, etc.
38 // This requires stacktrace.js, which is up to you to provide.
39 // A copy can be found in the dygraphs repo, or at
40 // https://github.com/eriwen
/javascript
-stacktrace
41 Dygraph
.LOG_STACK_TRACES
= false;
42 // </REMOVE_FOR_COMBINED
>
44 /** A dotted line stroke pattern. */
45 Dygraph
.DOTTED_LINE
= [2, 2];
46 /** A dashed line stroke pattern. */
47 Dygraph
.DASHED_LINE
= [7, 3];
48 /** A dot dash stroke pattern. */
49 Dygraph
.DOT_DASH_LINE
= [7, 2, 2, 2];
52 * Log an error on the JS console at the given severity.
53 * @param {number} severity One of Dygraph.{DEBUG,INFO,WARNING,ERROR}
54 * @param {string} message The message to log.
57 Dygraph
.log
= function(severity
, message
) {
58 // <REMOVE_FOR_COMBINED>
60 if (typeof(printStackTrace
) != 'undefined') {
62 // Remove uninteresting bits: logging functions and paths.
63 st
= printStackTrace({guess
:false});
64 while (st
[0].indexOf("stacktrace") != -1) {
69 for (var i
= 0; i
< st
.length
; i
++) {
70 st
[i
] = st
[i
].replace(/\([^)]*\/(.*)\)/, '@$1')
71 .replace(/\@.*\/([^\/]*)/, '@$1')
72 .replace('[object Object].', '');
74 var top_msg
= st
.splice(0, 1)[0];
75 message
+= ' (' + top_msg
.replace(/^.*@ ?/, '') + ')';
77 // Oh well, it was worth a shot!
80 // </REMOVE_FOR_COMBINED
>
82 if (typeof(window
.console
) != 'undefined') {
83 // In older versions of Firefox, only console.log is defined.
84 var console
= window
.console
;
85 var log
= function(console
, method
, msg
) {
86 if (method
&& typeof(method
) == 'function') {
87 method
.call(console
, msg
);
95 log(console
, console
.debug
, 'dygraphs: ' + message
);
98 log(console
, console
.info
, 'dygraphs: ' + message
);
100 case Dygraph
.WARNING
:
101 log(console
, console
.warn
, 'dygraphs: ' + message
);
104 log(console
, console
.error
, 'dygraphs: ' + message
);
109 // <REMOVE_FOR_COMBINED>
110 if (Dygraph
.LOG_STACK_TRACES
) {
111 window
.console
.log(st
.join('\n'));
113 // </REMOVE_FOR_COMBINED
>
117 * @param {string} message
120 Dygraph
.info
= function(message
) {
121 Dygraph
.log(Dygraph
.INFO
, message
);
125 * @param {string} message
128 Dygraph
.warn
= function(message
) {
129 Dygraph
.log(Dygraph
.WARNING
, message
);
133 * @param {string} message
135 Dygraph
.error
= function(message
) {
136 Dygraph
.log(Dygraph
.ERROR
, message
);
140 * Return the 2d context for a dygraph canvas.
142 * This method is only exposed for the sake of replacing the function in
143 * automated tests, e.g.
145 * var oldFunc = Dygraph.getContext();
146 * Dygraph.getContext = function(canvas) {
147 * var realContext = oldFunc(canvas);
148 * return new Proxy(realContext);
150 * @param {!HTMLCanvasElement} canvas
151 * @return {!CanvasRenderingContext2D}
154 Dygraph
.getContext
= function(canvas
) {
155 return /** @type{!CanvasRenderingContext2D}*/(canvas
.getContext("2d"));
159 * Add an event handler. This smooths a difference between IE and the rest of
161 * @param {!Node} elem The element to add the event to.
162 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
163 * @param {function(Event):(boolean|undefined)} fn The function to call
164 * on the event. The function takes one parameter: the event object.
167 Dygraph
.addEvent
= function addEvent(elem
, type
, fn
) {
168 if (elem
.addEventListener
) {
169 elem
.addEventListener(type
, fn
, false);
171 elem
[type
+fn
] = function(){fn(window
.event
);};
172 elem
.attachEvent('on'+type
, elem
[type
+fn
]);
177 * Add an event handler. This event handler is kept until the graph is
178 * destroyed with a call to graph.destroy().
180 * @param {!Node} elem The element to add the event to.
181 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
182 * @param {function(Event):(boolean|undefined)} fn The function to call
183 * on the event. The function takes one parameter: the event object.
186 Dygraph
.prototype.addAndTrackEvent
= function(elem
, type
, fn
) {
187 Dygraph
.addEvent(elem
, type
, fn
);
188 this.registeredEvents_
.push({ elem
: elem
, type
: type
, fn
: fn
});
192 * Remove an event handler. This smooths a difference between IE and the rest
194 * @param {!Node} elem The element to remove the event from.
195 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
196 * @param {function(Event):(boolean|undefined)} fn The function to call
197 * on the event. The function takes one parameter: the event object.
200 Dygraph
.removeEvent
= function(elem
, type
, fn
) {
201 if (elem
.removeEventListener
) {
202 elem
.removeEventListener(type
, fn
, false);
205 elem
.detachEvent('on'+type
, elem
[type
+fn
]);
207 // We only detach event listeners on a "best effort" basis in IE. See:
208 // http://stackoverflow.com/questions
/2553632/detachevent-not
-working
-with-named
-inline
-functions
210 elem
[type
+fn
] = null;
214 Dygraph
.prototype.removeTrackedEvents_
= function() {
215 if (this.registeredEvents_
) {
216 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
217 var reg
= this.registeredEvents_
[idx
];
218 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
222 this.registeredEvents_
= [];
226 * Cancels further processing of an event. This is useful to prevent default
227 * browser actions, e.g. highlighting text on a double-click.
228 * Based on the article at
229 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
230 * @param {!Event} e The event whose normal behavior should be canceled.
233 Dygraph
.cancelEvent
= function(e
) {
234 e
= e
? e
: window
.event
;
235 if (e
.stopPropagation
) {
238 if (e
.preventDefault
) {
241 e
.cancelBubble
= true;
243 e
.returnValue
= false;
248 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
249 * is used to generate default series colors which are evenly spaced on the
251 * @param { number } hue Range is 0.0-1.0.
252 * @param { number } saturation Range is 0.0-1.0.
253 * @param { number } value Range is 0.0-1.0.
254 * @return { string } "rgb(r,g,b)" where r, g and b range from 0-255.
257 Dygraph
.hsvToRGB
= function (hue
, saturation
, value
) {
261 if (saturation
=== 0) {
266 var i
= Math
.floor(hue
* 6);
267 var f
= (hue
* 6) - i
;
268 var p
= value
* (1 - saturation
);
269 var q
= value
* (1 - (saturation
* f
));
270 var t
= value
* (1 - (saturation
* (1 - f
)));
272 case 1: red
= q
; green
= value
; blue
= p
; break;
273 case 2: red
= p
; green
= value
; blue
= t
; break;
274 case 3: red
= p
; green
= q
; blue
= value
; break;
275 case 4: red
= t
; green
= p
; blue
= value
; break;
276 case 5: red
= value
; green
= p
; blue
= q
; break;
277 case 6: // fall through
278 case 0: red
= value
; green
= t
; blue
= p
; break;
281 red
= Math
.floor(255 * red
+ 0.5);
282 green
= Math
.floor(255 * green
+ 0.5);
283 blue
= Math
.floor(255 * blue
+ 0.5);
284 return 'rgb(' + red
+ ',' + green
+ ',' + blue
+ ')';
287 // The following functions are from quirksmode.org with a modification for Safari from
288 // http://blog.firetree.net/2005/07/04/javascript-find-position/
289 // http://www.quirksmode.org/js
/findpos
.html
290 // ... and modifications to support scrolling divs.
293 * Find the coordinates of an object relative to the top left of the page.
295 * TODO(danvk): change obj type from Node -> !Node
297 * @return {{x:number,y:number}}
300 Dygraph
.findPos
= function(obj
) {
301 var curleft
= 0, curtop
= 0;
302 if (obj
.offsetParent
) {
305 // NOTE: the if statement here is for IE8.
306 var borderLeft
= "0", borderTop
= "0";
307 if (window
.getComputedStyle
) {
308 var computedStyle
= window
.getComputedStyle(copyObj
, null);
309 borderLeft
= computedStyle
.borderLeft
|| "0";
310 borderTop
= computedStyle
.borderTop
|| "0";
312 curleft
+= parseInt(borderLeft
, 10) ;
313 curtop
+= parseInt(borderTop
, 10) ;
314 curleft
+= copyObj
.offsetLeft
;
315 curtop
+= copyObj
.offsetTop
;
316 if (!copyObj
.offsetParent
) {
319 copyObj
= copyObj
.offsetParent
;
322 // TODO(danvk): why would obj ever have these properties?
323 if (obj
.x
) curleft
+= obj
.x
;
324 if (obj
.y
) curtop
+= obj
.y
;
327 // This handles the case where the object is inside a scrolled div.
328 while (obj
&& obj
!= document
.body
) {
329 curleft
-= obj
.scrollLeft
;
330 curtop
-= obj
.scrollTop
;
331 obj
= obj
.parentNode
;
333 return {x
: curleft
, y
: curtop
};
337 * Returns the x-coordinate of the event in a coordinate system where the
338 * top-left corner of the page (not the window) is (0,0).
339 * Taken from MochiKit.Signal
344 Dygraph
.pageX
= function(e
) {
346 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
348 var de
= document
.documentElement
;
349 var b
= document
.body
;
351 (de
.scrollLeft
|| b
.scrollLeft
) -
352 (de
.clientLeft
|| 0);
357 * Returns the y-coordinate of the event in a coordinate system where the
358 * top-left corner of the page (not the window) is (0,0).
359 * Taken from MochiKit.Signal
364 Dygraph
.pageY
= function(e
) {
366 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
368 var de
= document
.documentElement
;
369 var b
= document
.body
;
371 (de
.scrollTop
|| b
.scrollTop
) -
377 * Converts page the x-coordinate of the event to pixel x-coordinates on the
378 * canvas (i.e. DOM Coords).
379 * @param {!Event} e Drag event.
380 * @param {!DygraphInteractionContext} context Interaction context object.
381 * @return {number} The amount by which the drag has moved to the right.
383 Dygraph
.dragGetX_
= function(e
, context
) {
384 return Dygraph
.pageX(e
) - context
.px
;
388 * Converts page the y-coordinate of the event to pixel y-coordinates on the
389 * canvas (i.e. DOM Coords).
390 * @param {!Event} e Drag event.
391 * @param {!DygraphInteractionContext} context Interaction context object.
392 * @return {number} The amount by which the drag has moved down.
394 Dygraph
.dragGetY_
= function(e
, context
) {
395 return Dygraph
.pageY(e
) - context
.py
;
399 * This returns true unless the parameter is 0, null, undefined or NaN.
400 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
402 * @param {number} x The number to consider.
403 * @return {boolean} Whether the number is zero or NaN.
406 Dygraph
.isOK
= function(x
) {
407 return !!x
&& !isNaN(x
);
411 * @param {{x:?number,y:?number,yval:?number}} p The point to consider, valid
412 * points are {x, y} objects
413 * @param {boolean=} opt_allowNaNY Treat point with y=NaN as valid
414 * @return {boolean} Whether the point has numeric x and y.
417 Dygraph
.isValidPoint
= function(p
, opt_allowNaNY
) {
418 if (!p
) return false; // null or undefined object
419 if (p
.yval
=== null) return false; // missing point
420 if (p
.x
=== null || p
.x
=== undefined
) return false;
421 if (p
.y
=== null || p
.y
=== undefined
) return false;
422 if (isNaN(p
.x
) || (!opt_allowNaNY
&& isNaN(p
.y
))) return false;
427 * Number formatting function which mimicks the behavior of %g in printf, i.e.
428 * either exponential or fixed format (without trailing 0s) is used depending on
429 * the length of the generated string. The advantage of this format is that
430 * there is a predictable upper bound on the resulting string length,
431 * significant figures are not dropped, and normal numbers are not displayed in
432 * exponential notation.
434 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
435 * It creates strings which are too long for absolute values between 10^-4 and
436 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
439 * @param {number} x The number to format
440 * @param {number=} opt_precision The precision to use, default 2.
441 * @return {string} A string formatted like %g in printf. The max generated
442 * string length should be precision + 6 (e.g 1.123e+300).
444 Dygraph
.floatFormat
= function(x
, opt_precision
) {
445 // Avoid invalid precision values; [1, 21] is the valid range.
446 var p
= Math
.min(Math
.max(1, opt_precision
|| 2), 21);
448 // This is deceptively simple. The actual algorithm comes from:
450 // Max allowed length = p + 4
451 // where 4 comes from 'e+n' and '.'.
453 // Length of fixed format = 2 + y + p
454 // where 2 comes from '0.' and y = # of leading zeroes.
456 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
459 // Since the behavior of toPrecision() is identical for larger numbers, we
460 // don't have to worry about the other bound.
462 // Finally, the argument for toExponential() is the number of trailing digits,
463 // so we take off 1 for the value before the '.'.
464 return (Math
.abs(x
) < 1.0e-3 && x
!== 0.0) ?
465 x
.toExponential(p
- 1) : x
.toPrecision(p
);
469 * Converts '9' to '09' (useful for dates)
474 Dygraph
.zeropad
= function(x
) {
475 if (x
< 10) return "0" + x
; else return "" + x
;
479 * Return a string version of the hours, minutes and seconds portion of a date.
481 * @param {number} date The JavaScript date (ms since epoch)
482 * @return {string} A time of the form "HH:MM:SS"
485 Dygraph
.hmsString_
= function(date
) {
486 var zeropad
= Dygraph
.zeropad
;
487 var d
= new Date(date
);
488 if (d
.getSeconds()) {
489 return zeropad(d
.getHours()) + ":" +
490 zeropad(d
.getMinutes()) + ":" +
491 zeropad(d
.getSeconds());
493 return zeropad(d
.getHours()) + ":" + zeropad(d
.getMinutes());
498 * Convert a JS date (millis since epoch) to YYYY/MM/DD
499 * @param {number} date The JavaScript date (ms since epoch)
500 * @return {string} A date of the form "YYYY/MM/DD"
503 Dygraph
.dateString_
= function(date
) {
504 var zeropad
= Dygraph
.zeropad
;
505 var d
= new Date(date
);
508 var year
= "" + d
.getFullYear();
509 // Get a 0 padded month string
510 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
511 // Get a 0 padded day string
512 var day
= zeropad(d
.getDate());
515 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
516 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
518 return year
+ "/" + month + "/" + day
+ ret
;
522 * Round a number to the specified number of digits past the decimal point.
523 * @param {number} num The number to round
524 * @param {number} places The number of decimals to which to round
525 * @return {number} The rounded number
528 Dygraph
.round_
= function(num
, places
) {
529 var shift
= Math
.pow(10, places
);
530 return Math
.round(num
* shift
)/shift
;
534 * Implementation of binary search over an array.
535 * Currently does not work when val is outside the range of arry's values.
536 * @param {number} val the value to search for
537 * @param {Array.<number>} arry is the value over which to search
538 * @param {number} abs If abs > 0, find the lowest entry greater than val
539 * If abs < 0, find the highest entry less than val.
540 * If abs == 0, find the entry that equals val.
541 * @param {number=} low The first index in arry to consider (optional)
542 * @param {number=} high The last index in arry to consider (optional)
543 * @return {number} Index of the element, or -1 if it isn't found.
546 Dygraph
.binarySearch
= function(val
, arry
, abs
, low
, high
) {
547 if (low
=== null || low
=== undefined
||
548 high
=== null || high
=== undefined
) {
550 high
= arry
.length
- 1;
555 if (abs
=== null || abs
=== undefined
) {
558 var validIndex
= function(idx
) {
559 return idx
>= 0 && idx
< arry
.length
;
561 var mid
= parseInt((low
+ high
) / 2, 10);
562 var element
= arry
[mid
];
564 if (element
== val
) {
566 } else if (element
> val
) {
568 // Accept if element > val, but also if prior element < val.
570 if (validIndex(idx
) && arry
[idx
] < val
) {
574 return Dygraph
.binarySearch(val
, arry
, abs
, low
, mid
- 1);
575 } else if (element
< val
) {
577 // Accept if element < val, but also if prior element > val.
579 if (validIndex(idx
) && arry
[idx
] > val
) {
583 return Dygraph
.binarySearch(val
, arry
, abs
, mid
+ 1, high
);
585 return -1; // can't actually happen, but makes closure compiler happy
589 * Parses a date, returning the number of milliseconds since epoch. This can be
590 * passed in as an xValueParser in the Dygraph constructor.
591 * TODO(danvk): enumerate formats that this understands.
593 * @param {string} dateStr A date in a variety of possible string formats.
594 * @return {number} Milliseconds since epoch.
597 Dygraph
.dateParser
= function(dateStr
) {
601 // Let the system try the format first, with one caveat:
602 // YYYY-MM-DD[ HH:MM:SS] is interpreted as UTC by a variety of browsers.
603 // dygraphs displays dates in local time, so this will result in surprising
604 // inconsistencies. But if you specify "T" or "Z" (i.e. YYYY-MM-DDTHH:MM:SS),
605 // then you probably know what you're doing, so we'll let you go ahead.
606 // Issue: http://code.google.com/p/dygraphs/issues/detail
?id
=255
607 if (dateStr
.search("-") == -1 ||
608 dateStr
.search("T") != -1 || dateStr
.search("Z") != -1) {
609 d
= Dygraph
.dateStrToMillis(dateStr
);
610 if (d
&& !isNaN(d
)) return d
;
613 if (dateStr
.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
614 dateStrSlashed
= dateStr
.replace("-", "/", "g");
615 while (dateStrSlashed
.search("-") != -1) {
616 dateStrSlashed
= dateStrSlashed
.replace("-", "/");
618 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
619 } else if (dateStr
.length
== 8) { // e.g. '20090712'
620 // TODO(danvk): remove support for this format. It's confusing.
621 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
623 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
625 // Any format that Date.parse will accept, e.g. "2009/07/12" or
626 // "2009/07/12 12:34:56"
627 d
= Dygraph
.dateStrToMillis(dateStr
);
630 if (!d
|| isNaN(d
)) {
631 Dygraph
.error("Couldn't parse " + dateStr
+ " as a date");
637 * This is identical to JavaScript's built-in Date.parse() method, except that
638 * it doesn't get replaced with an incompatible method by aggressive JS
639 * libraries like MooTools or Joomla.
640 * @param {string} str The date string, e.g. "2011/05/06"
641 * @return {number} millis since epoch
644 Dygraph
.dateStrToMillis
= function(str
) {
645 return new Date(str
).getTime();
648 // These functions are all based on MochiKit.
650 * Copies all the properties from o to self.
652 * @param {!Object} self
656 Dygraph
.update
= function(self
, o
) {
657 if (typeof(o
) != 'undefined' && o
!== null) {
659 if (o
.hasOwnProperty(k
)) {
668 * Copies all the properties from o to self.
670 * @param {!Object} self
675 Dygraph
.updateDeep
= function (self
, o
) {
676 // Taken from http://stackoverflow.com/questions
/384286/javascript
-isdom
-how
-do-you
-check
-if-a
-javascript
-object
-is
-a
-dom
-object
679 typeof Node
=== "object" ? o
instanceof Node
:
680 typeof o
=== "object" && typeof o
.nodeType
=== "number" && typeof o
.nodeName
==="string"
684 if (typeof(o
) != 'undefined' && o
!== null) {
686 if (o
.hasOwnProperty(k
)) {
689 } else if (Dygraph
.isArrayLike(o
[k
])) {
690 self
[k
] = o
[k
].slice();
691 } else if (isNode(o
[k
])) {
692 // DOM objects are shallowly-copied.
694 } else if (typeof(o
[k
]) == 'object') {
695 if (typeof(self
[k
]) != 'object' || self
[k
] === null) {
698 Dygraph
.updateDeep(self
[k
], o
[k
]);
713 Dygraph
.isArrayLike
= function(o
) {
716 (typ
!= 'object' && !(typ
== 'function' &&
717 typeof(o
.item
) == 'function')) ||
719 typeof(o
.length
) != 'number' ||
732 Dygraph
.isDateLike
= function (o
) {
733 if (typeof(o
) != "object" || o
=== null ||
734 typeof(o
.getTime
) != 'function') {
741 * Note: this only seems to work for arrays.
746 Dygraph
.clone
= function(o
) {
747 // TODO(danvk): figure out how MochiKit's version works
749 for (var i
= 0; i
< o
.length
; i
++) {
750 if (Dygraph
.isArrayLike(o
[i
])) {
751 r
.push(Dygraph
.clone(o
[i
]));
760 * Create a new canvas element. This is more complex than a simple
761 * document.createElement("canvas") because of IE and excanvas.
763 * @return {!HTMLCanvasElement}
766 Dygraph
.createCanvas
= function() {
767 var canvas
= document
.createElement("canvas");
769 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
770 if (isIE
&& (typeof(G_vmlCanvasManager
) != 'undefined')) {
771 canvas
= G_vmlCanvasManager
.initElement(
772 /**@type{!HTMLCanvasElement}*/(canvas
));
779 * Returns the context's pixel ratio, which is the ratio between the device
780 * pixel ratio and the backing store ratio. Typically this is 1 for conventional
781 * displays, and > 1 for HiDPI displays (such as the Retina MBP).
782 * See http://www.html5rocks.com/en/tutorials/canvas/hidpi/ for more details.
784 * @param {!CanvasRenderingContext2D} context The canvas's 2d context.
785 * @return {number} The ratio of the device pixel ratio and the backing store
786 * ratio for the specified context.
788 Dygraph
.getContextPixelRatio
= function(context
) {
790 var devicePixelRatio
= window
.devicePixelRatio
;
791 var backingStoreRatio
= context
.webkitBackingStorePixelRatio
||
792 context
.mozBackingStorePixelRatio
||
793 context
.msBackingStorePixelRatio
||
794 context
.oBackingStorePixelRatio
||
795 context
.backingStorePixelRatio
;
796 if (devicePixelRatio
!== undefined
&&
797 backingStorePixelRatio
!== undefined
) {
798 return devicePixelRatio
/ backingStoreRatio
;
800 // If either value is undefined, the ratio is meaningless so we want to
810 * Checks whether the user is on an Android browser.
811 * Android does not fully support the <canvas> tag, e.g. w/r/t/ clipping.
815 Dygraph
.isAndroid
= function() {
816 return (/Android/).test(navigator
.userAgent
);
821 * TODO(danvk): use @template here when it's better supported for classes.
822 * @param {!Array} array
823 * @param {number} start
824 * @param {number} length
825 * @param {function(!Array,?):boolean=} predicate
828 Dygraph
.Iterator
= function(array
, start
, length
, predicate
) {
830 length
= length
|| array
.length
;
831 this.hasNext
= true; // Use to identify if there's another element.
832 this.peek
= null; // Use for look-ahead
835 this.predicate_
= predicate
;
836 this.end_
= Math
.min(array
.length
, start
+ length
);
837 this.nextIdx_
= start
- 1; // use -1 so initial advance works.
838 this.next(); // ignoring result.
844 Dygraph
.Iterator
.prototype.next
= function() {
850 var nextIdx
= this.nextIdx_
+ 1;
852 while (nextIdx
< this.end_
) {
853 if (!this.predicate_
|| this.predicate_(this.array_
, nextIdx
)) {
854 this.peek
= this.array_
[nextIdx
];
860 this.nextIdx_
= nextIdx
;
862 this.hasNext
= false;
869 * Returns a new iterator over array, between indexes start and
870 * start + length, and only returns entries that pass the accept function
872 * @param {!Array} array the array to iterate over.
873 * @param {number} start the first index to iterate over, 0 if absent.
874 * @param {number} length the number of elements in the array to iterate over.
875 * This, along with start, defines a slice of the array, and so length
876 * doesn't imply the number of elements in the iterator when accept doesn't
877 * always accept all values. array.length when absent.
878 * @param {function(?):boolean=} opt_predicate a function that takes
879 * parameters array and idx, which returns true when the element should be
880 * returned. If omitted, all elements are accepted.
883 Dygraph
.createIterator
= function(array
, start
, length
, opt_predicate
) {
884 return new Dygraph
.Iterator(array
, start
, length
, opt_predicate
);
887 // Shim layer with setTimeout fallback.
888 // From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
889 // Should be called with the window context:
890 // Dygraph.requestAnimFrame.call(window, function() {})
891 Dygraph
.requestAnimFrame
= (function() {
892 return window
.requestAnimationFrame
||
893 window
.webkitRequestAnimationFrame
||
894 window
.mozRequestAnimationFrame
||
895 window
.oRequestAnimationFrame
||
896 window
.msRequestAnimationFrame
||
897 function (callback
) {
898 window
.setTimeout(callback
, 1000 / 60);
903 * Call a function at most maxFrames times at an attempted interval of
904 * framePeriodInMillis, then call a cleanup function once. repeatFn is called
905 * once immediately, then at most (maxFrames - 1) times asynchronously. If
906 * maxFrames==1, then cleanup_fn() is also called synchronously. This function
907 * is used to sequence animation.
908 * @param {function(number)} repeatFn Called repeatedly -- takes the frame
909 * number (from 0 to maxFrames-1) as an argument.
910 * @param {number} maxFrames The max number of times to call repeatFn
911 * @param {number} framePeriodInMillis Max requested time between frames.
912 * @param {function()} cleanupFn A function to call after all repeatFn calls.
915 Dygraph
.repeatAndCleanup
= function(repeatFn
, maxFrames
, framePeriodInMillis
,
918 var previousFrameNumber
;
919 var startTime
= new Date().getTime();
920 repeatFn(frameNumber
);
921 if (maxFrames
== 1) {
925 var maxFrameArg
= maxFrames
- 1;
928 if (frameNumber
>= maxFrames
) return;
929 Dygraph
.requestAnimFrame
.call(window
, function() {
930 // Determine which frame to draw based on the delay so far. Will skip
931 // frames if necessary.
932 var currentTime
= new Date().getTime();
933 var delayInMillis
= currentTime
- startTime
;
934 previousFrameNumber
= frameNumber
;
935 frameNumber
= Math
.floor(delayInMillis
/ framePeriodInMillis
);
936 var frameDelta
= frameNumber
- previousFrameNumber
;
937 // If we predict that the subsequent repeatFn call will overshoot our
938 // total frame target, so our last call will cause a stutter, then jump to
939 // the last call immediately. If we're going to cause a stutter, better
940 // to do it faster than slower.
941 var predictOvershootStutter
= (frameNumber
+ frameDelta
) > maxFrameArg
;
942 if (predictOvershootStutter
|| (frameNumber
>= maxFrameArg
)) {
943 repeatFn(maxFrameArg
); // Ensure final call with maxFrameArg.
946 if (frameDelta
!== 0) { // Don't call repeatFn with duplicate frames.
947 repeatFn(frameNumber
);
956 * This function will scan the option list and determine if they
957 * require us to recalculate the pixel positions of each point.
958 * @param {!Array.<string>} labels a list of options to check.
959 * @param {!Object} attrs
960 * @return {boolean} true if the graph needs new points else false.
963 Dygraph
.isPixelChangingOptionList
= function(labels
, attrs
) {
964 // A whitelist of options that do not change pixel positions.
965 var pixelSafeOptions
= {
966 'annotationClickHandler': true,
967 'annotationDblClickHandler': true,
968 'annotationMouseOutHandler': true,
969 'annotationMouseOverHandler': true,
970 'axisLabelColor': true,
971 'axisLineColor': true,
972 'axisLineWidth': true,
973 'clickCallback': true,
974 'digitsAfterDecimal': true,
975 'drawCallback': true,
976 'drawHighlightPointCallback': true,
978 'drawPointCallback': true,
982 'gridLineColor': true,
983 'gridLineWidth': true,
984 'hideOverlayOnMouseOut': true,
985 'highlightCallback': true,
986 'highlightCircleSize': true,
987 'interactionModel': true,
988 'isZoomedIgnoreProgrammaticZoom': true,
990 'labelsDivStyles': true,
991 'labelsDivWidth': true,
994 'labelsSeparateLines': true,
995 'labelsShowZeroValues': true,
997 'maxNumberWidth': true,
998 'panEdgeFraction': true,
999 'pixelsPerYLabel': true,
1000 'pointClickCallback': true,
1002 'rangeSelectorPlotFillColor': true,
1003 'rangeSelectorPlotStrokeColor': true,
1004 'showLabelsOnHighlight': true,
1007 'strokeWidth': true,
1008 'underlayCallback': true,
1009 'unhighlightCallback': true,
1010 'xAxisLabelFormatter': true,
1012 'xValueFormatter': true,
1013 'yAxisLabelFormatter': true,
1014 'yValueFormatter': true,
1015 'zoomCallback': true
1018 // Assume that we do not require new points.
1019 // This will change to true if we actually do need new points.
1020 var requiresNewPoints
= false;
1022 // Create a dictionary of series names for faster lookup.
1023 // If there are no labels, then the dictionary stays empty.
1024 var seriesNamesDictionary
= { };
1026 for (var i
= 1; i
< labels
.length
; i
++) {
1027 seriesNamesDictionary
[labels
[i
]] = true;
1031 // Iterate through the list of updated options.
1032 for (var property
in attrs
) {
1033 // Break early if we already know we need new points from a previous option.
1034 if (requiresNewPoints
) {
1037 if (attrs
.hasOwnProperty(property
)) {
1038 // Find out of this field is actually a series specific options list.
1039 if (seriesNamesDictionary
[property
]) {
1040 // This property value is a list of options for this series.
1041 // If any of these sub properties are not pixel safe, set the flag.
1042 for (var subProperty
in attrs
[property
]) {
1043 // Break early if we already know we need new points from a previous option.
1044 if (requiresNewPoints
) {
1047 if (attrs
[property
].hasOwnProperty(subProperty
) && !pixelSafeOptions
[subProperty
]) {
1048 requiresNewPoints
= true;
1051 // If this was not a series specific option list, check if its a pixel changing property.
1052 } else if (!pixelSafeOptions
[property
]) {
1053 requiresNewPoints
= true;
1058 return requiresNewPoints
;
1062 DEFAULT
: function(g
, name
, ctx
, canvasx
, canvasy
, color
, radius
) {
1064 ctx
.fillStyle
= color
;
1065 ctx
.arc(canvasx
, canvasy
, radius
, 0, 2 * Math
.PI
, false);
1068 // For more shapes, include extras/shapes.js
1072 * To create a "drag" interaction, you typically register a mousedown event
1073 * handler on the element where the drag begins. In that handler, you register a
1074 * mouseup handler on the window to determine when the mouse is released,
1075 * wherever that release happens. This works well, except when the user releases
1076 * the mouse over an off-domain iframe. In that case, the mouseup event is
1077 * handled by the iframe and never bubbles up to the window handler.
1079 * To deal with this issue, we cover iframes with high z-index divs to make sure
1080 * they don't capture mouseup.
1083 * element.addEventListener('mousedown', function() {
1084 * var tarper = new Dygraph.IFrameTarp();
1086 * var mouseUpHandler = function() {
1088 * window.removeEventListener(mouseUpHandler);
1091 * window.addEventListener('mouseup', mouseUpHandler);
1096 Dygraph
.IFrameTarp
= function() {
1097 /** @type {Array.<!HTMLDivElement>} */
1102 * Find all the iframes in the document and cover them with high z-index
1105 Dygraph
.IFrameTarp
.prototype.cover
= function() {
1106 var iframes
= document
.getElementsByTagName("iframe");
1107 for (var i
= 0; i
< iframes
.length
; i
++) {
1108 var iframe
= iframes
[i
];
1109 var pos
= Dygraph
.findPos(iframe
),
1112 width
= iframe
.offsetWidth
,
1113 height
= iframe
.offsetHeight
;
1115 var div
= document
.createElement("div");
1116 div
.style
.position
= "absolute";
1117 div
.style
.left
= x
+ 'px';
1118 div
.style
.top
= y
+ 'px';
1119 div
.style
.width
= width
+ 'px';
1120 div
.style
.height
= height
+ 'px';
1121 div
.style
.zIndex
= 999;
1122 document
.body
.appendChild(div
);
1123 this.tarps
.push(div
);
1128 * Remove all the iframe covers. You should call this in a mouseup handler.
1130 Dygraph
.IFrameTarp
.prototype.uncover
= function() {
1131 for (var i
= 0; i
< this.tarps
.length
; i
++) {
1132 this.tarps
[i
].parentNode
.removeChild(this.tarps
[i
]);
1138 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
1139 * @param {string} data
1140 * @return {?string} the delimiter that was detected (or null on failure).
1142 Dygraph
.detectLineDelimiter
= function(data
) {
1143 for (var i
= 0; i
< data
.length
; i
++) {
1144 var code
= data
.charAt(i
);
1145 if (code
=== '\r') {
1146 // Might actually be "\r\n".
1147 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\n')) {
1152 if (code
=== '\n') {
1153 // Might actually be "\n\r".
1154 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\r')) {
1165 * Is one node contained by another?
1166 * @param {Node} containee The contained node.
1167 * @param {Node} container The container node.
1168 * @return {boolean} Whether containee is inside (or equal to) container.
1171 Dygraph
.isNodeContainedBy
= function(containee
, container
) {
1172 if (container
=== null || containee
=== null) {
1175 var containeeNode
= /** @type {Node} */ (containee
);
1176 while (containeeNode
&& containeeNode
!== container
) {
1177 containeeNode
= containeeNode
.parentNode
;
1179 return (containeeNode
=== container
);
1183 // This masks some numeric issues in older versions of Firefox,
1184 // where 1.0/Math
.pow(10,2) != Math
.pow(10,-2).
1185 /** @type {function(number,number):number} */
1186 Dygraph
.pow
= function(base
, exp
) {
1188 return 1.0 / Math
.pow(base
, -exp
);
1190 return Math
.pow(base
, exp
);
1193 // For Dygraph.setDateSameTZ, below.
1194 Dygraph
.dateSetters
= {
1195 ms
: Date
.prototype.setMilliseconds
,
1196 s
: Date
.prototype.setSeconds
,
1197 m
: Date
.prototype.setMinutes
,
1198 h
: Date
.prototype.setHours
1202 * This is like calling d.setSeconds(), d.setMinutes(), etc, except that it
1203 * adjusts for time zone changes to keep the date/time parts consistent.
1205 * For example, d.getSeconds(), d.getMinutes() and d.getHours() will all be
1206 * the same before/after you call setDateSameTZ(d, {ms: 0}). The same is not
1207 * true if you call d.setMilliseconds(0).
1209 * @type {function(!Date, Object.<number>)}
1211 Dygraph
.setDateSameTZ
= function(d
, parts
) {
1212 var tz
= d
.getTimezoneOffset();
1213 for (var k
in parts
) {
1214 if (!parts
.hasOwnProperty(k
)) continue;
1215 var setter
= Dygraph
.dateSetters
[k
];
1216 if (!setter
) throw "Invalid setter: " + k
;
1217 setter
.call(d
, parts
[k
]);
1218 if (d
.getTimezoneOffset() != tz
) {
1219 d
.setTime(d
.getTime() + (tz
- d
.getTimezoneOffset()) * 60 * 1000);
1225 * Converts any valid CSS color (hex, rgb(), named color) to an RGB tuple.
1227 * @param {!string} colorStr Any valid CSS color string.
1228 * @return {{r:number,g:number,b:number}} Parsed RGB tuple.
1231 Dygraph
.toRGB_
= function(colorStr
) {
1232 // TODO(danvk): cache color parses to avoid repeated DOM manipulation.
1233 var div
= document
.createElement('div');
1234 div
.style
.backgroundColor
= colorStr
;
1235 div
.style
.visibility
= 'hidden';
1236 document
.body
.appendChild(div
);
1237 var rgbStr
= window
.getComputedStyle(div
, null).backgroundColor
;
1238 document
.body
.removeChild(div
);
1239 var bits
= /^rgb\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)$/.exec(rgbStr
);
1241 r
: parseInt(bits
[1], 10),
1242 g
: parseInt(bits
[2], 10),
1243 b
: parseInt(bits
[3], 10)
1248 * Checks whether the browser supports the <canvas> tag.
1249 * @param {HTMLCanvasElement=} opt_canvasElement Pass a canvas element as an
1250 * optimization if you have one.
1251 * @return {boolean} Whether the browser supports canvas.
1253 Dygraph
.isCanvasSupported
= function(opt_canvasElement
) {
1256 canvas
= opt_canvasElement
|| document
.createElement("canvas");
1257 canvas
.getContext("2d");
1260 var ie
= navigator
.appVersion
.match(/MSIE (\d\.\d)/);
1261 var opera
= (navigator
.userAgent
.toLowerCase().indexOf("opera") != -1);
1262 if ((!ie
) || (ie
[1] < 6) || (opera
))
1270 * Parses the value as a floating point number. This is like the parseFloat()
1271 * built-in, but with a few differences:
1272 * - the empty string is parsed as null, rather than NaN.
1273 * - if the string cannot be parsed at all, an error is logged.
1274 * If the string can't be parsed, this method returns null.
1275 * @param {string} x The string to be parsed
1276 * @param {number=} opt_line_no The line number from which the string comes.
1277 * @param {string=} opt_line The text of the line from which the string comes.
1279 Dygraph
.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
1280 var val
= parseFloat(x
);
1281 if (!isNaN(val
)) return val
;
1283 // Try to figure out what happeend.
1284 // If the value is the empty string, parse it as null.
1285 if (/^ *$/.test(x
)) return null;
1287 // If it was actually "NaN", return it as NaN.
1288 if (/^ *nan *$/i.test(x
)) return NaN
;
1290 // Looks like a parsing error.
1291 var msg
= "Unable to parse '" + x
+ "' as a number";
1292 if (opt_line
!== undefined
&& opt_line_no
!== undefined
) {
1293 msg
+= " on line " + (1+(opt_line_no
||0)) + " ('" + opt_line
+ "') of CSV.";