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 /*global Dygraph:false, Node:false */
17 import * as DygraphTickers from
'./dygraph-tickers';
19 export var LOG_SCALE
= 10;
20 export var LN_TEN
= Math
.log(LOG_SCALE
);
27 export var log10
= function(x
) {
28 return Math
.log(x
) / LN_TEN
;
31 /** A dotted line stroke pattern. */
32 export var DOTTED_LINE
= [2, 2];
33 /** A dashed line stroke pattern. */
34 export var DASHED_LINE
= [7, 3];
35 /** A dot dash stroke pattern. */
36 export var DOT_DASH_LINE
= [7, 2, 2, 2];
38 // Directions for panning and zooming. Use bit operations when combined
39 // values are possible.
40 export var HORIZONTAL
= 1;
41 export var VERTICAL
= 2;
44 * Return the 2d context for a dygraph canvas.
46 * This method is only exposed for the sake of replacing the function in
49 * @param {!HTMLCanvasElement} canvas
50 * @return {!CanvasRenderingContext2D}
53 export var getContext
= function(canvas
) {
54 return /** @type{!CanvasRenderingContext2D}*/(canvas
.getContext("2d"));
58 * Add an event handler.
59 * @param {!Node} elem The element to add the event to.
60 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
61 * @param {function(Event):(boolean|undefined)} fn The function to call
62 * on the event. The function takes one parameter: the event object.
65 export var addEvent
= function addEvent(elem
, type
, fn
) {
66 elem
.addEventListener(type
, fn
, false);
70 * Remove an event handler.
71 * @param {!Node} elem The element to remove the event from.
72 * @param {string} type The type of the event, e.g. 'click' or 'mousemove'.
73 * @param {function(Event):(boolean|undefined)} fn The function to call
74 * on the event. The function takes one parameter: the event object.
76 export function removeEvent(elem
, type
, fn
) {
77 elem
.removeEventListener(type
, fn
, false);
81 * Cancels further processing of an event. This is useful to prevent default
82 * browser actions, e.g. highlighting text on a double-click.
83 * Based on the article at
84 * http://www.switchonthecode.com/tutorials/javascript-tutorial-the-scroll-wheel
85 * @param {!Event} e The event whose normal behavior should be canceled.
88 export function cancelEvent(e
) {
89 e
= e
? e
: window
.event
;
90 if (e
.stopPropagation
) {
93 if (e
.preventDefault
) {
96 e
.cancelBubble
= true;
98 e
.returnValue
= false;
103 * Convert hsv values to an rgb(r,g,b) string. Taken from MochiKit.Color. This
104 * is used to generate default series colors which are evenly spaced on the
106 * @param { number } hue Range is 0.0-1.0.
107 * @param { number } saturation Range is 0.0-1.0.
108 * @param { number } value Range is 0.0-1.0.
109 * @return { string } "rgb(r,g,b)" where r, g and b range from 0-255.
112 export function hsvToRGB(hue
, saturation
, value
) {
116 if (saturation
=== 0) {
121 var i
= Math
.floor(hue
* 6);
122 var f
= (hue
* 6) - i
;
123 var p
= value
* (1 - saturation
);
124 var q
= value
* (1 - (saturation
* f
));
125 var t
= value
* (1 - (saturation
* (1 - f
)));
127 case 1: red
= q
; green
= value
; blue
= p
; break;
128 case 2: red
= p
; green
= value
; blue
= t
; break;
129 case 3: red
= p
; green
= q
; blue
= value
; break;
130 case 4: red
= t
; green
= p
; blue
= value
; break;
131 case 5: red
= value
; green
= p
; blue
= q
; break;
132 case 6: // fall through
133 case 0: red
= value
; green
= t
; blue
= p
; break;
136 red
= Math
.floor(255 * red
+ 0.5);
137 green
= Math
.floor(255 * green
+ 0.5);
138 blue
= Math
.floor(255 * blue
+ 0.5);
139 return 'rgb(' + red
+ ',' + green
+ ',' + blue
+ ')';
143 * Find the coordinates of an object relative to the top left of the page.
146 * @return {{x:number,y:number}}
149 export function findPos(obj
) {
150 var p
= obj
.getBoundingClientRect(),
152 d
= document
.documentElement
;
155 x
: p
.left
+ (w
.pageXOffset
|| d
.scrollLeft
),
156 y
: p
.top
+ (w
.pageYOffset
|| d
.scrollTop
)
161 * Returns the x-coordinate of the event in a coordinate system where the
162 * top-left corner of the page (not the window) is (0,0).
163 * Taken from MochiKit.Signal
168 export function pageX(e
) {
169 return (!e
.pageX
|| e
.pageX
< 0) ? 0 : e
.pageX
;
173 * Returns the y-coordinate of the event in a coordinate system where the
174 * top-left corner of the page (not the window) is (0,0).
175 * Taken from MochiKit.Signal
180 export function pageY(e
) {
181 return (!e
.pageY
|| e
.pageY
< 0) ? 0 : e
.pageY
;
185 * Converts page the x-coordinate of the event to pixel x-coordinates on the
186 * canvas (i.e. DOM Coords).
187 * @param {!Event} e Drag event.
188 * @param {!DygraphInteractionContext} context Interaction context object.
189 * @return {number} The amount by which the drag has moved to the right.
191 export function dragGetX_(e
, context
) {
192 return pageX(e
) - context
.px
;
196 * Converts page the y-coordinate of the event to pixel y-coordinates on the
197 * canvas (i.e. DOM Coords).
198 * @param {!Event} e Drag event.
199 * @param {!DygraphInteractionContext} context Interaction context object.
200 * @return {number} The amount by which the drag has moved down.
202 export function dragGetY_(e
, context
) {
203 return pageY(e
) - context
.py
;
207 * This returns true unless the parameter is 0, null, undefined or NaN.
208 * TODO(danvk): rename this function to something like 'isNonZeroNan'.
210 * @param {number} x The number to consider.
211 * @return {boolean} Whether the number is zero or NaN.
214 export function isOK(x
) {
215 return !!x
&& !isNaN(x
);
219 * @param {{x:?number,y:?number,yval:?number}} p The point to consider, valid
220 * points are {x, y} objects
221 * @param {boolean=} opt_allowNaNY Treat point with y=NaN as valid
222 * @return {boolean} Whether the point has numeric x and y.
225 export function isValidPoint(p
, opt_allowNaNY
) {
226 if (!p
) return false; // null or undefined object
227 if (p
.yval
=== null) return false; // missing point
228 if (p
.x
=== null || p
.x
=== undefined
) return false;
229 if (p
.y
=== null || p
.y
=== undefined
) return false;
230 if (isNaN(p
.x
) || (!opt_allowNaNY
&& isNaN(p
.y
))) return false;
235 * Number formatting function which mimicks the behavior of %g in printf, i.e.
236 * either exponential or fixed format (without trailing 0s) is used depending on
237 * the length of the generated string. The advantage of this format is that
238 * there is a predictable upper bound on the resulting string length,
239 * significant figures are not dropped, and normal numbers are not displayed in
240 * exponential notation.
242 * NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
243 * It creates strings which are too long for absolute values between 10^-4 and
244 * 10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
247 * @param {number} x The number to format
248 * @param {number=} opt_precision The precision to use, default 2.
249 * @return {string} A string formatted like %g in printf. The max generated
250 * string length should be precision + 6 (e.g 1.123e+300).
252 export function floatFormat(x
, opt_precision
) {
253 // Avoid invalid precision values; [1, 21] is the valid range.
254 var p
= Math
.min(Math
.max(1, opt_precision
|| 2), 21);
256 // This is deceptively simple. The actual algorithm comes from:
258 // Max allowed length = p + 4
259 // where 4 comes from 'e+n' and '.'.
261 // Length of fixed format = 2 + y + p
262 // where 2 comes from '0.' and y = # of leading zeroes.
264 // Equating the two and solving for y yields y = 2, or 0.00xxxx which is
267 // Since the behavior of toPrecision() is identical for larger numbers, we
268 // don't have to worry about the other bound.
270 // Finally, the argument for toExponential() is the number of trailing digits,
271 // so we take off 1 for the value before the '.'.
272 return (Math
.abs(x
) < 1.0e-3 && x
!== 0.0) ?
273 x
.toExponential(p
- 1) : x
.toPrecision(p
);
277 * Converts '9' to '09' (useful for dates)
282 export function zeropad(x
) {
283 if (x
< 10) return "0" + x
; else return "" + x
;
287 * Date accessors to get the parts of a calendar date (year, month,
288 * day, hour, minute, second and millisecond) according to local time,
289 * and factory method to call the Date constructor with an array of arguments.
291 export var DateAccessorsLocal
= {
292 getFullYear
: d
=> d
.getFullYear(),
293 getMonth
: d
=> d
.getMonth(),
294 getDate
: d
=> d
.getDate(),
295 getHours
: d
=> d
.getHours(),
296 getMinutes
: d
=> d
.getMinutes(),
297 getSeconds
: d
=> d
.getSeconds(),
298 getMilliseconds
: d
=> d
.getMilliseconds(),
299 getDay
: d
=> d
.getDay(),
300 makeDate
: function(y
, m
, d
, hh
, mm
, ss
, ms
) {
301 return new Date(y
, m
, d
, hh
, mm
, ss
, ms
);
306 * Date accessors to get the parts of a calendar date (year, month,
307 * day of month, hour, minute, second and millisecond) according to UTC time,
308 * and factory method to call the Date constructor with an array of arguments.
310 export var DateAccessorsUTC
= {
311 getFullYear
: d
=> d
.getUTCFullYear(),
312 getMonth
: d
=> d
.getUTCMonth(),
313 getDate
: d
=> d
.getUTCDate(),
314 getHours
: d
=> d
.getUTCHours(),
315 getMinutes
: d
=> d
.getUTCMinutes(),
316 getSeconds
: d
=> d
.getUTCSeconds(),
317 getMilliseconds
: d
=> d
.getUTCMilliseconds(),
318 getDay
: d
=> d
.getUTCDay(),
319 makeDate
: function(y
, m
, d
, hh
, mm
, ss
, ms
) {
320 return new Date(Date
.UTC(y
, m
, d
, hh
, mm
, ss
, ms
));
325 * Return a string version of the hours, minutes and seconds portion of a date.
326 * @param {number} hh The hours (from 0-23)
327 * @param {number} mm The minutes (from 0-59)
328 * @param {number} ss The seconds (from 0-59)
329 * @return {string} A time of the form "HH:MM" or "HH:MM:SS"
332 export function hmsString_(hh
, mm
, ss
) {
333 var zeropad
= Dygraph
.zeropad
;
334 var ret
= zeropad(hh
) + ":" + zeropad(mm
);
336 ret
+= ":" + zeropad(ss
);
342 * Convert a JS date (millis since epoch) to a formatted string.
343 * @param {number} time The JavaScript time value (ms since epoch)
344 * @param {boolean} utc Wether output UTC or local time
345 * @return {string} A date of one of these forms:
346 * "YYYY/MM/DD", "YYYY/MM/DD HH:MM" or "YYYY/MM/DD HH:MM:SS"
349 export function dateString_(time
, utc
) {
350 var accessors
= utc
? DateAccessorsUTC
: DateAccessorsLocal
;
351 var date
= new Date(time
);
352 var y
= accessors
.getFullYear(date
);
353 var m
= accessors
.getMonth(date
);
354 var d
= accessors
.getDate(date
);
355 var hh
= accessors
.getHours(date
);
356 var mm
= accessors
.getMinutes(date
);
357 var ss
= accessors
.getSeconds(date
);
358 // Get a year string:
360 // Get a 0 padded month string
361 var month
= zeropad(m
+ 1); //months are 0-offset, sigh
362 // Get a 0 padded day string
363 var day
= zeropad(d
);
364 var frac
= hh
* 3600 + mm
* 60 + ss
;
365 var ret
= year
+ "/" + month + "/" + day
;
367 ret
+= " " + hmsString_(hh
, mm
, ss
);
373 * Round a number to the specified number of digits past the decimal point.
374 * @param {number} num The number to round
375 * @param {number} places The number of decimals to which to round
376 * @return {number} The rounded number
379 export function round_(num
, places
) {
380 var shift
= Math
.pow(10, places
);
381 return Math
.round(num
* shift
)/shift
;
385 * Implementation of binary search over an array.
386 * Currently does not work when val is outside the range of arry's values.
387 * @param {number} val the value to search for
388 * @param {Array.<number>} arry is the value over which to search
389 * @param {number} abs If abs > 0, find the lowest entry greater than val
390 * If abs < 0, find the highest entry less than val.
391 * If abs == 0, find the entry that equals val.
392 * @param {number=} low The first index in arry to consider (optional)
393 * @param {number=} high The last index in arry to consider (optional)
394 * @return {number} Index of the element, or -1 if it isn't found.
397 export function binarySearch(val
, arry
, abs
, low
, high
) {
398 if (low
=== null || low
=== undefined
||
399 high
=== null || high
=== undefined
) {
401 high
= arry
.length
- 1;
406 if (abs
=== null || abs
=== undefined
) {
409 var validIndex
= function(idx
) {
410 return idx
>= 0 && idx
< arry
.length
;
412 var mid
= parseInt((low
+ high
) / 2, 10);
413 var element
= arry
[mid
];
415 if (element
== val
) {
417 } else if (element
> val
) {
419 // Accept if element > val, but also if prior element < val.
421 if (validIndex(idx
) && arry
[idx
] < val
) {
425 return binarySearch(val
, arry
, abs
, low
, mid
- 1);
426 } else if (element
< val
) {
428 // Accept if element < val, but also if prior element > val.
430 if (validIndex(idx
) && arry
[idx
] > val
) {
434 return binarySearch(val
, arry
, abs
, mid
+ 1, high
);
436 return -1; // can't actually happen, but makes closure compiler happy
440 * Parses a date, returning the number of milliseconds since epoch. This can be
441 * passed in as an xValueParser in the Dygraph constructor.
442 * TODO(danvk): enumerate formats that this understands.
444 * @param {string} dateStr A date in a variety of possible string formats.
445 * @return {number} Milliseconds since epoch.
448 export function dateParser(dateStr
) {
452 // Let the system try the format first, with one caveat:
453 // YYYY-MM-DD[ HH:MM:SS] is interpreted as UTC by a variety of browsers.
454 // dygraphs displays dates in local time, so this will result in surprising
455 // inconsistencies. But if you specify "T" or "Z" (i.e. YYYY-MM-DDTHH:MM:SS),
456 // then you probably know what you're doing, so we'll let you go ahead.
457 // Issue: http://code.google.com/p/dygraphs/issues/detail
?id
=255
458 if (dateStr
.search("-") == -1 ||
459 dateStr
.search("T") != -1 || dateStr
.search("Z") != -1) {
460 d
= dateStrToMillis(dateStr
);
461 if (d
&& !isNaN(d
)) return d
;
464 if (dateStr
.search("-") != -1) { // e.g. '2009-7-12' or '2009-07-12'
465 dateStrSlashed
= dateStr
.replace("-", "/", "g");
466 while (dateStrSlashed
.search("-") != -1) {
467 dateStrSlashed
= dateStrSlashed
.replace("-", "/");
469 d
= dateStrToMillis(dateStrSlashed
);
470 } else if (dateStr
.length
== 8) { // e.g. '20090712'
471 // TODO(danvk): remove support for this format. It's confusing.
472 dateStrSlashed
= dateStr
.substr(0,4) + "/" + dateStr.substr(4,2) + "/" +
474 d
= dateStrToMillis(dateStrSlashed
);
476 // Any format that Date.parse will accept, e.g. "2009/07/12" or
477 // "2009/07/12 12:34:56"
478 d
= dateStrToMillis(dateStr
);
481 if (!d
|| isNaN(d
)) {
482 console
.error("Couldn't parse " + dateStr
+ " as a date");
488 * This is identical to JavaScript's built-in Date.parse() method, except that
489 * it doesn't get replaced with an incompatible method by aggressive JS
490 * libraries like MooTools or Joomla.
491 * @param {string} str The date string, e.g. "2011/05/06"
492 * @return {number} millis since epoch
495 export function dateStrToMillis(str
) {
496 return new Date(str
).getTime();
499 // These functions are all based on MochiKit.
501 * Copies all the properties from o to self.
503 * @param {!Object} self
507 export function update(self
, o
) {
508 if (typeof(o
) != 'undefined' && o
!== null) {
510 if (o
.hasOwnProperty(k
)) {
519 * Copies all the properties from o to self.
521 * @param {!Object} self
526 export function updateDeep(self
, o
) {
527 // Taken from http://stackoverflow.com/questions
/384286/javascript
-isdom
-how
-do-you
-check
-if-a
-javascript
-object
-is
-a
-dom
-object
530 typeof Node
=== "object" ? o
instanceof Node
:
531 typeof o
=== "object" && typeof o
.nodeType
=== "number" && typeof o
.nodeName
==="string"
535 if (typeof(o
) != 'undefined' && o
!== null) {
537 if (o
.hasOwnProperty(k
)) {
540 } else if (isArrayLike(o
[k
])) {
541 self
[k
] = o
[k
].slice();
542 } else if (isNode(o
[k
])) {
543 // DOM objects are shallowly-copied.
545 } else if (typeof(o
[k
]) == 'object') {
546 if (typeof(self
[k
]) != 'object' || self
[k
] === null) {
549 updateDeep(self
[k
], o
[k
]);
564 export function isArrayLike(o
) {
567 (typ
!= 'object' && !(typ
== 'function' &&
568 typeof(o
.item
) == 'function')) ||
570 typeof(o
.length
) != 'number' ||
583 export function isDateLike(o
) {
584 if (typeof(o
) != "object" || o
=== null ||
585 typeof(o
.getTime
) != 'function') {
592 * Note: this only seems to work for arrays.
597 export function clone(o
) {
598 // TODO(danvk): figure out how MochiKit's version works
600 for (var i
= 0; i
< o
.length
; i
++) {
601 if (isArrayLike(o
[i
])) {
602 r
.push(Dygraph
.clone(o
[i
]));
611 * Create a new canvas element.
613 * @return {!HTMLCanvasElement}
616 export function createCanvas() {
617 return document
.createElement('canvas');
621 * Returns the context's pixel ratio, which is the ratio between the device
622 * pixel ratio and the backing store ratio. Typically this is 1 for conventional
623 * displays, and > 1 for HiDPI displays (such as the Retina MBP).
624 * See http://www.html5rocks.com/en/tutorials/canvas/hidpi/ for more details.
626 * @param {!CanvasRenderingContext2D} context The canvas's 2d context.
627 * @return {number} The ratio of the device pixel ratio and the backing store
628 * ratio for the specified context.
630 export function getContextPixelRatio(context
) {
632 var devicePixelRatio
= window
.devicePixelRatio
;
633 var backingStoreRatio
= context
.webkitBackingStorePixelRatio
||
634 context
.mozBackingStorePixelRatio
||
635 context
.msBackingStorePixelRatio
||
636 context
.oBackingStorePixelRatio
||
637 context
.backingStorePixelRatio
|| 1;
638 if (devicePixelRatio
!== undefined
) {
639 return devicePixelRatio
/ backingStoreRatio
;
641 // At least devicePixelRatio must be defined for this ratio to make sense.
642 // We default backingStoreRatio to 1: this does not exist on some browsers
643 // (i.e. desktop Chrome).
652 * Checks whether the user is on an Android browser.
653 * Android does not fully support the <canvas> tag, e.g. w/r/t/ clipping.
657 export function isAndroid() {
658 return (/Android/).test(navigator
.userAgent
);
663 * TODO(danvk): use @template here when it's better supported for classes.
664 * @param {!Array} array
665 * @param {number} start
666 * @param {number} length
667 * @param {function(!Array,?):boolean=} predicate
670 export function Iterator(array
, start
, length
, predicate
) {
672 length
= length
|| array
.length
;
673 this.hasNext
= true; // Use to identify if there's another element.
674 this.peek
= null; // Use for look-ahead
677 this.predicate_
= predicate
;
678 this.end_
= Math
.min(array
.length
, start
+ length
);
679 this.nextIdx_
= start
- 1; // use -1 so initial advance works.
680 this.next(); // ignoring result.
686 Iterator
.prototype.next
= function() {
692 var nextIdx
= this.nextIdx_
+ 1;
694 while (nextIdx
< this.end_
) {
695 if (!this.predicate_
|| this.predicate_(this.array_
, nextIdx
)) {
696 this.peek
= this.array_
[nextIdx
];
702 this.nextIdx_
= nextIdx
;
704 this.hasNext
= false;
711 * Returns a new iterator over array, between indexes start and
712 * start + length, and only returns entries that pass the accept function
714 * @param {!Array} array the array to iterate over.
715 * @param {number} start the first index to iterate over, 0 if absent.
716 * @param {number} length the number of elements in the array to iterate over.
717 * This, along with start, defines a slice of the array, and so length
718 * doesn't imply the number of elements in the iterator when accept doesn't
719 * always accept all values. array.length when absent.
720 * @param {function(?):boolean=} opt_predicate a function that takes
721 * parameters array and idx, which returns true when the element should be
722 * returned. If omitted, all elements are accepted.
725 export function createIterator(array
, start
, length
, opt_predicate
) {
726 return new Iterator(array
, start
, length
, opt_predicate
);
729 // Shim layer with setTimeout fallback.
730 // From: http://paulirish.com/2011/requestanimationframe-for-smart-animating/
731 // Should be called with the window context:
732 // Dygraph.requestAnimFrame.call(window, function() {})
733 export var requestAnimFrame
= (function() {
734 return window
.requestAnimationFrame
||
735 window
.webkitRequestAnimationFrame
||
736 window
.mozRequestAnimationFrame
||
737 window
.oRequestAnimationFrame
||
738 window
.msRequestAnimationFrame
||
739 function (callback
) {
740 window
.setTimeout(callback
, 1000 / 60);
745 * Call a function at most maxFrames times at an attempted interval of
746 * framePeriodInMillis, then call a cleanup function once. repeatFn is called
747 * once immediately, then at most (maxFrames - 1) times asynchronously. If
748 * maxFrames==1, then cleanup_fn() is also called synchronously. This function
749 * is used to sequence animation.
750 * @param {function(number)} repeatFn Called repeatedly -- takes the frame
751 * number (from 0 to maxFrames-1) as an argument.
752 * @param {number} maxFrames The max number of times to call repeatFn
753 * @param {number} framePeriodInMillis Max requested time between frames.
754 * @param {function()} cleanupFn A function to call after all repeatFn calls.
757 export function repeatAndCleanup(repeatFn
, maxFrames
, framePeriodInMillis
,
760 var previousFrameNumber
;
761 var startTime
= new Date().getTime();
762 repeatFn(frameNumber
);
763 if (maxFrames
== 1) {
767 var maxFrameArg
= maxFrames
- 1;
770 if (frameNumber
>= maxFrames
) return;
771 Dygraph
.requestAnimFrame
.call(window
, function() {
772 // Determine which frame to draw based on the delay so far. Will skip
773 // frames if necessary.
774 var currentTime
= new Date().getTime();
775 var delayInMillis
= currentTime
- startTime
;
776 previousFrameNumber
= frameNumber
;
777 frameNumber
= Math
.floor(delayInMillis
/ framePeriodInMillis
);
778 var frameDelta
= frameNumber
- previousFrameNumber
;
779 // If we predict that the subsequent repeatFn call will overshoot our
780 // total frame target, so our last call will cause a stutter, then jump to
781 // the last call immediately. If we're going to cause a stutter, better
782 // to do it faster than slower.
783 var predictOvershootStutter
= (frameNumber
+ frameDelta
) > maxFrameArg
;
784 if (predictOvershootStutter
|| (frameNumber
>= maxFrameArg
)) {
785 repeatFn(maxFrameArg
); // Ensure final call with maxFrameArg.
788 if (frameDelta
!== 0) { // Don't call repeatFn with duplicate frames.
789 repeatFn(frameNumber
);
797 // A whitelist of options that do not change pixel positions.
798 var pixelSafeOptions
= {
799 'annotationClickHandler': true,
800 'annotationDblClickHandler': true,
801 'annotationMouseOutHandler': true,
802 'annotationMouseOverHandler': true,
803 'axisLabelColor': true,
804 'axisLineColor': true,
805 'axisLineWidth': true,
806 'clickCallback': true,
807 'drawCallback': true,
808 'drawHighlightPointCallback': true,
810 'drawPointCallback': true,
813 'gridLineColor': true,
814 'gridLineWidth': true,
815 'hideOverlayOnMouseOut': true,
816 'highlightCallback': true,
817 'highlightCircleSize': true,
818 'interactionModel': true,
819 'isZoomedIgnoreProgrammaticZoom': true,
821 'labelsDivStyles': true,
822 'labelsDivWidth': true,
825 'labelsSeparateLines': true,
826 'labelsShowZeroValues': true,
828 'panEdgeFraction': true,
829 'pixelsPerYLabel': true,
830 'pointClickCallback': true,
832 'rangeSelectorPlotFillColor': true,
833 'rangeSelectorPlotFillGradientColor': true,
834 'rangeSelectorPlotStrokeColor': true,
835 'rangeSelectorBackgroundStrokeColor': true,
836 'rangeSelectorBackgroundLineWidth': true,
837 'rangeSelectorPlotLineWidth': true,
838 'rangeSelectorForegroundStrokeColor': true,
839 'rangeSelectorForegroundLineWidth': true,
840 'rangeSelectorAlpha': true,
841 'showLabelsOnHighlight': true,
844 'underlayCallback': true,
845 'unhighlightCallback': true,
850 * This function will scan the option list and determine if they
851 * require us to recalculate the pixel positions of each point.
852 * TODO: move this into dygraph-options.js
853 * @param {!Array.<string>} labels a list of options to check.
854 * @param {!Object} attrs
855 * @return {boolean} true if the graph needs new points else false.
858 export function isPixelChangingOptionList(labels
, attrs
) {
859 // Assume that we do not require new points.
860 // This will change to true if we actually do need new points.
862 // Create a dictionary of series names for faster lookup.
863 // If there are no labels, then the dictionary stays empty.
864 var seriesNamesDictionary
= { };
866 for (var i
= 1; i
< labels
.length
; i
++) {
867 seriesNamesDictionary
[labels
[i
]] = true;
871 // Scan through a flat (i.e. non-nested) object of options.
872 // Returns true/false depending on whether
new points are needed
.
873 var scanFlatOptions
= function(options
) {
874 for (var property
in options
) {
875 if (options
.hasOwnProperty(property
) &&
876 !pixelSafeOptions
[property
]) {
883 // Iterate through the list of updated options.
884 for (var property
in attrs
) {
885 if (!attrs
.hasOwnProperty(property
)) continue;
887 // Find out of this field is actually a series specific options list.
888 if (property
== 'highlightSeriesOpts' ||
889 (seriesNamesDictionary
[property
] && !attrs
.series
)) {
890 // This property value is a list of options for this series.
891 if (scanFlatOptions(attrs
[property
])) return true;
892 } else if (property
== 'series' || property
== 'axes') {
893 // This is twice-nested options list.
894 var perSeries
= attrs
[property
];
895 for (var series
in perSeries
) {
896 if (perSeries
.hasOwnProperty(series
) &&
897 scanFlatOptions(perSeries
[series
])) {
902 // If this was not a series specific option list, check if it's a pixel
903 // changing property.
904 if (!pixelSafeOptions
[property
]) return true;
911 export var Circles
= {
912 DEFAULT
: function(g
, name
, ctx
, canvasx
, canvasy
, color
, radius
) {
914 ctx
.fillStyle
= color
;
915 ctx
.arc(canvasx
, canvasy
, radius
, 0, 2 * Math
.PI
, false);
918 // For more shapes, include extras/shapes.js
922 * To create a "drag" interaction, you typically register a mousedown event
923 * handler on the element where the drag begins. In that handler, you register a
924 * mouseup handler on the window to determine when the mouse is released,
925 * wherever that release happens. This works well, except when the user releases
926 * the mouse over an off-domain iframe. In that case, the mouseup event is
927 * handled by the iframe and never bubbles up to the window handler.
929 * To deal with this issue, we cover iframes with high z-index divs to make sure
930 * they don't capture mouseup.
933 * element.addEventListener('mousedown', function() {
934 * var tarper = new utils.IFrameTarp();
936 * var mouseUpHandler = function() {
938 * window.removeEventListener(mouseUpHandler);
941 * window.addEventListener('mouseup', mouseUpHandler);
946 export function IFrameTarp() {
947 /** @type {Array.<!HTMLDivElement>} */
952 * Find all the iframes in the document and cover them with high z-index
955 IFrameTarp
.prototype.cover
= function() {
956 var iframes
= document
.getElementsByTagName("iframe");
957 for (var i
= 0; i
< iframes
.length
; i
++) {
958 var iframe
= iframes
[i
];
959 var pos
= Dygraph
.findPos(iframe
),
962 width
= iframe
.offsetWidth
,
963 height
= iframe
.offsetHeight
;
965 var div
= document
.createElement("div");
966 div
.style
.position
= "absolute";
967 div
.style
.left
= x
+ 'px';
968 div
.style
.top
= y
+ 'px';
969 div
.style
.width
= width
+ 'px';
970 div
.style
.height
= height
+ 'px';
971 div
.style
.zIndex
= 999;
972 document
.body
.appendChild(div
);
973 this.tarps
.push(div
);
978 * Remove all the iframe covers. You should call this in a mouseup handler.
980 IFrameTarp
.prototype.uncover
= function() {
981 for (var i
= 0; i
< this.tarps
.length
; i
++) {
982 this.tarps
[i
].parentNode
.removeChild(this.tarps
[i
]);
988 * Determine whether |data| is delimited by CR, CRLF, LF, LFCR.
989 * @param {string} data
990 * @return {?string} the delimiter that was detected (or null on failure).
992 export function detectLineDelimiter(data
) {
993 for (var i
= 0; i
< data
.length
; i
++) {
994 var code
= data
.charAt(i
);
996 // Might actually be "\r\n".
997 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\n')) {
1002 if (code
=== '\n') {
1003 // Might actually be "\n\r".
1004 if (((i
+ 1) < data
.length
) && (data
.charAt(i
+ 1) === '\r')) {
1015 * Is one node contained by another?
1016 * @param {Node} containee The contained node.
1017 * @param {Node} container The container node.
1018 * @return {boolean} Whether containee is inside (or equal to) container.
1021 export function isNodeContainedBy(containee
, container
) {
1022 if (container
=== null || containee
=== null) {
1025 var containeeNode
= /** @type {Node} */ (containee
);
1026 while (containeeNode
&& containeeNode
!== container
) {
1027 containeeNode
= containeeNode
.parentNode
;
1029 return (containeeNode
=== container
);
1033 // This masks some numeric issues in older versions of Firefox,
1034 // where 1.0/Math
.pow(10,2) != Math
.pow(10,-2).
1035 /** @type {function(number,number):number} */
1036 export function pow(base
, exp
) {
1038 return 1.0 / Math
.pow(base
, -exp
);
1040 return Math
.pow(base
, exp
);
1043 var RGBA_RE
= /^rgba?\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})(?:,\s*([01](?:\.\d+)?))?\)$/;
1046 * Helper for Dygraph.toRGB_ which parses strings of the form:
1048 * rgba(123, 45, 67, 0.5)
1049 * @return parsed {r,g,b,a?} tuple or null.
1051 function parseRGBA(rgbStr
) {
1052 var bits
= RGBA_RE
.exec(rgbStr
);
1053 if (!bits
) return null;
1054 var r
= parseInt(bits
[1], 10),
1055 g
= parseInt(bits
[2], 10),
1056 b
= parseInt(bits
[3], 10);
1058 return {r
: r
, g
: g
, b
: b
, a
: parseFloat(bits
[4])};
1060 return {r
: r
, g
: g
, b
: b
};
1065 * Converts any valid CSS color (hex, rgb(), named color) to an RGB tuple.
1067 * @param {!string} colorStr Any valid CSS color string.
1068 * @return {{r:number,g:number,b:number,a:number?}} Parsed RGB tuple.
1071 export function toRGB_(colorStr
) {
1072 // Strategy: First try to parse colorStr directly. This is fast & avoids DOM
1073 // manipulation. If that fails (e.g. for named colors like 'red'), then
1074 // create a hidden DOM element and parse its computed color.
1075 var rgb
= parseRGBA(colorStr
);
1076 if (rgb
) return rgb
;
1078 var div
= document
.createElement('div');
1079 div
.style
.backgroundColor
= colorStr
;
1080 div
.style
.visibility
= 'hidden';
1081 document
.body
.appendChild(div
);
1082 var rgbStr
= window
.getComputedStyle(div
, null).backgroundColor
;
1083 document
.body
.removeChild(div
);
1084 return parseRGBA(rgbStr
);
1088 * Checks whether the browser supports the <canvas> tag.
1089 * @param {HTMLCanvasElement=} opt_canvasElement Pass a canvas element as an
1090 * optimization if you have one.
1091 * @return {boolean} Whether the browser supports canvas.
1093 export function isCanvasSupported(opt_canvasElement
) {
1095 var canvas
= opt_canvasElement
|| document
.createElement("canvas");
1096 canvas
.getContext("2d");
1104 * Parses the value as a floating point number. This is like the parseFloat()
1105 * built-in, but with a few differences:
1106 * - the empty string is parsed as null, rather than NaN.
1107 * - if the string cannot be parsed at all, an error is logged.
1108 * If the string can't be parsed, this method returns null.
1109 * @param {string} x The string to be parsed
1110 * @param {number=} opt_line_no The line number from which the string comes.
1111 * @param {string=} opt_line The text of the line from which the string comes.
1113 export function parseFloat_(x
, opt_line_no
, opt_line
) {
1114 var val
= parseFloat(x
);
1115 if (!isNaN(val
)) return val
;
1117 // Try to figure out what happeend.
1118 // If the value is the empty string, parse it as null.
1119 if (/^ *$/.test(x
)) return null;
1121 // If it was actually "NaN", return it as NaN.
1122 if (/^ *nan *$/i.test(x
)) return NaN
;
1124 // Looks like a parsing error.
1125 var msg
= "Unable to parse '" + x
+ "' as a number";
1126 if (opt_line
!== undefined
&& opt_line_no
!== undefined
) {
1127 msg
+= " on line " + (1+(opt_line_no
||0)) + " ('" + opt_line
+ "') of CSV.";
1135 // Label constants for the labelsKMB and labelsKMG2 options.
1136 // (i.e. '100000' -> '100K')
1137 var KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
1138 var KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
1139 var KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
1143 * Return a string version of a number. This respects the digitsAfterDecimal
1144 * and maxNumberWidth options.
1145 * @param {number} x The number to be formatted
1146 * @param {Dygraph} opts An options view
1148 export function numberValueFormatter(x
, opts
) {
1149 var sigFigs
= opts('sigFigs');
1151 if (sigFigs
!== null) {
1152 // User has opted for a fixed number of significant figures.
1153 return floatFormat(x
, sigFigs
);
1156 var digits
= opts('digitsAfterDecimal');
1157 var maxNumberWidth
= opts('maxNumberWidth');
1159 var kmb
= opts('labelsKMB');
1160 var kmg2
= opts('labelsKMG2');
1164 // switch to scientific notation if we underflow or overflow fixed display.
1166 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
1167 Math
.abs(x
) < Math
.pow(10, -digits
))) {
1168 label
= x
.toExponential(digits
);
1170 label
= '' + round_(x
, digits
);
1179 k_labels
= KMB_LABELS
;
1182 if (kmb
) console
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
1184 k_labels
= KMG2_BIG_LABELS
;
1185 m_labels
= KMG2_SMALL_LABELS
;
1188 var absx
= Math
.abs(x
);
1189 var n
= pow(k
, k_labels
.length
);
1190 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
1192 label
= round_(x
/ n
, digits
) + k_labels
[j
];
1197 // TODO(danvk): clean up this logic. Why so different than kmb?
1198 var x_parts
= String(x
.toExponential()).split('e-');
1199 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
1200 if (x_parts
[1] % 3 > 0) {
1201 label
= round_(x_parts
[0] /
1202 pow(10, (x_parts
[1] % 3)),
1205 label
= Number(x_parts
[0]).toFixed(2);
1207 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
1216 * variant for use as an axisLabelFormatter.
1219 export function numberAxisLabelFormatter(x
, granularity
, opts
) {
1220 return numberValueFormatter
.call(this, x
, opts
);
1224 * @type {!Array.<string>}
1228 var SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
1232 * Convert a JS date to a string appropriate to display on an axis that
1233 * is displaying values at the stated granularity. This respects the
1235 * @param {Date} date The date to format
1236 * @param {number} granularity One of the Dygraph granularity constants
1237 * @param {Dygraph} opts An options view
1238 * @return {string} The date formatted as local time
1241 export function dateAxisLabelFormatter(date
, granularity
, opts
) {
1242 var utc
= opts('labelsUTC');
1243 var accessors
= utc
? DateAccessorsUTC
: DateAccessorsLocal
;
1245 var year
= accessors
.getFullYear(date
),
1246 month
= accessors
.getMonth(date
),
1247 day
= accessors
.getDate(date
),
1248 hours
= accessors
.getHours(date
),
1249 mins
= accessors
.getMinutes(date
),
1250 secs
= accessors
.getSeconds(date
),
1251 millis
= accessors
.getSeconds(date
);
1253 if (granularity
>= DygraphTickers
.Granularity
.DECADAL
) {
1255 } else if (granularity
>= DygraphTickers
.Granularity
.MONTHLY
) {
1256 return SHORT_MONTH_NAMES_
[month
] + ' ' + year
;
1258 var frac
= hours
* 3600 + mins
* 60 + secs
+ 1e-3 * millis
;
1259 if (frac
=== 0 || granularity
>= DygraphTickers
.Granularity
.DAILY
) {
1260 // e.g. '21 Jan' (%d%b)
1261 return zeropad(day
) + ' ' + SHORT_MONTH_NAMES_
[month
];
1263 return hmsString_(hours
, mins
, secs
);
1267 // alias in case anyone is referencing the old method.
1268 // Dygraph.dateAxisFormatter = Dygraph.dateAxisLabelFormatter;
1271 * Return a string version of a JS date for a value label. This respects the
1273 * @param {Date} date The date to be formatted
1274 * @param {Dygraph} opts An options view
1277 export function dateValueFormatter(d
, opts
) {
1278 return dateString_(d
, opts('labelsUTC'));