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.
16 /*global Dygraph:false, G_vmlCanvasManager:false, Node:false */
19 Dygraph
.LOG_SCALE
= 10;
20 Dygraph
.LN_TEN
= Math
.log(Dygraph
.LOG_SCALE
);
27 Dygraph
.log10
= function(x
) {
28 return Math
.log(x
) / Dygraph
.LN_TEN
;
31 /** A dotted line stroke pattern. */
32 Dygraph
.DOTTED_LINE
= [2, 2];
33 /** A dashed line stroke pattern. */
34 Dygraph
.DASHED_LINE
= [7, 3];
35 /** A dot dash stroke pattern. */
36 Dygraph
.DOT_DASH_LINE
= [7, 2, 2, 2];
39 * Return the 2d context for a dygraph canvas.
41 * This method is only exposed for the sake of replacing the function in
42 * automated tests, e.g.
44 * var oldFunc = Dygraph.getContext();
45 * Dygraph.getContext = function(canvas) {
46 * var realContext = oldFunc(canvas);
47 * return new Proxy(realContext);
49 * @param {!HTMLCanvasElement} canvas
50 * @return {!CanvasRenderingContext2D}
53 Dygraph
.getContext
= function(canvas
) {
54 return /** @type{!CanvasRenderingContext2D}*/(canvas
.getContext("2d"));
58 * Add an event handler. This smooths a difference between IE and the rest of
60 * @param {!Node} elem The element to add the event to.
61 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
62 * @param {function(Event):(boolean|undefined)} fn The function to call
63 * on the event. The function takes one parameter: the event object.
66 Dygraph
.addEvent
= function addEvent(elem
, type
, fn
) {
67 if (elem
.addEventListener
) {
68 elem
.addEventListener(type
, fn
, false);
70 elem
[type
+fn
] = function(){fn(window
.event
);};
71 elem
.attachEvent('on'+type
, elem
[type
+fn
]);
76 * Add an event handler. This event handler is kept until the graph is
77 * destroyed with a call to graph.destroy().
79 * @param {!Node} elem The element to add the event to.
80 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
81 * @param {function(Event):(boolean|undefined)} fn The function to call
82 * on the event. The function takes one parameter: the event object.
85 Dygraph
.prototype.addAndTrackEvent
= function(elem
, type
, fn
) {
86 Dygraph
.addEvent(elem
, type
, fn
);
87 this.registeredEvents_
.push({ elem
: elem
, type
: type
, fn
: fn
});
91 * Remove an event handler. This smooths a difference between IE and the rest
93 * @param {!Node} elem The element to remove the event from.
94 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
95 * @param {function(Event):(boolean|undefined)} fn The function to call
96 * on the event. The function takes one parameter: the event object.
99 Dygraph
.removeEvent
= function(elem
, type
, fn
) {
100 if (elem
.removeEventListener
) {
101 elem
.removeEventListener(type
, fn
, false);
104 elem
.detachEvent('on'+type
, elem
[type
+fn
]);
106 // We only detach event listeners on a "best effort" basis in IE. See:
107 // http://stackoverflow.com/questions
/2553632/detachevent-not
-working
-with-named
-inline
-functions
109 elem
[type
+fn
] = null;
113 Dygraph
.prototype.removeTrackedEvents_
= function() {
114 if (this.registeredEvents_
) {
115 for (var idx
= 0; idx
< this.registeredEvents_
.length
; idx
++) {
116 var reg
= this.registeredEvents_
[idx
];
117 Dygraph
.removeEvent(reg
.elem
, reg
.type
, reg
.fn
);
121 this.registeredEvents_
= [];
125 * Cancels further processing of an event. This is useful to prevent default
126 * browser actions, e.g. highlighting text on a double-click.
127 * Based on the article at
128 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
129 * @param {!Event} e The event whose normal behavior should be canceled.
132 Dygraph
.cancelEvent
= function(e
) {
133 e
= e
? e
: window
.event
;
134 if (e
.stopPropagation
) {
137 if (e
.preventDefault
) {
140 e
.cancelBubble
= true;
142 e
.returnValue
= false;
147 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
148 * is used to generate default series colors which are evenly spaced on the
150 * @param { number } hue Range is 0.0-1.0.
151 * @param { number } saturation Range is 0.0-1.0.
152 * @param { number } value Range is 0.0-1.0.
153 * @return { string } "rgb(r,g,b)" where r, g and b range from 0-255.
156 Dygraph
.hsvToRGB
= function (hue
, saturation
, value
) {
160 if (saturation
=== 0) {
165 var i
= Math
.floor(hue
* 6);
166 var f
= (hue
* 6) - i
;
167 var p
= value
* (1 - saturation
);
168 var q
= value
* (1 - (saturation
* f
));
169 var t
= value
* (1 - (saturation
* (1 - f
)));
171 case 1: red
= q
; green
= value
; blue
= p
; break;
172 case 2: red
= p
; green
= value
; blue
= t
; break;
173 case 3: red
= p
; green
= q
; blue
= value
; break;
174 case 4: red
= t
; green
= p
; blue
= value
; break;
175 case 5: red
= value
; green
= p
; blue
= q
; break;
176 case 6: // fall through
177 case 0: red
= value
; green
= t
; blue
= p
; break;
180 red
= Math
.floor(255 * red
+ 0.5);
181 green
= Math
.floor(255 * green
+ 0.5);
182 blue
= Math
.floor(255 * blue
+ 0.5);
183 return 'rgb(' + red
+ ',' + green
+ ',' + blue
+ ')';
186 // The following functions are from quirksmode.org with a modification for Safari from
187 // http://blog.firetree.net/2005/07/04/javascript-find-position/
188 // http://www.quirksmode.org/js
/findpos
.html
189 // ... and modifications to support scrolling divs.
192 * Find the coordinates of an object relative to the top left of the page.
194 * TODO(danvk): change obj type from Node -> !Node
196 * @return {{x:number,y:number}}
199 Dygraph
.findPos
= function(obj
) {
200 var curleft
= 0, curtop
= 0;
201 if (obj
.offsetParent
) {
204 // NOTE: the if statement here is for IE8.
205 var borderLeft
= "0", borderTop
= "0";
206 if (window
.getComputedStyle
) {
207 var computedStyle
= window
.getComputedStyle(copyObj
, null);
208 borderLeft
= computedStyle
.borderLeft
|| "0";
209 borderTop
= computedStyle
.borderTop
|| "0";
211 curleft
+= parseInt(borderLeft
, 10) ;
212 curtop
+= parseInt(borderTop
, 10) ;
213 curleft
+= copyObj
.offsetLeft
;
214 curtop
+= copyObj
.offsetTop
;
215 if (!copyObj
.offsetParent
) {
218 copyObj
= copyObj
.offsetParent
;
221 // TODO(danvk): why would obj ever have these properties?
222 if (obj
.x
) curleft
+= obj
.x
;
223 if (obj
.y
) curtop
+= obj
.y
;
226 // This handles the case where the object is inside a scrolled div.
227 while (obj
&& obj
!= document
.body
) {
228 curleft
-= obj
.scrollLeft
;
229 curtop
-= obj
.scrollTop
;
230 obj
= obj
.parentNode
;
232 return {x
: curleft
, y
: curtop
};
236 * Returns the x-coordinate of the event in a coordinate system where the
237 * top-left corner of the page (not the window) is (0,0).
238 * Taken from MochiKit.Signal
243 Dygraph
.pageX
= function(e
) {
245 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
247 var de
= document
.documentElement
;
248 var b
= document
.body
;
250 (de
.scrollLeft
|| b
.scrollLeft
) -
251 (de
.clientLeft
|| 0);
256 * Returns the y-coordinate of the event in a coordinate system where the
257 * top-left corner of the page (not the window) is (0,0).
258 * Taken from MochiKit.Signal
263 Dygraph
.pageY
= function(e
) {
265 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
267 var de
= document
.documentElement
;
268 var b
= document
.body
;
270 (de
.scrollTop
|| b
.scrollTop
) -
276 * Converts page the x-coordinate of the event to pixel x-coordinates on the
277 * canvas (i.e. DOM Coords).
278 * @param {!Event} e Drag event.
279 * @param {!DygraphInteractionContext} context Interaction context object.
280 * @return {number} The amount by which the drag has moved to the right.
282 Dygraph
.dragGetX_
= function(e
, context
) {
283 return Dygraph
.pageX(e
) - context
.px
;
287 * Converts page the y-coordinate of the event to pixel y-coordinates on the
288 * canvas (i.e. DOM Coords).
289 * @param {!Event} e Drag event.
290 * @param {!DygraphInteractionContext} context Interaction context object.
291 * @return {number} The amount by which the drag has moved down.
293 Dygraph
.dragGetY_
= function(e
, context
) {
294 return Dygraph
.pageY(e
) - context
.py
;
298 * This returns true unless the parameter is 0, null, undefined or NaN.
299 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
301 * @param {number} x The number to consider.
302 * @return {boolean} Whether the number is zero or NaN.
305 Dygraph
.isOK
= function(x
) {
306 return !!x
&& !isNaN(x
);
310 * @param {{x:?number,y:?number,yval:?number}} p The point to consider, valid
311 * points are {x, y} objects
312 * @param {boolean=} opt_allowNaNY Treat point with y=NaN as valid
313 * @return {boolean} Whether the point has numeric x and y.
316 Dygraph
.isValidPoint
= function(p
, opt_allowNaNY
) {
317 if (!p
) return false; // null or undefined object
318 if (p
.yval
=== null) return false; // missing point
319 if (p
.x
=== null || p
.x
=== undefined
) return false;
320 if (p
.y
=== null || p
.y
=== undefined
) return false;
321 if (isNaN(p
.x
) || (!opt_allowNaNY
&& isNaN(p
.y
))) return false;
326 * Number formatting function which mimicks the behavior of %g in printf, i.e.
327 * either exponential or fixed format (without trailing 0s) is used depending on
328 * the length of the generated string. The advantage of this format is that
329 * there is a predictable upper bound on the resulting string length,
330 * significant figures are not dropped, and normal numbers are not displayed in
331 * exponential notation.
333 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
334 * It creates strings which are too long for absolute values between 10^-4 and
335 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
338 * @param {number} x The number to format
339 * @param {number=} opt_precision The precision to use, default 2.
340 * @return {string} A string formatted like %g in printf. The max generated
341 * string length should be precision + 6 (e.g 1.123e+300).
343 Dygraph
.floatFormat
= function(x
, opt_precision
) {
344 // Avoid invalid precision values; [1, 21] is the valid range.
345 var p
= Math
.min(Math
.max(1, opt_precision
|| 2), 21);
347 // This is deceptively simple. The actual algorithm comes from:
349 // Max allowed length = p + 4
350 // where 4 comes from 'e+n' and '.'.
352 // Length of fixed format = 2 + y + p
353 // where 2 comes from '0.' and y = # of leading zeroes.
355 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
358 // Since the behavior of toPrecision() is identical for larger numbers, we
359 // don't have to worry about the other bound.
361 // Finally, the argument for toExponential() is the number of trailing digits,
362 // so we take off 1 for the value before the '.'.
363 return (Math
.abs(x
) < 1.0e-3 && x
!== 0.0) ?
364 x
.toExponential(p
- 1) : x
.toPrecision(p
);
368 * Converts '9' to '09' (useful for dates)
373 Dygraph
.zeropad
= function(x
) {
374 if (x
< 10) return "0" + x
; else return "" + x
;
378 * Date accessors to get the parts of a calendar date (year, month,
379 * day, hour, minute, second and millisecond) according to local time,
380 * and factory method to call the Date constructor with an array of arguments.
382 Dygraph
.DateAccessorsLocal
= {
383 getFullYear
: function(d
) {return d
.getFullYear();},
384 getMonth
: function(d
) {return d
.getMonth();},
385 getDate
: function(d
) {return d
.getDate();},
386 getHours
: function(d
) {return d
.getHours();},
387 getMinutes
: function(d
) {return d
.getMinutes();},
388 getSeconds
: function(d
) {return d
.getSeconds();},
389 getMilliseconds
: function(d
) {return d
.getMilliseconds();},
390 getDay
: function(d
) {return d
.getDay();},
391 makeDate
: function(y
, m
, d
, hh
, mm
, ss
, ms
) {
392 return new Date(y
, m
, d
, hh
, mm
, ss
, ms
);
397 * Date accessors to get the parts of a calendar date (year, month,
398 * day of month, hour, minute, second and millisecond) according to UTC time,
399 * and factory method to call the Date constructor with an array of arguments.
401 Dygraph
.DateAccessorsUTC
= {
402 getFullYear
: function(d
) {return d
.getUTCFullYear();},
403 getMonth
: function(d
) {return d
.getUTCMonth();},
404 getDate
: function(d
) {return d
.getUTCDate();},
405 getHours
: function(d
) {return d
.getUTCHours();},
406 getMinutes
: function(d
) {return d
.getUTCMinutes();},
407 getSeconds
: function(d
) {return d
.getUTCSeconds();},
408 getMilliseconds
: function(d
) {return d
.getUTCMilliseconds();},
409 getDay
: function(d
) {return d
.getUTCDay();},
410 makeDate
: function(y
, m
, d
, hh
, mm
, ss
, ms
) {
411 return new Date(Date
.UTC(y
, m
, d
, hh
, mm
, ss
, ms
));
416 * Return a string version of the hours, minutes and seconds portion of a date.
417 * @param {number} hh The hours (from 0-23)
418 * @param {number} mm The minutes (from 0-59)
419 * @param {number} ss The seconds (from 0-59)
420 * @return {string} A time of the form "HH:MM" or "HH:MM:SS"
423 Dygraph
.hmsString_
= function(hh
, mm
, ss
) {
424 var zeropad
= Dygraph
.zeropad
;
425 var ret
= zeropad(hh
) + ":" + zeropad(mm
);
427 ret
+= ":" + zeropad(ss
);
433 * Convert a JS date (millis since epoch) to a formatted string.
434 * @param {number} time The JavaScript time value (ms since epoch)
435 * @param {boolean} utc Wether output UTC or local time
436 * @return {string} A date of one of these forms:
437 * "YYYY/MM/DD", "YYYY/MM/DD HH:MM" or "YYYY/MM/DD HH:MM:SS"
440 Dygraph
.dateString_
= function(time
, utc
) {
441 var zeropad
= Dygraph
.zeropad
;
442 var accessors
= utc
? Dygraph
.DateAccessorsUTC
: Dygraph
.DateAccessorsLocal
;
443 var date
= new Date(time
);
444 var y
= accessors
.getFullYear(date
);
445 var m
= accessors
.getMonth(date
);
446 var d
= accessors
.getDate(date
);
447 var hh
= accessors
.getHours(date
);
448 var mm
= accessors
.getMinutes(date
);
449 var ss
= accessors
.getSeconds(date
);
450 // Get a year string:
452 // Get a 0 padded month string
453 var month
= zeropad(m
+ 1); //months are 0-offset, sigh
454 // Get a 0 padded day string
455 var day
= zeropad(d
);
456 var frac
= hh
* 3600 + mm
* 60 + ss
;
457 var ret
= year
+ "/" + month + "/" + day
;
459 ret
+= " " + Dygraph
.hmsString_(hh
, mm
, ss
);
465 * Round a number to the specified number of digits past the decimal point.
466 * @param {number} num The number to round
467 * @param {number} places The number of decimals to which to round
468 * @return {number} The rounded number
471 Dygraph
.round_
= function(num
, places
) {
472 var shift
= Math
.pow(10, places
);
473 return Math
.round(num
* shift
)/shift
;
477 * Implementation of binary search over an array.
478 * Currently does not work when val is outside the range of arry's values.
479 * @param {number} val the value to search for
480 * @param {Array.<number>} arry is the value over which to search
481 * @param {number} abs If abs > 0, find the lowest entry greater than val
482 * If abs < 0, find the highest entry less than val.
483 * If abs == 0, find the entry that equals val.
484 * @param {number=} low The first index in arry to consider (optional)
485 * @param {number=} high The last index in arry to consider (optional)
486 * @return {number} Index of the element, or -1 if it isn't found.
489 Dygraph
.binarySearch
= function(val
, arry
, abs
, low
, high
) {
490 if (low
=== null || low
=== undefined
||
491 high
=== null || high
=== undefined
) {
493 high
= arry
.length
- 1;
498 if (abs
=== null || abs
=== undefined
) {
501 var validIndex
= function(idx
) {
502 return idx
>= 0 && idx
< arry
.length
;
504 var mid
= parseInt((low
+ high
) / 2, 10);
505 var element
= arry
[mid
];
507 if (element
== val
) {
509 } else if (element
> val
) {
511 // Accept if element > val, but also if prior element < val.
513 if (validIndex(idx
) && arry
[idx
] < val
) {
517 return Dygraph
.binarySearch(val
, arry
, abs
, low
, mid
- 1);
518 } else if (element
< val
) {
520 // Accept if element < val, but also if prior element > val.
522 if (validIndex(idx
) && arry
[idx
] > val
) {
526 return Dygraph
.binarySearch(val
, arry
, abs
, mid
+ 1, high
);
528 return -1; // can't actually happen, but makes closure compiler happy
532 * Parses a date, returning the number of milliseconds since epoch. This can be
533 * passed in as an xValueParser in the Dygraph constructor.
534 * TODO(danvk): enumerate formats that this understands.
536 * @param {string} dateStr A date in a variety of possible string formats.
537 * @return {number} Milliseconds since epoch.
540 Dygraph
.dateParser
= function(dateStr
) {
544 // Let the system try the format first, with one caveat:
545 // YYYY-MM-DD[ HH:MM:SS] is interpreted as UTC by a variety of browsers.
546 // dygraphs displays dates in local time, so this will result in surprising
547 // inconsistencies. But if you specify "T" or "Z" (i.e. YYYY-MM-DDTHH:MM:SS),
548 // then you probably know what you're doing, so we'll let you go ahead.
549 // Issue: http://code.google.com/p/dygraphs/issues/detail
?id
=255
550 if (dateStr
.search("-") == -1 ||
551 dateStr
.search("T") != -1 || dateStr
.search("Z") != -1) {
552 d
= Dygraph
.dateStrToMillis(dateStr
);
553 if (d
&& !isNaN(d
)) return d
;
556 if (dateStr
.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
557 dateStrSlashed
= dateStr
.replace("-", "/", "g");
558 while (dateStrSlashed
.search("-") != -1) {
559 dateStrSlashed
= dateStrSlashed
.replace("-", "/");
561 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
562 } else if (dateStr
.length
== 8) { // e.g. '20090712'
563 // TODO(danvk): remove support for this format. It's confusing.
564 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
566 d
= Dygraph
.dateStrToMillis(dateStrSlashed
);
568 // Any format that Date.parse will accept, e.g. "2009/07/12" or
569 // "2009/07/12 12:34:56"
570 d
= Dygraph
.dateStrToMillis(dateStr
);
573 if (!d
|| isNaN(d
)) {
574 console
.error("Couldn't parse " + dateStr
+ " as a date");
580 * This is identical to JavaScript's built-in Date.parse() method, except that
581 * it doesn't get replaced with an incompatible method by aggressive JS
582 * libraries like MooTools or Joomla.
583 * @param {string} str The date string, e.g. "2011/05/06"
584 * @return {number} millis since epoch
587 Dygraph
.dateStrToMillis
= function(str
) {
588 return new Date(str
).getTime();
591 // These functions are all based on MochiKit.
593 * Copies all the properties from o to self.
595 * @param {!Object} self
599 Dygraph
.update
= function(self
, o
) {
600 if (typeof(o
) != 'undefined' && o
!== null) {
602 if (o
.hasOwnProperty(k
)) {
611 * Copies all the properties from o to self.
613 * @param {!Object} self
618 Dygraph
.updateDeep
= function (self
, o
) {
619 // Taken from http://stackoverflow.com/questions
/384286/javascript
-isdom
-how
-do-you
-check
-if-a
-javascript
-object
-is
-a
-dom
-object
622 typeof Node
=== "object" ? o
instanceof Node
:
623 typeof o
=== "object" && typeof o
.nodeType
=== "number" && typeof o
.nodeName
==="string"
627 if (typeof(o
) != 'undefined' && o
!== null) {
629 if (o
.hasOwnProperty(k
)) {
632 } else if (Dygraph
.isArrayLike(o
[k
])) {
633 self
[k
] = o
[k
].slice();
634 } else if (isNode(o
[k
])) {
635 // DOM objects are shallowly-copied.
637 } else if (typeof(o
[k
]) == 'object') {
638 if (typeof(self
[k
]) != 'object' || self
[k
] === null) {
641 Dygraph
.updateDeep(self
[k
], o
[k
]);
656 Dygraph
.isArrayLike
= function(o
) {
659 (typ
!= 'object' && !(typ
== 'function' &&
660 typeof(o
.item
) == 'function')) ||
662 typeof(o
.length
) != 'number' ||
675 Dygraph
.isDateLike
= function (o
) {
676 if (typeof(o
) != "object" || o
=== null ||
677 typeof(o
.getTime
) != 'function') {
684 * Note: this only seems to work for arrays.
689 Dygraph
.clone
= function(o
) {
690 // TODO(danvk): figure out how MochiKit's version works
692 for (var i
= 0; i
< o
.length
; i
++) {
693 if (Dygraph
.isArrayLike(o
[i
])) {
694 r
.push(Dygraph
.clone(o
[i
]));
703 * Create a new canvas element. This is more complex than a simple
704 * document.createElement("canvas") because of IE and excanvas.
706 * @return {!HTMLCanvasElement}
709 Dygraph
.createCanvas
= function() {
710 var canvas
= document
.createElement("canvas");
712 var isIE
= (/MSIE/.test(navigator
.userAgent
) && !window
.opera
);
713 if (isIE
&& (typeof(G_vmlCanvasManager
) != 'undefined')) {
714 canvas
= G_vmlCanvasManager
.initElement(
715 /**@type{!HTMLCanvasElement}*/(canvas
));
722 * Returns the context's pixel ratio, which is the ratio between the device
723 * pixel ratio and the backing store ratio. Typically this is 1 for conventional
724 * displays, and > 1 for HiDPI displays (such as the Retina MBP).
725 * See http://www.html5rocks.com/en/tutorials/canvas/hidpi/ for more details.
727 * @param {!CanvasRenderingContext2D} context The canvas's 2d context.
728 * @return {number} The ratio of the device pixel ratio and the backing store
729 * ratio for the specified context.
731 Dygraph
.getContextPixelRatio
= function(context
) {
733 var devicePixelRatio
= window
.devicePixelRatio
;
734 var backingStoreRatio
= context
.webkitBackingStorePixelRatio
||
735 context
.mozBackingStorePixelRatio
||
736 context
.msBackingStorePixelRatio
||
737 context
.oBackingStorePixelRatio
||
738 context
.backingStorePixelRatio
|| 1;
739 if (devicePixelRatio
!== undefined
) {
740 return devicePixelRatio
/ backingStoreRatio
;
742 // At least devicePixelRatio must be defined for this ratio to make sense.
743 // We default backingStoreRatio to 1: this does not exist on some browsers
744 // (i.e. desktop Chrome).
753 * Checks whether the user is on an Android browser.
754 * Android does not fully support the <canvas> tag, e.g. w/r/t/ clipping.
758 Dygraph
.isAndroid
= function() {
759 return (/Android/).test(navigator
.userAgent
);
764 * TODO(danvk): use @template here when it's better supported for classes.
765 * @param {!Array} array
766 * @param {number} start
767 * @param {number} length
768 * @param {function(!Array,?):boolean=} predicate
771 Dygraph
.Iterator
= function(array
, start
, length
, predicate
) {
773 length
= length
|| array
.length
;
774 this.hasNext
= true; // Use to identify if there's another element.
775 this.peek
= null; // Use for look-ahead
778 this.predicate_
= predicate
;
779 this.end_
= Math
.min(array
.length
, start
+ length
);
780 this.nextIdx_
= start
- 1; // use -1 so initial advance works.
781 this.next(); // ignoring result.
787 Dygraph
.Iterator
.prototype.next
= function() {
793 var nextIdx
= this.nextIdx_
+ 1;
795 while (nextIdx
< this.end_
) {
796 if (!this.predicate_
|| this.predicate_(this.array_
, nextIdx
)) {
797 this.peek
= this.array_
[nextIdx
];
803 this.nextIdx_
= nextIdx
;
805 this.hasNext
= false;
812 * Returns a new iterator over array, between indexes start and
813 * start + length, and only returns entries that pass the accept function
815 * @param {!Array} array the array to iterate over.
816 * @param {number} start the first index to iterate over, 0 if absent.
817 * @param {number} length the number of elements in the array to iterate over.
818 * This, along with start, defines a slice of the array, and so length
819 * doesn't imply the number of elements in the iterator when accept doesn't
820 * always accept all values. array.length when absent.
821 * @param {function(?):boolean=} opt_predicate a function that takes
822 * parameters array and idx, which returns true when the element should be
823 * returned. If omitted, all elements are accepted.
826 Dygraph
.createIterator
= function(array
, start
, length
, opt_predicate
) {
827 return new Dygraph
.Iterator(array
, start
, length
, opt_predicate
);
830 // Shim layer with setTimeout fallback.
831 // From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
832 // Should be called with the window context:
833 // Dygraph.requestAnimFrame.call(window, function() {})
834 Dygraph
.requestAnimFrame
= (function() {
835 return window
.requestAnimationFrame
||
836 window
.webkitRequestAnimationFrame
||
837 window
.mozRequestAnimationFrame
||
838 window
.oRequestAnimationFrame
||
839 window
.msRequestAnimationFrame
||
840 function (callback
) {
841 window
.setTimeout(callback
, 1000 / 60);
846 * Call a function at most maxFrames times at an attempted interval of
847 * framePeriodInMillis, then call a cleanup function once. repeatFn is called
848 * once immediately, then at most (maxFrames - 1) times asynchronously. If
849 * maxFrames==1, then cleanup_fn() is also called synchronously. This function
850 * is used to sequence animation.
851 * @param {function(number)} repeatFn Called repeatedly -- takes the frame
852 * number (from 0 to maxFrames-1) as an argument.
853 * @param {number} maxFrames The max number of times to call repeatFn
854 * @param {number} framePeriodInMillis Max requested time between frames.
855 * @param {function()} cleanupFn A function to call after all repeatFn calls.
858 Dygraph
.repeatAndCleanup
= function(repeatFn
, maxFrames
, framePeriodInMillis
,
861 var previousFrameNumber
;
862 var startTime
= new Date().getTime();
863 repeatFn(frameNumber
);
864 if (maxFrames
== 1) {
868 var maxFrameArg
= maxFrames
- 1;
871 if (frameNumber
>= maxFrames
) return;
872 Dygraph
.requestAnimFrame
.call(window
, function() {
873 // Determine which frame to draw based on the delay so far. Will skip
874 // frames if necessary.
875 var currentTime
= new Date().getTime();
876 var delayInMillis
= currentTime
- startTime
;
877 previousFrameNumber
= frameNumber
;
878 frameNumber
= Math
.floor(delayInMillis
/ framePeriodInMillis
);
879 var frameDelta
= frameNumber
- previousFrameNumber
;
880 // If we predict that the subsequent repeatFn call will overshoot our
881 // total frame target, so our last call will cause a stutter, then jump to
882 // the last call immediately. If we're going to cause a stutter, better
883 // to do it faster than slower.
884 var predictOvershootStutter
= (frameNumber
+ frameDelta
) > maxFrameArg
;
885 if (predictOvershootStutter
|| (frameNumber
>= maxFrameArg
)) {
886 repeatFn(maxFrameArg
); // Ensure final call with maxFrameArg.
889 if (frameDelta
!== 0) { // Don't call repeatFn with duplicate frames.
890 repeatFn(frameNumber
);
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 'drawCallback': true,
909 'drawHighlightPointCallback': true,
911 'drawPointCallback': true,
915 'gridLineColor': true,
916 'gridLineWidth': true,
917 'hideOverlayOnMouseOut': true,
918 'highlightCallback': true,
919 'highlightCircleSize': true,
920 'interactionModel': true,
921 'isZoomedIgnoreProgrammaticZoom': true,
923 'labelsDivStyles': true,
924 'labelsDivWidth': true,
927 'labelsSeparateLines': true,
928 'labelsShowZeroValues': true,
930 'panEdgeFraction': true,
931 'pixelsPerYLabel': true,
932 'pointClickCallback': true,
934 'rangeSelectorPlotFillColor': true,
935 'rangeSelectorPlotStrokeColor': true,
936 'showLabelsOnHighlight': true,
939 'underlayCallback': true,
940 'unhighlightCallback': true,
945 * This function will scan the option list and determine if they
946 * require us to recalculate the pixel positions of each point.
947 * TODO: move this into dygraph-options.js
948 * @param {!Array.<string>} labels a list of options to check.
949 * @param {!Object} attrs
950 * @return {boolean} true if the graph needs new points else false.
953 Dygraph
.isPixelChangingOptionList
= function(labels
, attrs
) {
954 // Assume that we do not require new points.
955 // This will change to true if we actually do need new points.
957 // Create a dictionary of series names for faster lookup.
958 // If there are no labels, then the dictionary stays empty.
959 var seriesNamesDictionary
= { };
961 for (var i
= 1; i
< labels
.length
; i
++) {
962 seriesNamesDictionary
[labels
[i
]] = true;
966 // Scan through a flat (i.e. non-nested) object of options.
967 // Returns true/false depending on whether
new points are needed
.
968 var scanFlatOptions
= function(options
) {
969 for (var property
in options
) {
970 if (options
.hasOwnProperty(property
) &&
971 !pixelSafeOptions
[property
]) {
978 // Iterate through the list of updated options.
979 for (var property
in attrs
) {
980 if (!attrs
.hasOwnProperty(property
)) continue;
982 // Find out of this field is actually a series specific options list.
983 if (property
== 'highlightSeriesOpts' ||
984 (seriesNamesDictionary
[property
] && !attrs
.series
)) {
985 // This property value is a list of options for this series.
986 if (scanFlatOptions(attrs
[property
])) return true;
987 } else if (property
== 'series' || property
== 'axes') {
988 // This is twice-nested options list.
989 var perSeries
= attrs
[property
];
990 for (var series
in perSeries
) {
991 if (perSeries
.hasOwnProperty(series
) &&
992 scanFlatOptions(perSeries
[series
])) {
997 // If this was not a series specific option list, check if it's a pixel
998 // changing property.
999 if (!pixelSafeOptions
[property
]) return true;
1007 DEFAULT
: function(g
, name
, ctx
, canvasx
, canvasy
, color
, radius
) {
1009 ctx
.fillStyle
= color
;
1010 ctx
.arc(canvasx
, canvasy
, radius
, 0, 2 * Math
.PI
, false);
1013 // For more shapes, include extras/shapes.js
1017 * To create a "drag" interaction, you typically register a mousedown event
1018 * handler on the element where the drag begins. In that handler, you register a
1019 * mouseup handler on the window to determine when the mouse is released,
1020 * wherever that release happens. This works well, except when the user releases
1021 * the mouse over an off-domain iframe. In that case, the mouseup event is
1022 * handled by the iframe and never bubbles up to the window handler.
1024 * To deal with this issue, we cover iframes with high z-index divs to make sure
1025 * they don't capture mouseup.
1028 * element.addEventListener('mousedown', function() {
1029 * var tarper = new Dygraph.IFrameTarp();
1031 * var mouseUpHandler = function() {
1033 * window.removeEventListener(mouseUpHandler);
1036 * window.addEventListener('mouseup', mouseUpHandler);
1041 Dygraph
.IFrameTarp
= function() {
1042 /** @type {Array.<!HTMLDivElement>} */
1047 * Find all the iframes in the document and cover them with high z-index
1050 Dygraph
.IFrameTarp
.prototype.cover
= function() {
1051 var iframes
= document
.getElementsByTagName("iframe");
1052 for (var i
= 0; i
< iframes
.length
; i
++) {
1053 var iframe
= iframes
[i
];
1054 var pos
= Dygraph
.findPos(iframe
),
1057 width
= iframe
.offsetWidth
,
1058 height
= iframe
.offsetHeight
;
1060 var div
= document
.createElement("div");
1061 div
.style
.position
= "absolute";
1062 div
.style
.left
= x
+ 'px';
1063 div
.style
.top
= y
+ 'px';
1064 div
.style
.width
= width
+ 'px';
1065 div
.style
.height
= height
+ 'px';
1066 div
.style
.zIndex
= 999;
1067 document
.body
.appendChild(div
);
1068 this.tarps
.push(div
);
1073 * Remove all the iframe covers. You should call this in a mouseup handler.
1075 Dygraph
.IFrameTarp
.prototype.uncover
= function() {
1076 for (var i
= 0; i
< this.tarps
.length
; i
++) {
1077 this.tarps
[i
].parentNode
.removeChild(this.tarps
[i
]);
1083 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
1084 * @param {string} data
1085 * @return {?string} the delimiter that was detected (or null on failure).
1087 Dygraph
.detectLineDelimiter
= function(data
) {
1088 for (var i
= 0; i
< data
.length
; i
++) {
1089 var code
= data
.charAt(i
);
1090 if (code
=== '\r') {
1091 // Might actually be "\r\n".
1092 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\n')) {
1097 if (code
=== '\n') {
1098 // Might actually be "\n\r".
1099 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\r')) {
1110 * Is one node contained by another?
1111 * @param {Node} containee The contained node.
1112 * @param {Node} container The container node.
1113 * @return {boolean} Whether containee is inside (or equal to) container.
1116 Dygraph
.isNodeContainedBy
= function(containee
, container
) {
1117 if (container
=== null || containee
=== null) {
1120 var containeeNode
= /** @type {Node} */ (containee
);
1121 while (containeeNode
&& containeeNode
!== container
) {
1122 containeeNode
= containeeNode
.parentNode
;
1124 return (containeeNode
=== container
);
1128 // This masks some numeric issues in older versions of Firefox,
1129 // where 1.0/Math
.pow(10,2) != Math
.pow(10,-2).
1130 /** @type {function(number,number):number} */
1131 Dygraph
.pow
= function(base
, exp
) {
1133 return 1.0 / Math
.pow(base
, -exp
);
1135 return Math
.pow(base
, exp
);
1139 * Converts any valid CSS color (hex, rgb(), named color) to an RGB tuple.
1141 * @param {!string} colorStr Any valid CSS color string.
1142 * @return {{r:number,g:number,b:number}} Parsed RGB tuple.
1145 Dygraph
.toRGB_
= function(colorStr
) {
1146 // TODO(danvk): cache color parses to avoid repeated DOM manipulation.
1147 var div
= document
.createElement('div');
1148 div
.style
.backgroundColor
= colorStr
;
1149 div
.style
.visibility
= 'hidden';
1150 document
.body
.appendChild(div
);
1151 var rgbStr
= window
.getComputedStyle(div
, null).backgroundColor
;
1152 document
.body
.removeChild(div
);
1153 var bits
= /^rgb\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)$/.exec(rgbStr
);
1155 r
: parseInt(bits
[1], 10),
1156 g
: parseInt(bits
[2], 10),
1157 b
: parseInt(bits
[3], 10)
1162 * Checks whether the browser supports the <canvas> tag.
1163 * @param {HTMLCanvasElement=} opt_canvasElement Pass a canvas element as an
1164 * optimization if you have one.
1165 * @return {boolean} Whether the browser supports canvas.
1167 Dygraph
.isCanvasSupported
= function(opt_canvasElement
) {
1170 canvas
= opt_canvasElement
|| document
.createElement("canvas");
1171 canvas
.getContext("2d");
1174 var ie
= navigator
.appVersion
.match(/MSIE (\d\.\d)/);
1175 var opera
= (navigator
.userAgent
.toLowerCase().indexOf("opera") != -1);
1176 if ((!ie
) || (ie
[1] < 6) || (opera
))
1184 * Parses the value as a floating point number. This is like the parseFloat()
1185 * built-in, but with a few differences:
1186 * - the empty string is parsed as null, rather than NaN.
1187 * - if the string cannot be parsed at all, an error is logged.
1188 * If the string can't be parsed, this method returns null.
1189 * @param {string} x The string to be parsed
1190 * @param {number=} opt_line_no The line number from which the string comes.
1191 * @param {string=} opt_line The text of the line from which the string comes.
1193 Dygraph
.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
1194 var val
= parseFloat(x
);
1195 if (!isNaN(val
)) return val
;
1197 // Try to figure out what happeend.
1198 // If the value is the empty string, parse it as null.
1199 if (/^ *$/.test(x
)) return null;
1201 // If it was actually "NaN", return it as NaN.
1202 if (/^ *nan *$/i.test(x
)) return NaN
;
1204 // Looks like a parsing error.
1205 var msg
= "Unable to parse '" + x
+ "' as a number";
1206 if (opt_line
!== undefined
&& opt_line_no
!== undefined
) {
1207 msg
+= " on line " + (1+(opt_line_no
||0)) + " ('" + opt_line
+ "') of CSV.";