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 // 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
40 Dygraph
.LOG_STACK_TRACES
= false;
42 /** A dotted line stroke pattern. */
43 Dygraph
.DOTTED_LINE
= [2, 2];
44 /** A dashed line stroke pattern. */
45 Dygraph
.DASHED_LINE
= [7, 3];
46 /** A dot dash stroke pattern. */
47 Dygraph
.DOT_DASH_LINE
= [7, 2, 2, 2];
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.
55 Dygraph
.log
= function(severity
, message
) {
57 if (typeof(printStackTrace
) != 'undefined') {
59 // Remove uninteresting bits: logging functions and paths.
60 st
= printStackTrace({guess
:false});
61 while (st
[0].indexOf("stacktrace") != -1) {
66 for (var i
= 0; i
< st
.length
; i
++) {
67 st
[i
] = st
[i
].replace(/\([^)]*\/(.*)\)/, '@$1')
68 .replace(/\@.*\/([^\/]*)/, '@$1')
69 .replace('[object Object].', '');
71 var top_msg
= st
.splice(0, 1)[0];
72 message
+= ' (' + top_msg
.replace(/^.*@ ?/, '') + ')';
74 // Oh well, it was worth a shot!
78 if (typeof(window
.console
) != 'undefined') {
81 window
.console
.debug('dygraphs: ' + message
);
84 window
.console
.info('dygraphs: ' + message
);
87 window
.console
.warn('dygraphs: ' + message
);
90 window
.console
.error('dygraphs: ' + message
);
95 if (Dygraph
.LOG_STACK_TRACES
) {
96 window
.console
.log(st
.join('\n'));
101 * @param {string} message
104 Dygraph
.info
= function(message
) {
105 Dygraph
.log(Dygraph
.INFO
, message
);
108 * @param {string} message
111 Dygraph
.prototype.info
= Dygraph
.info
;
114 * @param {string} message
117 Dygraph
.warn
= function(message
) {
118 Dygraph
.log(Dygraph
.WARNING
, message
);
121 * @param {string} message
124 Dygraph
.prototype.warn
= Dygraph
.warn
;
127 * @param {string} message
130 Dygraph
.error
= function(message
) {
131 Dygraph
.log(Dygraph
.ERROR
, message
);
134 * @param {string} message
137 Dygraph
.prototype.error
= Dygraph
.error
;
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 { !Element } 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 { !Element } 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.addEvent
= function addEvent(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 {!Element} elem The element to add the event to.
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 addEvent(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;
215 * Cancels further processing of an event. This is useful to prevent default
216 * browser actions, e.g. highlighting text on a double-click.
217 * Based on the article at
218 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
219 * @param { !Event } e The event whose normal behavior should be canceled.
222 Dygraph
.cancelEvent
= function(e
) {
223 e
= e
? e
: window
.event
;
224 if (e
.stopPropagation
) {
227 if (e
.preventDefault
) {
230 e
.cancelBubble
= true;
232 e
.returnValue
= false;
237 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
238 * is used to generate default series colors which are evenly spaced on the
240 * @param { number } hue Range is 0.0-1.0.
241 * @param { number } saturation Range is 0.0-1.0.
242 * @param { number } value Range is 0.0-1.0.
243 * @return { string } "rgb(r,g,b)" where r, g and b range from 0-255.
246 Dygraph
.hsvToRGB
= function (hue
, saturation
, value
) {
250 if (saturation
=== 0) {
255 var i
= Math
.floor(hue
* 6);
256 var f
= (hue
* 6) - i
;
257 var p
= value
* (1 - saturation
);
258 var q
= value
* (1 - (saturation
* f
));
259 var t
= value
* (1 - (saturation
* (1 - f
)));
261 case 1: red
= q
; green
= value
; blue
= p
; break;
262 case 2: red
= p
; green
= value
; blue
= t
; break;
263 case 3: red
= p
; green
= q
; blue
= value
; break;
264 case 4: red
= t
; green
= p
; blue
= value
; break;
265 case 5: red
= value
; green
= p
; blue
= q
; break;
266 case 6: // fall through
267 case 0: red
= value
; green
= t
; blue
= p
; break;
270 red
= Math
.floor(255 * red
+ 0.5);
271 green
= Math
.floor(255 * green
+ 0.5);
272 blue
= Math
.floor(255 * blue
+ 0.5);
273 return 'rgb(' + red
+ ',' + green
+ ',' + blue
+ ')';
276 // The following functions are from quirksmode.org with a modification for Safari from
277 // http://blog.firetree.net/2005/07/04/javascript-find-position/
278 // http://www.quirksmode.org/js
/findpos
.html
279 // ... and modifications to support scrolling divs.
282 * Find the x-coordinate of the supplied object relative to the left side
284 * TODO(danvk): change obj type from Node -> !Node
289 Dygraph
.findPosX
= function(obj
) {
291 if(obj
.offsetParent
) {
294 var borderLeft
= getComputedStyle(copyObj
).borderLeft
|| "0";
295 curleft
+= parseInt(borderLeft
, 10) ;
296 curleft
+= copyObj
.offsetLeft
;
297 if(!copyObj
.offsetParent
) {
300 copyObj
= copyObj
.offsetParent
;
305 // This handles the case where the object is inside a scrolled div.
306 while(obj
&& obj
!= document
.body
) {
307 curleft
-= obj
.scrollLeft
;
308 obj
= obj
.parentNode
;
314 * Find the y-coordinate of the supplied object relative to the top of the
316 * TODO(danvk): change obj type from Node -> !Node
317 * TODO(danvk): consolidate with findPosX and return an {x, y} object.
322 Dygraph
.findPosY
= function(obj
) {
324 if(obj
.offsetParent
) {
327 var borderTop
= getComputedStyle(copyObj
).borderTop
|| "0";
328 curtop
+= parseInt(borderTop
, 10) ;
329 curtop
+= copyObj
.offsetTop
;
330 if(!copyObj
.offsetParent
) {
333 copyObj
= copyObj
.offsetParent
;
338 // This handles the case where the object is inside a scrolled div.
339 while(obj
&& obj
!= document
.body
) {
340 curtop
-= obj
.scrollTop
;
341 obj
= obj
.parentNode
;
347 * Returns the x-coordinate of the event in a coordinate system where the
348 * top-left corner of the page (not the window) is (0,0).
349 * Taken from MochiKit.Signal
354 Dygraph
.pageX
= function(e
) {
356 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
358 var de
= document
.documentElement
;
359 var b
= document
.body
;
361 (de
.scrollLeft
|| b
.scrollLeft
) -
362 (de
.clientLeft
|| 0);
367 * Returns the y-coordinate of the event in a coordinate system where the
368 * top-left corner of the page (not the window) is (0,0).
369 * Taken from MochiKit.Signal
374 Dygraph
.pageY
= function(e
) {
376 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
378 var de
= document
.documentElement
;
379 var b
= document
.body
;
381 (de
.scrollTop
|| b
.scrollTop
) -
387 * This returns true unless the parameter is 0, null, undefined or NaN.
388 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
390 * @param {number} x The number to consider.
391 * @return {boolean} Whether the number is zero or NaN.
394 Dygraph
.isOK
= function(x
) {
395 return !!x
&& !isNaN(x
);
399 * @param { {x:?number,y:?number,yval:?number} } p The point to consider, valid
400 * points are {x, y} objects
401 * @param { boolean } allowNaNY Treat point with y=NaN as valid
402 * @return { boolean } Whether the point has numeric x and y.
405 Dygraph
.isValidPoint
= function(p
, allowNaNY
) {
406 if (!p
) return false; // null or undefined object
407 if (p
.yval
=== null) return false; // missing point
408 if (p
.x
=== null || p
.x
=== undefined
) return false;
409 if (p
.y
=== null || p
.y
=== undefined
) return false;
410 if (isNaN(p
.x
) || (!allowNaNY
&& isNaN(p
.y
))) return false;
415 * Number formatting function which mimicks the behavior of %g in printf, i.e.
416 * either exponential or fixed format (without trailing 0s) is used depending on
417 * the length of the generated string. The advantage of this format is that
418 * there is a predictable upper bound on the resulting string length,
419 * significant figures are not dropped, and normal numbers are not displayed in
420 * exponential notation.
422 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
423 * It creates strings which are too long for absolute values between 10^-4 and
424 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
427 * @param {number} x The number to format
428 * @param {number=} opt_precision The precision to use, default 2.
429 * @return {string} A string formatted like %g in printf. The max generated
430 * string length should be precision + 6 (e.g 1.123e+300).
432 Dygraph
.floatFormat
= function(x
, opt_precision
) {
433 // Avoid invalid precision values; [1, 21] is the valid range.
434 var p
= Math
.min(Math
.max(1, opt_precision
|| 2), 21);
436 // This is deceptively simple. The actual algorithm comes from:
438 // Max allowed length = p + 4
439 // where 4 comes from 'e+n' and '.'.
441 // Length of fixed format = 2 + y + p
442 // where 2 comes from '0.' and y = # of leading zeroes.
444 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
447 // Since the behavior of toPrecision() is identical for larger numbers, we
448 // don't have to worry about the other bound.
450 // Finally, the argument for toExponential() is the number of trailing digits,
451 // so we take off 1 for the value before the '.'.
452 return (Math
.abs(x
) < 1.0e-3 && x
!== 0.0) ?
453 x
.toExponential(p
- 1) : x
.toPrecision(p
);
457 * Converts '9' to '09' (useful for dates)
462 Dygraph
.zeropad
= function(x
) {
463 if (x
< 10) return "0" + x
; else return "" + x
;
467 * Return a string version of the hours, minutes and seconds portion of a date.
469 * @param {number} date The JavaScript date (ms since epoch)
470 * @return {string} A time of the form "HH:MM:SS"
473 Dygraph
.hmsString_
= function(date
) {
474 var zeropad
= Dygraph
.zeropad
;
475 var d
= new Date(date
);
476 if (d
.getSeconds()) {
477 return zeropad(d
.getHours()) + ":" +
478 zeropad(d
.getMinutes()) + ":" +
479 zeropad(d
.getSeconds());
481 return zeropad(d
.getHours()) + ":" + zeropad(d
.getMinutes());
486 * Round a number to the specified number of digits past the decimal point.
487 * @param {number} num The number to round
488 * @param {number} places The number of decimals to which to round
489 * @return {number} The rounded number
492 Dygraph
.round_
= function(num
, places
) {
493 var shift
= Math
.pow(10, places
);
494 return Math
.round(num
* shift
)/shift
;
498 * Implementation of binary search over an array.
499 * Currently does not work when val is outside the range of arry's values.
500 * @param {number} val the value to search for
501 * @param {Array.<number>} arry is the value over which to search
502 * @param {number} abs If abs > 0, find the lowest entry greater than val
503 * If abs < 0, find the highest entry less than val.
504 * If abs == 0, find the entry that equals val.
505 * @param {number=} low The first index in arry to consider (optional)
506 * @param {number=} high The last index in arry to consider (optional)
507 * @return {number} Index of the element, or -1 if it isn't found.
510 Dygraph
.binarySearch
= function(val
, arry
, abs
, low
, high
) {
511 if (low
=== null || low
=== undefined
||
512 high
=== null || high
=== undefined
) {
514 high
= arry
.length
- 1;
519 if (abs
=== null || abs
=== undefined
) {
522 var validIndex
= function(idx
) {
523 return idx
>= 0 && idx
< arry
.length
;
525 var mid
= parseInt((low
+ high
) / 2, 10);
526 var element
= arry
[mid
];
528 if (element
== val
) {
530 } else if (element
> val
) {
532 // Accept if element > val, but also if prior element < val.
534 if (validIndex(idx
) && arry
[idx
] < val
) {
538 return Dygraph
.binarySearch(val
, arry
, abs
, low
, mid
- 1);
539 } else if (element
< val
) {
541 // Accept if element < val, but also if prior element > val.
543 if (validIndex(idx
) && arry
[idx
] > val
) {
547 return Dygraph
.binarySearch(val
, arry
, abs
, mid
+ 1, high
);
549 return -1; // can't actually happen, but makes closure compiler happy
553 * Parses a date, returning the number of milliseconds since epoch. This can be
554 * passed in as an xValueParser in the Dygraph constructor.
555 * TODO(danvk): enumerate formats that this understands.
557 * @param {string} dateStr A date in a variety of possible string formats.
558 * @return {number} Milliseconds since epoch.
561 Dygraph
.dateParser
= function(dateStr
) {
565 // Let the system try the format first, with one caveat:
566 // YYYY-MM-DD[ HH:MM:SS] is interpreted as UTC by a variety of browsers.
567 // dygraphs displays dates in local time, so this will result in surprising
568 // inconsistencies. But if you specify "T" or "Z" (i.e. YYYY-MM-DDTHH:MM:SS),
569 // then you probably know what you're doing, so we'll let you go ahead.
570 // Issue: http://code.google.com/p/dygraphs/issues/detail
?id
=255
571 if (dateStr
.search("-") == -1 ||
572 dateStr
.search("T") != -1 || dateStr
.search("Z") != -1) {
573 d
= Dygraph
.dateStrToMillis(dateStr
);
574 if (d
&& !isNaN(d
)) return d
;
577 if (dateStr
.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
578 dateStrSlashed
= dateStr
.replace("-", "/", "g");
579 while (dateStrSlashed
.search("-") != -1) {
580 dateStrSlashed
= dateStrSlashed
.replace("-", "/");
582 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
583 } else if (dateStr
.length
== 8) { // e.g. '20090712'
584 // TODO(danvk): remove support for this format. It's confusing.
585 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
587 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
589 // Any format that Date.parse will accept, e.g. "2009/07/12" or
590 // "2009/07/12 12:34:56"
591 d
= Dygraph
.dateStrToMillis(dateStr
);
594 if (!d
|| isNaN(d
)) {
595 Dygraph
.error("Couldn't parse " + dateStr
+ " as a date");
601 * This is identical to JavaScript's built-in Date.parse() method, except that
602 * it doesn't get replaced with an incompatible method by aggressive JS
603 * libraries like MooTools or Joomla.
604 * @param {string} str The date string, e.g. "2011/05/06"
605 * @return {number} millis since epoch
608 Dygraph
.dateStrToMillis
= function(str
) {
609 return new Date(str
).getTime();
612 // These functions are all based on MochiKit.
614 * Copies all the properties from o to self.
616 * @param {!Object} self
621 Dygraph
.update
= function(self
, o
) {
622 if (typeof(o
) != 'undefined' && o
!== null) {
624 if (o
.hasOwnProperty(k
)) {
633 * Copies all the properties from o to self.
635 * @param {!Object} self
640 Dygraph
.updateDeep
= function (self
, o
) {
641 // Taken from http://stackoverflow.com/questions
/384286/javascript
-isdom
-how
-do-you
-check
-if-a
-javascript
-object
-is
-a
-dom
-object
644 typeof Node
=== "object" ? o
instanceof Node
:
645 typeof o
=== "object" && typeof o
.nodeType
=== "number" && typeof o
.nodeName
==="string"
649 if (typeof(o
) != 'undefined' && o
!== null) {
651 if (o
.hasOwnProperty(k
)) {
654 } else if (Dygraph
.isArrayLike(o
[k
])) {
655 self
[k
] = o
[k
].slice();
656 } else if (isNode(o
[k
])) {
657 // DOM objects are shallowly-copied.
659 } else if (typeof(o
[k
]) == 'object') {
660 if (typeof(self
[k
]) != 'object' || self
[k
] === null) {
663 Dygraph
.updateDeep(self
[k
], o
[k
]);
678 Dygraph
.isArrayLike
= function(o
) {
681 (typ
!= 'object' && !(typ
== 'function' &&
682 typeof(o
.item
) == 'function')) ||
684 typeof(o
.length
) != 'number' ||
697 Dygraph
.isDateLike
= function (o
) {
698 if (typeof(o
) != "object" || o
=== null ||
699 typeof(o
.getTime
) != 'function') {
706 * Note: this only seems to work for arrays.
711 Dygraph
.clone
= function(o
) {
712 // TODO(danvk): figure out how MochiKit's version works
714 for (var i
= 0; i
< o
.length
; i
++) {
715 if (Dygraph
.isArrayLike(o
[i
])) {
716 r
.push(Dygraph
.clone(o
[i
]));
725 * Create a new canvas element. This is more complex than a simple
726 * document.createElement("canvas") because of IE and excanvas.
728 * @return {!HTMLCanvasElement}
731 Dygraph
.createCanvas
= function() {
732 var canvas
= document
.createElement("canvas");
734 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
735 if (isIE
&& (typeof(G_vmlCanvasManager
) != 'undefined')) {
736 canvas
= G_vmlCanvasManager
.initElement(
737 /**@type{!HTMLCanvasElement}*/(canvas
));
744 * Checks whether the user is on an Android browser.
745 * Android does not fully support the <canvas> tag, e.g. w/r/t/ clipping.
749 Dygraph
.isAndroid
= function() {
750 return (/Android/).test(navigator
.userAgent
);
755 * TODO(danvk): use @template here when it's better supported for classes.
756 * @param {!Array} array
757 * @param {number} start
758 * @param {number} length
759 * @param {function(!Array,?):boolean=} predicate
762 Dygraph
.Iterator
= function(array
, start
, length
, predicate
) {
764 length
= length
|| array
.length
;
765 this.hasNext
= true; // Use to identify if there's another element.
766 this.peek
= null; // Use for look-ahead
769 this.predicate_
= predicate
;
770 this.end_
= Math
.min(array
.length
, start
+ length
);
771 this.nextIdx_
= start
- 1; // use -1 so initial advance works.
772 this.next(); // ignoring result.
778 Dygraph
.Iterator
.prototype.next
= function() {
784 var nextIdx
= this.nextIdx_
+ 1;
786 while (nextIdx
< this.end_
) {
787 if (!this.predicate_
|| this.predicate_(this.array_
, nextIdx
)) {
788 this.peek
= this.array_
[nextIdx
];
794 this.nextIdx_
= nextIdx
;
796 this.hasNext
= false;
803 * Returns a new iterator over array, between indexes start and
804 * start + length, and only returns entries that pass the accept function
806 * @param {!Array} array the array to iterate over.
807 * @param {number} start the first index to iterate over, 0 if absent.
808 * @param {number} length the number of elements in the array to iterate over.
809 * This, along with start, defines a slice of the array, and so length
810 * doesn't imply the number of elements in the iterator when accept doesn't
811 * always accept all values. array.length when absent.
812 * @param {function(?):boolean=} opt_predicate a function that takes
813 * parameters array and idx, which returns true when the element should be
814 * returned. If omitted, all elements are accepted.
817 Dygraph
.createIterator
= function(array
, start
, length
, opt_predicate
) {
818 return new Dygraph
.Iterator(array
, start
, length
, opt_predicate
);
821 // Shim layer with setTimeout fallback.
822 // From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
823 // Should be called with the window context:
824 // Dygraph.requestAnimFrame.call(window, function() {})
825 Dygraph
.requestAnimFrame
= (function() {
826 return window
.requestAnimationFrame
||
827 window
.webkitRequestAnimationFrame
||
828 window
.mozRequestAnimationFrame
||
829 window
.oRequestAnimationFrame
||
830 window
.msRequestAnimationFrame
||
831 function (callback
) {
832 window
.setTimeout(callback
, 1000 / 60);
837 * Call a function at most maxFrames times at an attempted interval of
838 * framePeriodInMillis, then call a cleanup function once. repeatFn is called
839 * once immediately, then at most (maxFrames - 1) times asynchronously. If
840 * maxFrames==1, then cleanup_fn() is also called synchronously. This function
841 * is used to sequence animation.
842 * @param {function(number)} repeatFn Called repeatedly -- takes the frame
843 * number (from 0 to maxFrames-1) as an argument.
844 * @param {number} maxFrames The max number of times to call repeatFn
845 * @param {number} framePeriodInMillis Max requested time between frames.
846 * @param {function()} cleanupFn A function to call after all repeatFn calls.
849 Dygraph
.repeatAndCleanup
= function(repeatFn
, maxFrames
, framePeriodInMillis
,
852 var previousFrameNumber
;
853 var startTime
= new Date().getTime();
854 repeatFn(frameNumber
);
855 if (maxFrames
== 1) {
859 var maxFrameArg
= maxFrames
- 1;
862 if (frameNumber
>= maxFrames
) return;
863 Dygraph
.requestAnimFrame
.call(window
, function() {
864 // Determine which frame to draw based on the delay so far. Will skip
865 // frames if necessary.
866 var currentTime
= new Date().getTime();
867 var delayInMillis
= currentTime
- startTime
;
868 previousFrameNumber
= frameNumber
;
869 frameNumber
= Math
.floor(delayInMillis
/ framePeriodInMillis
);
870 var frameDelta
= frameNumber
- previousFrameNumber
;
871 // If we predict that the subsequent repeatFn call will overshoot our
872 // total frame target, so our last call will cause a stutter, then jump to
873 // the last call immediately. If we're going to cause a stutter, better
874 // to do it faster than slower.
875 var predictOvershootStutter
= (frameNumber
+ frameDelta
) > maxFrameArg
;
876 if (predictOvershootStutter
|| (frameNumber
>= maxFrameArg
)) {
877 repeatFn(maxFrameArg
); // Ensure final call with maxFrameArg.
880 if (frameDelta
!== 0) { // Don't call repeatFn with duplicate frames.
881 repeatFn(frameNumber
);
890 * This function will scan the option list and determine if they
891 * require us to recalculate the pixel positions of each point.
892 * @param {!Array.<string>} labels a list of options to check.
893 * @param {!Object} attrs
894 * @return {boolean} true if the graph needs new points else false.
897 Dygraph
.isPixelChangingOptionList
= function(labels
, attrs
) {
898 // A whitelist of options that do not change pixel positions.
899 var pixelSafeOptions
= {
900 'annotationClickHandler': true,
901 'annotationDblClickHandler': true,
902 'annotationMouseOutHandler': true,
903 'annotationMouseOverHandler': true,
904 'axisLabelColor': true,
905 'axisLineColor': true,
906 'axisLineWidth': true,
907 'clickCallback': true,
908 'digitsAfterDecimal': true,
909 'drawCallback': true,
910 'drawHighlightPointCallback': true,
912 'drawPointCallback': true,
916 'gridLineColor': true,
917 'gridLineWidth': true,
918 'hideOverlayOnMouseOut': true,
919 'highlightCallback': true,
920 'highlightCircleSize': true,
921 'interactionModel': true,
922 'isZoomedIgnoreProgrammaticZoom': true,
924 'labelsDivStyles': true,
925 'labelsDivWidth': true,
928 'labelsSeparateLines': true,
929 'labelsShowZeroValues': true,
931 'maxNumberWidth': true,
932 'panEdgeFraction': true,
933 'pixelsPerYLabel': true,
934 'pointClickCallback': true,
936 'rangeSelectorPlotFillColor': true,
937 'rangeSelectorPlotStrokeColor': true,
938 'showLabelsOnHighlight': true,
942 'underlayCallback': true,
943 'unhighlightCallback': true,
944 'xAxisLabelFormatter': true,
946 'xValueFormatter': true,
947 'yAxisLabelFormatter': true,
948 'yValueFormatter': true,
952 // Assume that we do not require new points.
953 // This will change to true if we actually do need new points.
954 var requiresNewPoints
= false;
956 // Create a dictionary of series names for faster lookup.
957 // If there are no labels, then the dictionary stays empty.
958 var seriesNamesDictionary
= { };
960 for (var i
= 1; i
< labels
.length
; i
++) {
961 seriesNamesDictionary
[labels
[i
]] = true;
965 // Iterate through the list of updated options.
966 for (var property
in attrs
) {
967 // Break early if we already know we need new points from a previous option.
968 if (requiresNewPoints
) {
971 if (attrs
.hasOwnProperty(property
)) {
972 // Find out of this field is actually a series specific options list.
973 if (seriesNamesDictionary
[property
]) {
974 // This property value is a list of options for this series.
975 // If any of these sub properties are not pixel safe, set the flag.
976 for (var subProperty
in attrs
[property
]) {
977 // Break early if we already know we need new points from a previous option.
978 if (requiresNewPoints
) {
981 if (attrs
[property
].hasOwnProperty(subProperty
) && !pixelSafeOptions
[subProperty
]) {
982 requiresNewPoints
= true;
985 // If this was not a series specific option list, check if its a pixel changing property.
986 } else if (!pixelSafeOptions
[property
]) {
987 requiresNewPoints
= true;
992 return requiresNewPoints
;
996 * Compares two arrays to see if they are equal. If either parameter is not an
997 * array it will return false. Does a shallow compare
998 * Dygraph.compareArrays([[1,2], [3, 4]], [[1,2], [3,4]]) === false.
999 * @param {!Array.<T>} array1 first array
1000 * @param {!Array.<T>} array2 second array
1001 * @return {boolean} True if both parameters are arrays, and contents are equal.
1004 Dygraph
.compareArrays
= function(array1
, array2
) {
1005 if (!Dygraph
.isArrayLike(array1
) || !Dygraph
.isArrayLike(array2
)) {
1008 if (array1
.length
!== array2
.length
) {
1011 for (var i
= 0; i
< array1
.length
; i
++) {
1012 if (array1
[i
] !== array2
[i
]) {
1020 * @param {!CanvasRenderingContext2D} ctx the canvas context
1021 * @param {number} sides the number of sides in the shape.
1022 * @param {number} radius the radius of the image.
1023 * @param {number} cx center x coordate
1024 * @param {number} cy center y coordinate
1025 * @param {number=} rotationRadians the shift of the initial angle, in radians.
1026 * @param {number=} delta the angle shift for each line. If missing, creates a
1030 Dygraph
.regularShape_
= function(
1031 ctx
, sides
, radius
, cx
, cy
, rotationRadians
, delta
) {
1032 rotationRadians
= rotationRadians
|| 0;
1033 delta
= delta
|| Math
.PI
* 2 / sides
;
1036 var initialAngle
= rotationRadians
;
1037 var angle
= initialAngle
;
1039 var computeCoordinates
= function() {
1040 var x
= cx
+ (Math
.sin(angle
) * radius
);
1041 var y
= cy
+ (-Math
.cos(angle
) * radius
);
1045 var initialCoordinates
= computeCoordinates();
1046 var x
= initialCoordinates
[0];
1047 var y
= initialCoordinates
[1];
1050 for (var idx
= 0; idx
< sides
; idx
++) {
1051 angle
= (idx
== sides
- 1) ? initialAngle
: (angle
+ delta
);
1052 var coords
= computeCoordinates();
1053 ctx
.lineTo(coords
[0], coords
[1]);
1060 * TODO(danvk): be more specific on the return type.
1061 * @param {number} sides
1062 * @param {number=} rotationRadians
1063 * @param {number=} delta
1064 * @return {Function}
1067 Dygraph
.shapeFunction_
= function(sides
, rotationRadians
, delta
) {
1068 return function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1069 ctx
.strokeStyle
= color
;
1070 ctx
.fillStyle
= "white";
1071 Dygraph
.regularShape_(ctx
, sides
, radius
, cx
, cy
, rotationRadians
, delta
);
1076 DEFAULT
: function(g
, name
, ctx
, canvasx
, canvasy
, color
, radius
) {
1078 ctx
.fillStyle
= color
;
1079 ctx
.arc(canvasx
, canvasy
, radius
, 0, 2 * Math
.PI
, false);
1082 TRIANGLE
: Dygraph
.shapeFunction_(3),
1083 SQUARE
: Dygraph
.shapeFunction_(4, Math
.PI
/ 4),
1084 DIAMOND
: Dygraph
.shapeFunction_(4),
1085 PENTAGON
: Dygraph
.shapeFunction_(5),
1086 HEXAGON
: Dygraph
.shapeFunction_(6),
1087 CIRCLE
: function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1089 ctx
.strokeStyle
= color
;
1090 ctx
.fillStyle
= "white";
1091 ctx
.arc(cx
, cy
, radius
, 0, 2 * Math
.PI
, false);
1095 STAR
: Dygraph
.shapeFunction_(5, 0, 4 * Math
.PI
/ 5),
1096 PLUS
: function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1097 ctx
.strokeStyle
= color
;
1100 ctx
.moveTo(cx
+ radius
, cy
);
1101 ctx
.lineTo(cx
- radius
, cy
);
1106 ctx
.moveTo(cx
, cy
+ radius
);
1107 ctx
.lineTo(cx
, cy
- radius
);
1111 EX
: function(g
, name
, ctx
, cx
, cy
, color
, radius
) {
1112 ctx
.strokeStyle
= color
;
1115 ctx
.moveTo(cx
+ radius
, cy
+ radius
);
1116 ctx
.lineTo(cx
- radius
, cy
- radius
);
1121 ctx
.moveTo(cx
+ radius
, cy
- radius
);
1122 ctx
.lineTo(cx
- radius
, cy
+ radius
);
1129 * To create a "drag" interaction, you typically register a mousedown event
1130 * handler on the element where the drag begins. In that handler, you register a
1131 * mouseup handler on the window to determine when the mouse is released,
1132 * wherever that release happens. This works well, except when the user releases
1133 * the mouse over an off-domain iframe. In that case, the mouseup event is
1134 * handled by the iframe and never bubbles up to the window handler.
1136 * To deal with this issue, we cover iframes with high z-index divs to make sure
1137 * they don't capture mouseup.
1140 * element.addEventListener('mousedown', function() {
1141 * var tarper = new Dygraph.IFrameTarp();
1143 * var mouseUpHandler = function() {
1145 * window.removeEventListener(mouseUpHandler);
1148 * window.addEventListener('mouseup', mouseUpHandler);
1153 Dygraph
.IFrameTarp
= function() {
1154 /** @type {Array.<!HTMLDivElement>} */
1159 * Find all the iframes in the document and cover them with high z-index
1162 Dygraph
.IFrameTarp
.prototype.cover
= function() {
1163 var iframes
= document
.getElementsByTagName("iframe");
1164 for (var i
= 0; i
< iframes
.length
; i
++) {
1165 var iframe
= iframes
[i
];
1166 var x
= Dygraph
.findPosX(iframe
),
1167 y
= Dygraph
.findPosY(iframe
),
1168 width
= iframe
.offsetWidth
,
1169 height
= iframe
.offsetHeight
;
1171 var div
= document
.createElement("div");
1172 div
.style
.position
= "absolute";
1173 div
.style
.left
= x
+ 'px';
1174 div
.style
.top
= y
+ 'px';
1175 div
.style
.width
= width
+ 'px';
1176 div
.style
.height
= height
+ 'px';
1177 div
.style
.zIndex
= 999;
1178 document
.body
.appendChild(div
);
1179 this.tarps
.push(div
);
1184 * Remove all the iframe covers. You should call this in a mouseup handler.
1186 Dygraph
.IFrameTarp
.prototype.uncover
= function() {
1187 for (var i
= 0; i
< this.tarps
.length
; i
++) {
1188 this.tarps
[i
].parentNode
.removeChild(this.tarps
[i
]);
1194 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
1195 * @param {string} data
1196 * @return {?string} the delimiter that was detected (or null on failure).
1198 Dygraph
.detectLineDelimiter
= function(data
) {
1199 for (var i
= 0; i
< data
.length
; i
++) {
1200 var code
= data
.charAt(i
);
1201 if (code
=== '\r') {
1202 // Might actually be "\r\n".
1203 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\n')) {
1208 if (code
=== '\n') {
1209 // Might actually be "\n\r".
1210 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\r')) {
1221 * Is one element contained by another?
1222 * @param {Element} containee The contained element.
1223 * @param {Element} container The container element.
1224 * @return {boolean} Whether containee is inside (or equal to) container.
1227 Dygraph
.isElementContainedBy
= function(containee
, container
) {
1228 if (container
=== null || containee
=== null) {
1231 while (containee
&& containee
!== container
) {
1232 containee
= containee
.parentNode
;
1234 return (containee
=== container
);