3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 // These have to go above the "Hack for IE" in __init__ since .ready() can be
66 // called as soon as the constructor returns. Once support for OldIE is
67 // dropped, this can go down with the rest of the initializers.
68 this.is_initial_draw_
= true;
71 if (opt_fourth_param
!== undefined
) {
72 // Old versions of dygraphs took in the series labels as a constructor
73 // parameter. This doesn't make sense anymore, but it's easy to continue
74 // to support this usage.
75 this.warn("Using deprecated four-argument dygraph constructor");
76 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
78 this.__init__(div
, data
, opts
);
82 Dygraph
.NAME
= "Dygraph";
83 Dygraph
.VERSION
= "1.0.1";
84 Dygraph
.__repr__
= function() {
85 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
89 * Returns information about the Dygraph class.
91 Dygraph
.toString
= function() {
92 return this.__repr__();
95 // Various default values
96 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
97 Dygraph
.DEFAULT_WIDTH
= 480;
98 Dygraph
.DEFAULT_HEIGHT
= 320;
100 // For max 60 Hz. animation:
101 Dygraph
.ANIMATION_STEPS
= 12;
102 Dygraph
.ANIMATION_DURATION
= 200;
104 // Label constants for the labelsKMB and labelsKMG2 options.
105 // (i.e. '100000' -> '100K')
106 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
107 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
108 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
110 // These are defined before DEFAULT_ATTRS so that it can refer to them.
113 * Return a string version of a number. This respects the digitsAfterDecimal
114 * and maxNumberWidth options.
115 * @param {Number} x The number to be formatted
116 * @param {Dygraph} opts An options view
117 * @param {String} name The name of the point's data series
118 * @param {Dygraph} g The dygraph object
120 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
121 var sigFigs
= opts('sigFigs');
123 if (sigFigs
!== null) {
124 // User has opted for a fixed number of significant figures.
125 return Dygraph
.floatFormat(x
, sigFigs
);
128 var digits
= opts('digitsAfterDecimal');
129 var maxNumberWidth
= opts('maxNumberWidth');
131 var kmb
= opts('labelsKMB');
132 var kmg2
= opts('labelsKMG2');
136 // switch to scientific notation if we underflow or overflow fixed display.
138 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
139 Math
.abs(x
) < Math
.pow(10, -digits
))) {
140 label
= x
.toExponential(digits
);
142 label
= '' + Dygraph
.round_(x
, digits
);
151 k_labels
= Dygraph
.KMB_LABELS
;
154 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
156 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
157 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
160 var absx
= Math
.abs(x
);
161 var n
= Dygraph
.pow(k
, k_labels
.length
);
162 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
164 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
169 // TODO(danvk): clean up this logic. Why so different than kmb?
170 var x_parts
= String(x
.toExponential()).split('e-');
171 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
172 if (x_parts
[1] % 3 > 0) {
173 label
= Dygraph
.round_(x_parts
[0] /
174 Dygraph
.pow(10, (x_parts
[1] % 3)),
177 label
= Number(x_parts
[0]).toFixed(2);
179 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
188 * variant for use as an axisLabelFormatter.
191 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
192 return Dygraph
.numberValueFormatter(x
, opts
, g
);
196 * Convert a JS date (millis since epoch) to YYYY/MM/DD
197 * @param {Number} date The JavaScript date (ms since epoch)
198 * @return {String} A date of the form "YYYY/MM/DD"
201 Dygraph
.dateString_
= function(date
) {
202 var zeropad
= Dygraph
.zeropad
;
203 var d
= new Date(date
);
206 var year
= "" + d
.getFullYear();
207 // Get a 0 padded month string
208 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
209 // Get a 0 padded day string
210 var day
= zeropad(d
.getDate());
213 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
214 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
216 return year
+ "/" + month + "/" + day
+ ret
;
220 * Convert a JS date to a string appropriate to display on an axis that
221 * is displaying values at the stated granularity.
222 * @param {Date} date The date to format
223 * @param {Number} granularity One of the Dygraph granularity constants
224 * @return {String} The formatted date
227 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
228 if (granularity
>= Dygraph
.DECADAL
) {
229 return date
.strftime('%Y');
230 } else if (granularity
>= Dygraph
.MONTHLY
) {
231 return date
.strftime('%b %y');
233 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
234 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
235 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
237 return Dygraph
.hmsString_(date
.getTime());
243 * Standard plotters. These may be used by clients.
244 * Available plotters are:
245 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
246 * - Dygraph.Plotters.errorPlotter: draws error bars
247 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
249 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
250 * This causes all the lines to be drawn over all the fills/error bars.
252 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
255 // Default attribute values.
256 Dygraph
.DEFAULT_ATTRS
= {
257 highlightCircleSize
: 3,
258 highlightSeriesOpts
: null,
259 highlightSeriesBackgroundAlpha
: 0.5,
263 // TODO(danvk): move defaults from createStatusMessage_ here.
265 labelsSeparateLines
: false,
266 labelsShowZeroValues
: true,
269 showLabelsOnHighlight
: true,
271 digitsAfterDecimal
: 2,
276 strokeBorderWidth
: 0,
277 strokeBorderColor
: "white",
280 axisLabelFontSize
: 14,
286 xValueParser
: Dygraph
.dateParser
,
293 wilsonInterval
: true, // only relevant if fractions is true
297 connectSeparatedPoints
: false,
300 stackedGraphNaNFill
: 'all',
301 hideOverlayOnMouseOut
: true,
303 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
304 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
310 drawAxesAtZero
: false,
312 // Sizes of the various chart labels.
319 axisLineColor
: "black",
322 axisLabelColor
: "black",
323 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
327 gridLineColor
: "rgb(128,128,128)",
329 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
330 animatedZooms
: false, // (for now)
332 // Range selector options
333 showRangeSelector
: false,
334 rangeSelectorHeight
: 40,
335 rangeSelectorPlotStrokeColor
: "#808FAB",
336 rangeSelectorPlotFillColor
: "#A7B1C4",
338 // The ordering here ensures that central lines always appear above any
339 // fill bars/error bars
.
341 Dygraph
.Plotters
.fillPlotter
,
342 Dygraph
.Plotters
.errorPlotter
,
343 Dygraph
.Plotters
.linePlotter
352 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
353 valueFormatter
: Dygraph
.dateString_
,
356 independentTicks
: true,
357 ticker
: null // will be set in dygraph-tickers.js
361 valueFormatter
: Dygraph
.numberValueFormatter
,
362 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
365 independentTicks
: true,
366 ticker
: null // will be set in dygraph-tickers.js
370 valueFormatter
: Dygraph
.numberValueFormatter
,
371 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
374 independentTicks
: false,
375 ticker
: null // will be set in dygraph-tickers.js
380 // Directions for panning and zooming. Use bit operations when combined
381 // values are possible.
382 Dygraph
.HORIZONTAL
= 1;
383 Dygraph
.VERTICAL
= 2;
385 // Installed plugins, in order of precedence (most-general to most-specific).
386 // Plugins are installed after they are defined, in plugins/install.js
.
390 // Used for initializing annotation CSS rules only once.
391 Dygraph
.addedAnnotationCSS
= false;
393 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
394 // Labels is no longer a constructor parameter, since it's typically set
395 // directly from the data source. It also conains a name for the x-axis,
396 // which the previous constructor form did not.
397 if (labels
!== null) {
398 var new_labels
= ["Date"];
399 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
400 Dygraph
.update(attrs
, { 'labels': new_labels
});
402 this.__init__(div
, file
, attrs
);
406 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
407 * and context <canvas> inside of it. See the constructor for details.
409 * @param {Element} div the Element to render the graph into.
410 * @param {String | Function} file Source data
411 * @param {Object} attrs Miscellaneous other options
414 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
415 // Hack for IE: if we're using excanvas and the document hasn't finished
416 // loading yet (and hence may not have initialized whatever it needs to
417 // initialize), then keep calling this routine periodically until it has.
418 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
419 typeof(G_vmlCanvasManager
) != 'undefined' &&
420 document
.readyState
!= 'complete') {
422 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
426 // Support two-argument constructor
427 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
429 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
431 if (typeof(div
) == 'string') {
432 div
= document
.getElementById(div
);
436 Dygraph
.error("Constructing dygraph with a non-existent div!");
440 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
442 // Copy the important bits into the object
443 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
446 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
447 this.previousVerticalX_
= -1;
448 this.fractions_
= attrs
.fractions
|| false;
449 this.dateWindow_
= attrs
.dateWindow
|| null;
451 this.annotations_
= [];
453 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
454 this.zoomed_x_
= false;
455 this.zoomed_y_
= false;
457 // Clear the div. This ensure that, if multiple dygraphs are passed the same
458 // div, then only one will be drawn.
461 // For historical reasons, the 'width' and 'height' options trump all CSS
462 // rules _except_ for an explicit 'width' or 'height' on the div.
463 // As an added convenience, if the div has zero height (like <div></div> does
464 // without any styles), then we use a default height/width
.
465 if (div
.style
.width
=== '' && attrs
.width
) {
466 div
.style
.width
= attrs
.width
+ "px";
468 if (div
.style
.height
=== '' && attrs
.height
) {
469 div
.style
.height
= attrs
.height
+ "px";
471 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
472 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
473 if (div
.style
.width
=== '') {
474 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
477 // These will be zero if the dygraph's div is hidden. In that case,
478 // use the user-specified attributes if present. If not, use zero
479 // and assume the user will call resize to fix things later.
480 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
481 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
483 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
484 if (attrs
.stackedGraph
) {
485 attrs
.fillGraph
= true;
486 // TODO(nikhilk): Add any other stackedGraph checks here.
489 // DEPRECATION WARNING: All option processing should be moved from
490 // attrs_ and user_attrs_ to options_, which holds all this information.
492 // Dygraphs has many options, some of which interact with one another.
493 // To keep track of everything, we maintain two sets of options:
495 // this.user_attrs_ only options explicitly set by the user.
496 // this.attrs_ defaults, options derived from user_attrs_, data.
498 // Options are then accessed this.attr_('attr'), which first looks at
499 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
500 // defaults without overriding behavior that the user specifically asks for.
501 this.user_attrs_
= {};
502 Dygraph
.update(this.user_attrs_
, attrs
);
504 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
506 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
508 this.boundaryIds_
= [];
509 this.setIndexByName_
= {};
510 this.datasetIndex_
= [];
512 this.registeredEvents_
= [];
513 this.eventListeners_
= {};
515 this.attributes_
= new DygraphOptions(this);
517 // Create the containing DIV and other interactive elements
518 this.createInterface_();
522 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
523 for (var i
= 0; i
< plugins
.length
; i
++) {
524 var Plugin
= plugins
[i
];
525 var pluginInstance
= new Plugin();
527 plugin
: pluginInstance
,
533 var handlers
= pluginInstance
.activate(this);
534 for (var eventName
in handlers
) {
535 // TODO(danvk): validate eventName.
536 pluginDict
.events
[eventName
] = handlers
[eventName
];
539 this.plugins_
.push(pluginDict
);
542 // At this point, plugins can no longer register event handlers.
543 // Construct a map from event -> ordered list of [callback, plugin].
544 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
545 var plugin_dict
= this.plugins_
[i
];
546 for (var eventName
in plugin_dict
.events
) {
547 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
548 var callback
= plugin_dict
.events
[eventName
];
550 var pair
= [plugin_dict
.plugin
, callback
];
551 if (!(eventName
in this.eventListeners_
)) {
552 this.eventListeners_
[eventName
] = [pair
];
554 this.eventListeners_
[eventName
].push(pair
);
559 this.createDragInterface_();
565 * Triggers a cascade of events to the various plugins which are interested in them.
566 * Returns true if the "default behavior" should be performed, i.e. if none of
567 * the event listeners called event.preventDefault().
570 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
571 if (!(name
in this.eventListeners_
)) return true;
573 // QUESTION: can we use objects & prototypes to speed this up?
577 defaultPrevented
: false,
578 preventDefault
: function() {
579 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
580 e
.defaultPrevented
= true;
582 propagationStopped
: false,
583 stopPropagation
: function() {
584 e
.propagationStopped
= true;
587 Dygraph
.update(e
, extra_props
);
589 var callback_plugin_pairs
= this.eventListeners_
[name
];
590 if (callback_plugin_pairs
) {
591 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
592 var plugin
= callback_plugin_pairs
[i
][0];
593 var callback
= callback_plugin_pairs
[i
][1];
594 callback
.call(plugin
, e
);
595 if (e
.propagationStopped
) break;
598 return e
.defaultPrevented
;
602 * Returns the zoomed status of the chart for one or both axes.
604 * Axis is an optional parameter. Can be set to 'x' or 'y'.
606 * The zoomed status for an axis is set whenever a user zooms using the mouse
607 * or when the dateWindow or valueRange are updated (unless the
608 * isZoomedIgnoreProgrammaticZoom option is also specified).
610 Dygraph
.prototype.isZoomed
= function(axis
) {
611 if (axis
=== null || axis
=== undefined
) {
612 return this.zoomed_x_
|| this.zoomed_y_
;
614 if (axis
=== 'x') return this.zoomed_x_
;
615 if (axis
=== 'y') return this.zoomed_y_
;
616 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
620 * Returns information about the Dygraph object, including its containing ID.
622 Dygraph
.prototype.toString
= function() {
623 var maindiv
= this.maindiv_
;
624 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
625 return "[Dygraph " + id
+ "]";
630 * Returns the value of an option. This may be set by the user (either in the
631 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
633 * @param { String } name The name of the option, e.g. 'rollPeriod'.
634 * @param { String } [seriesName] The name of the series to which the option
635 * will be applied. If no per-series value of this option is available, then
636 * the global value is returned. This is optional.
637 * @return { ... } The value of the option.
639 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
640 // <REMOVE_FOR_COMBINED>
641 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
642 this.error('Must include options reference JS for testing');
643 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
644 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
645 'in the Dygraphs.OPTIONS_REFERENCE listing.');
646 // Only log this error once.
647 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
649 // </REMOVE_FOR_COMBINED
>
650 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
654 * Returns the current value for an option, as set in the constructor or via
655 * updateOptions. You may pass in an (optional) series name to get per-series
656 * values for the option.
658 * All values returned by this method should be considered immutable. If you
659 * modify them, there is no guarantee that the changes will be honored or that
660 * dygraphs will remain in a consistent state. If you want to modify an option,
661 * use updateOptions() instead.
663 * @param { String } name The name of the option (e.g. 'strokeWidth')
664 * @param { String } [opt_seriesName] Series name to get per-series values.
665 * @return { ... } The value of the option.
667 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
668 return this.attr_(name
, opt_seriesName
);
672 * This is a convenience function for working with the Closure Compiler.
673 * @param {string} name The name of the option (e.g. 'strokeWidth')
674 * @param {string=} opt_seriesName Series name to get per-series values.
675 * @return {number} The value of the option.
678 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
679 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
683 * This is a convenience function for working with the Closure Compiler.
684 * @param {string} name The name of the option (e.g. 'strokeWidth')
685 * @param {string=} opt_seriesName Series name to get per-series values.
686 * @return {string} The value of the option.
689 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
690 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
694 * This is a convenience function for working with the Closure Compiler.
695 * @param {string} name The name of the option (e.g. 'strokeWidth')
696 * @param {string=} opt_seriesName Series name to get per-series values.
697 * @return {boolean} The value of the option.
700 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
701 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
705 * This is a convenience function for working with the Closure Compiler.
706 * @param {string} name The name of the option (e.g. 'strokeWidth')
707 * @param {string=} opt_seriesName Series name to get per-series values.
708 * @return {function(...)} The value of the option.
711 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
712 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
715 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
716 return this.attributes_
.getForAxis(name
, axis
);
721 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
722 * @return { ... } A function mapping string -> option value
724 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
726 return function(opt
) {
727 var axis_opts
= self
.user_attrs_
.axes
;
728 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
729 return axis_opts
[axis
][opt
];
731 // user-specified attributes always trump defaults, even if they're less
733 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
734 return self
.user_attrs_
[opt
];
737 axis_opts
= self
.attrs_
.axes
;
738 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
739 return axis_opts
[axis
][opt
];
741 // check old-style axis options
742 // TODO(danvk): add a deprecation warning if either of these match.
743 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
744 return self
.axes_
[0][opt
];
745 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
746 return self
.axes_
[1][opt
];
748 return self
.attr_(opt
);
753 * Returns the current rolling period, as set by the user or an option.
754 * @return {Number} The number of points in the rolling window
756 Dygraph
.prototype.rollPeriod
= function() {
757 return this.rollPeriod_
;
761 * Returns the currently-visible x-range. This can be affected by zooming,
762 * panning or a call to updateOptions.
763 * Returns a two-element array: [left, right].
764 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
766 Dygraph
.prototype.xAxisRange
= function() {
767 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
771 * Returns the lower- and upper-bound x-axis values of the
774 Dygraph
.prototype.xAxisExtremes
= function() {
775 var pad
= this.attr_('xRangePad') / this.plotter_
.area
.w
;
776 if (this.numRows() === 0) {
777 return [0 - pad
, 1 + pad
];
779 var left
= this.rawData_
[0][0];
780 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
782 // Must keep this in sync with dygraph-layout _evaluateLimits()
783 var range
= right
- left
;
785 right
+= range
* pad
;
787 return [left
, right
];
791 * Returns the currently-visible y-range for an axis. This can be affected by
792 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
793 * called with no arguments, returns the range of the first axis.
794 * Returns a two-element array: [bottom, top].
796 Dygraph
.prototype.yAxisRange
= function(idx
) {
797 if (typeof(idx
) == "undefined") idx
= 0;
798 if (idx
< 0 || idx
>= this.axes_
.length
) {
801 var axis
= this.axes_
[idx
];
802 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
806 * Returns the currently-visible y-ranges for each axis. This can be affected by
807 * zooming, panning, calls to updateOptions, etc.
808 * Returns an array of [bottom, top] pairs, one for each y-axis.
810 Dygraph
.prototype.yAxisRanges
= function() {
812 for (var i
= 0; i
< this.axes_
.length
; i
++) {
813 ret
.push(this.yAxisRange(i
));
818 // TODO(danvk): use these functions throughout dygraphs.
820 * Convert from data coordinates to canvas/div X/Y coordinates.
821 * If specified, do this conversion for the coordinate system of a particular
822 * axis. Uses the first axis by default.
823 * Returns a two-element array: [X, Y]
825 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
826 * instead of toDomCoords(null, y, axis).
828 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
829 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
833 * Convert from data x coordinates to canvas/div X coordinate.
834 * If specified, do this conversion for the coordinate system of a particular
836 * Returns a single value or null if x is null.
838 Dygraph
.prototype.toDomXCoord
= function(x
) {
843 var area
= this.plotter_
.area
;
844 var xRange
= this.xAxisRange();
845 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
849 * Convert from data x coordinates to canvas/div Y coordinate and optional
850 * axis. Uses the first axis by default.
852 * returns a single value or null if y is null.
854 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
855 var pct
= this.toPercentYCoord(y
, axis
);
860 var area
= this.plotter_
.area
;
861 return area
.y
+ pct
* area
.h
;
865 * Convert from canvas/div coords to data coordinates.
866 * If specified, do this conversion for the coordinate system of a particular
867 * axis. Uses the first axis by default.
868 * Returns a two-element array: [X, Y].
870 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
871 * instead of toDataCoords(null, y, axis).
873 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
874 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
878 * Convert from canvas/div x coordinate to data coordinate.
880 * If x is null, this returns null.
882 Dygraph
.prototype.toDataXCoord
= function(x
) {
887 var area
= this.plotter_
.area
;
888 var xRange
= this.xAxisRange();
889 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
893 * Convert from canvas/div y coord to value.
895 * If y is null, this returns null.
896 * if axis is null, this uses the first axis.
898 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
903 var area
= this.plotter_
.area
;
904 var yRange
= this.yAxisRange(axis
);
906 if (typeof(axis
) == "undefined") axis
= 0;
907 if (!this.attributes_
.getForAxis("logscale", axis
)) {
908 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
910 // Computing the inverse of toDomCoord.
911 var pct
= (y
- area
.y
) / area
.h
;
913 // Computing the inverse of toPercentYCoord. The function was arrived at with
914 // the following steps:
916 // Original calcuation:
917 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
919 // Move denominator to both sides:
920 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
922 // subtract logr1, and take the negative value.
923 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
925 // Swap both sides of the equation, and we can compute the log of the
926 // return value. Which means we just need to use that as the exponent in
928 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
930 var logr1
= Dygraph
.log10(yRange
[1]);
931 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
932 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
938 * Converts a y for an axis to a percentage from the top to the
939 * bottom of the drawing area.
941 * If the coordinate represents a value visible on the canvas, then
942 * the value will be between 0 and 1, where 0 is the top of the canvas.
943 * However, this method will return values outside the range, as
944 * values can fall outside the canvas.
946 * If y is null, this returns null.
947 * if axis is null, this uses the first axis.
949 * @param { Number } y The data y-coordinate.
950 * @param { Number } [axis] The axis number on which the data coordinate lives.
951 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
953 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
957 if (typeof(axis
) == "undefined") axis
= 0;
959 var yRange
= this.yAxisRange(axis
);
962 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
964 // yRange[1] - y is unit distance from the bottom.
965 // yRange[1] - yRange[0] is the scale of the range.
966 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
967 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
969 var logr1
= Dygraph
.log10(yRange
[1]);
970 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
976 * Converts an x value to a percentage from the left to the right of
979 * If the coordinate represents a value visible on the canvas, then
980 * the value will be between 0 and 1, where 0 is the left of the canvas.
981 * However, this method will return values outside the range, as
982 * values can fall outside the canvas.
984 * If x is null, this returns null.
985 * @param { Number } x The data x-coordinate.
986 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
988 Dygraph
.prototype.toPercentXCoord
= function(x
) {
993 var xRange
= this.xAxisRange();
994 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
998 * Returns the number of columns (including the independent variable).
999 * @return { Integer } The number of columns.
1001 Dygraph
.prototype.numColumns
= function() {
1002 if (!this.rawData_
) return 0;
1003 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1007 * Returns the number of rows (excluding any header/label row).
1008 * @return { Integer } The number of rows, less any header.
1010 Dygraph
.prototype.numRows
= function() {
1011 if (!this.rawData_
) return 0;
1012 return this.rawData_
.length
;
1016 * Returns the value in the given row and column. If the row and column exceed
1017 * the bounds on the data, returns null. Also returns null if the value is
1019 * @param { Number} row The row number of the data (0-based). Row 0 is the
1020 * first row of data, not a header row.
1021 * @param { Number} col The column number of the data (0-based)
1022 * @return { Number } The value in the specified cell or null if the row/col
1023 * were out of range.
1025 Dygraph
.prototype.getValue
= function(row
, col
) {
1026 if (row
< 0 || row
> this.rawData_
.length
) return null;
1027 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1029 return this.rawData_
[row
][col
];
1033 * Generates interface elements for the Dygraph: a containing div, a div to
1034 * display the current point, and a textbox to adjust the rolling average
1035 * period. Also creates the Renderer/Layout elements.
1038 Dygraph
.prototype.createInterface_
= function() {
1039 // Create the all-enclosing graph div
1040 var enclosing
= this.maindiv_
;
1042 this.graphDiv
= document
.createElement("div");
1044 // TODO(danvk): any other styles that are useful to set here?
1045 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1046 enclosing
.appendChild(this.graphDiv
);
1048 // Create the canvas for interactive parts of the chart.
1049 this.canvas_
= Dygraph
.createCanvas();
1050 this.canvas_
.style
.position
= "absolute";
1052 // ... and for static parts of the chart.
1053 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1055 this.resizeElements_();
1057 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1058 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1060 // The interactive parts of the graph are drawn on top of the chart.
1061 this.graphDiv
.appendChild(this.hidden_
);
1062 this.graphDiv
.appendChild(this.canvas_
);
1063 this.mouseEventElement_
= this.createMouseEventElement_();
1065 // Create the grapher
1066 this.layout_
= new DygraphLayout(this);
1070 this.mouseMoveHandler_
= function(e
) {
1071 dygraph
.mouseMove_(e
);
1074 this.mouseOutHandler_
= function(e
) {
1075 // The mouse has left the chart if:
1076 // 1. e.target is inside the chart
1077 // 2. e.relatedTarget is outside the chart
1078 var target
= e
.target
|| e
.fromElement
;
1079 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1080 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1081 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1082 dygraph
.mouseOut_(e
);
1086 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1087 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1089 // Don't recreate and register the resize handler on subsequent calls.
1090 // This happens when the graph is resized.
1091 if (!this.resizeHandler_
) {
1092 this.resizeHandler_
= function(e
) {
1096 // Update when the window is resized.
1097 // TODO(danvk): drop frames depending on complexity of the chart.
1098 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1102 Dygraph
.prototype.resizeElements_
= function() {
1103 this.graphDiv
.style
.width
= this.width_
+ "px";
1104 this.graphDiv
.style
.height
= this.height_
+ "px";
1105 this.canvas_
.width
= this.width_
;
1106 this.canvas_
.height
= this.height_
;
1107 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1108 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1109 this.hidden_
.width
= this.width_
;
1110 this.hidden_
.height
= this.height_
;
1111 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1112 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1116 * Detach DOM elements in the dygraph and null out all data references.
1117 * Calling this when you're done with a dygraph can dramatically reduce memory
1118 * usage. See, e.g., the tests/perf.html example.
1120 Dygraph
.prototype.destroy
= function() {
1121 this.canvas_ctx_
.restore();
1122 this.hidden_ctx_
.restore();
1124 var removeRecursive
= function(node
) {
1125 while (node
.hasChildNodes()) {
1126 removeRecursive(node
.firstChild
);
1127 node
.removeChild(node
.firstChild
);
1131 this.removeTrackedEvents_();
1133 // remove mouse event handlers (This may not be necessary anymore)
1134 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1135 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1137 // remove window handlers
1138 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1139 this.resizeHandler_
= null;
1141 removeRecursive(this.maindiv_
);
1143 var nullOut
= function(obj
) {
1144 for (var n
in obj
) {
1145 if (typeof(obj
[n
]) === 'object') {
1150 // These may not all be necessary, but it can't hurt...
1151 nullOut(this.layout_
);
1152 nullOut(this.plotter_
);
1157 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1158 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1159 * or the zoom rectangles) is done on this.canvas_.
1160 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1161 * @return {Object} The newly-created canvas
1164 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1165 var h
= Dygraph
.createCanvas();
1166 h
.style
.position
= "absolute";
1167 // TODO(danvk): h should be offset from canvas. canvas needs to include
1168 // some extra area to make it easier to zoom in on the far left and far
1169 // right. h needs to be precisely the plot area, so that clipping occurs.
1170 h
.style
.top
= canvas
.style
.top
;
1171 h
.style
.left
= canvas
.style
.left
;
1172 h
.width
= this.width_
;
1173 h
.height
= this.height_
;
1174 h
.style
.width
= this.width_
+ "px"; // for IE
1175 h
.style
.height
= this.height_
+ "px"; // for IE
1180 * Creates an overlay element used to handle mouse events.
1181 * @return {Object} The mouse event element.
1184 Dygraph
.prototype.createMouseEventElement_
= function() {
1185 if (this.isUsingExcanvas_
) {
1186 var elem
= document
.createElement("div");
1187 elem
.style
.position
= 'absolute';
1188 elem
.style
.backgroundColor
= 'white';
1189 elem
.style
.filter
= 'alpha(opacity=0)';
1190 elem
.style
.width
= this.width_
+ "px";
1191 elem
.style
.height
= this.height_
+ "px";
1192 this.graphDiv
.appendChild(elem
);
1195 return this.canvas_
;
1200 * Generate a set of distinct colors for the data series. This is done with a
1201 * color wheel. Saturation/Value are customizable, and the hue is
1202 * equally-spaced around the color wheel. If a custom set of colors is
1203 * specified, that is used instead.
1206 Dygraph
.prototype.setColors_
= function() {
1207 var labels
= this.getLabels();
1208 var num
= labels
.length
- 1;
1210 this.colorsMap_
= {};
1212 // These are used for when no custom colors are specified.
1213 var sat
= this.attr_('colorSaturation') || 1.0;
1214 var val
= this.attr_('colorValue') || 0.5;
1215 var half
= Math
.ceil(num
/ 2);
1217 var colors
= this.attr_('colors');
1218 var visibility
= this.visibility();
1219 for (var i
= 0; i
< num
; i
++) {
1220 if (!visibility
[i
]) {
1223 var label
= labels
[i
+ 1];
1224 var colorStr
= this.attributes_
.getForSeries('color', label
);
1227 colorStr
= colors
[i
% colors
.length
];
1229 // alternate colors for high contrast.
1230 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1231 var hue
= (1.0 * idx
/ (1 + num
));
1232 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1235 this.colors_
.push(colorStr
);
1236 this.colorsMap_
[label
] = colorStr
;
1241 * Return the list of colors. This is either the list of colors passed in the
1242 * attributes or the autogenerated list of rgb(r,g,b) strings.
1243 * This does not return colors for invisible series.
1244 * @return {Array<string>} The list of colors.
1246 Dygraph
.prototype.getColors
= function() {
1247 return this.colors_
;
1251 * Returns a few attributes of a series, i.e. its color, its visibility, which
1252 * axis it's assigned to, and its column in the original data.
1253 * Returns null if the series does not exist.
1254 * Otherwise, returns an object with column, visibility, color and axis properties.
1255 * The "axis" property will be set to 1 for y1 and 2 for y2.
1256 * The "column" property can be fed back into getValue(row, column) to get
1257 * values for this series.
1259 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1261 var labels
= this.getLabels();
1262 for (var i
= 1; i
< labels
.length
; i
++) {
1263 if (labels
[i
] == series_name
) {
1268 if (idx
== -1) return null;
1273 visible
: this.visibility()[idx
- 1],
1274 color
: this.colorsMap_
[series_name
],
1275 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1280 * Create the text box to adjust the averaging period
1283 Dygraph
.prototype.createRollInterface_
= function() {
1284 // Create a roller if one doesn't exist already.
1285 if (!this.roller_
) {
1286 this.roller_
= document
.createElement("input");
1287 this.roller_
.type
= "text";
1288 this.roller_
.style
.display
= "none";
1289 this.graphDiv
.appendChild(this.roller_
);
1292 var display
= this.attr_('showRoller') ? 'block' : 'none';
1294 var area
= this.plotter_
.area
;
1295 var textAttr
= { "position": "absolute",
1297 "top": (area
.y
+ area
.h
- 25) + "px",
1298 "left": (area
.x
+ 1) + "px",
1301 this.roller_
.size
= "2";
1302 this.roller_
.value
= this.rollPeriod_
;
1303 for (var name
in textAttr
) {
1304 if (textAttr
.hasOwnProperty(name
)) {
1305 this.roller_
.style
[name
] = textAttr
[name
];
1310 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1315 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1316 * canvas (i.e. DOM Coords).
1318 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1319 return Dygraph
.pageX(e
) - context
.px
;
1324 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1325 * canvas (i.e. DOM Coords).
1327 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1328 return Dygraph
.pageY(e
) - context
.py
;
1332 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1336 Dygraph
.prototype.createDragInterface_
= function() {
1338 // Tracks whether the mouse is down right now
1340 isPanning
: false, // is this drag part of a pan?
1341 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1342 dragStartX
: null, // pixel coordinates
1343 dragStartY
: null, // pixel coordinates
1344 dragEndX
: null, // pixel coordinates
1345 dragEndY
: null, // pixel coordinates
1346 dragDirection
: null,
1347 prevEndX
: null, // pixel coordinates
1348 prevEndY
: null, // pixel coordinates
1349 prevDragDirection
: null,
1350 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1352 // The value on the left side of the graph when a pan operation starts.
1353 initialLeftmostDate
: null,
1355 // The number of units each pixel spans. (This won't be valid for log
1357 xUnitsPerPixel
: null,
1359 // TODO(danvk): update this comment
1360 // The range in second/value units that the viewport encompasses during a
1361 // panning operation.
1364 // Top-left corner of the canvas, in DOM coords
1365 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1369 // Values for use with panEdgeFraction, which limit how far outside the
1370 // graph's data boundaries it can be panned.
1371 boundedDates
: null, // [minDate, maxDate]
1372 boundedValues
: null, // [[minValue, maxValue] ...]
1374 // We cover iframes during mouse interactions. See comments in
1375 // dygraph-utils.js for more info on why this is a good idea.
1376 tarp
: new Dygraph
.IFrameTarp(),
1378 // contextB is the same thing as this context object but renamed.
1379 initializeMouseDown
: function(event
, g
, contextB
) {
1380 // prevents mouse drags from selecting page text.
1381 if (event
.preventDefault
) {
1382 event
.preventDefault(); // Firefox, Chrome, etc.
1384 event
.returnValue
= false; // IE
1385 event
.cancelBubble
= true;
1388 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1389 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1390 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1391 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1392 contextB
.cancelNextDblclick
= false;
1393 contextB
.tarp
.cover();
1397 var interactionModel
= this.attr_("interactionModel");
1399 // Self is the graph.
1402 // Function that binds the graph and context to the handler.
1403 var bindHandler
= function(handler
) {
1404 return function(event
) {
1405 handler(event
, self
, context
);
1409 for (var eventName
in interactionModel
) {
1410 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1411 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1412 bindHandler(interactionModel
[eventName
]));
1415 // If the user releases the mouse button during a drag, but not over the
1416 // canvas, then it doesn't count as a zooming action.
1417 var mouseUpHandler
= function(event
) {
1418 if (context
.isZooming
|| context
.isPanning
) {
1419 context
.isZooming
= false;
1420 context
.dragStartX
= null;
1421 context
.dragStartY
= null;
1424 if (context
.isPanning
) {
1425 context
.isPanning
= false;
1426 context
.draggingDate
= null;
1427 context
.dateRange
= null;
1428 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1429 delete self
.axes_
[i
].draggingValue
;
1430 delete self
.axes_
[i
].dragValueRange
;
1434 context
.tarp
.uncover();
1437 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1441 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1442 * up any previous zoom rectangles that were drawn. This could be optimized to
1443 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1446 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1447 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1448 * @param {Number} startX The X position where the drag started, in canvas
1450 * @param {Number} endX The current X position of the drag, in canvas coords.
1451 * @param {Number} startY The Y position where the drag started, in canvas
1453 * @param {Number} endY The current Y position of the drag, in canvas coords.
1454 * @param {Number} prevDirection the value of direction on the previous call to
1455 * this function. Used to avoid excess redrawing
1456 * @param {Number} prevEndX The value of endX on the previous call to this
1457 * function. Used to avoid excess redrawing
1458 * @param {Number} prevEndY The value of endY on the previous call to this
1459 * function. Used to avoid excess redrawing
1462 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1463 endY
, prevDirection
, prevEndX
,
1465 var ctx
= this.canvas_ctx_
;
1467 // Clean up from the previous rect if necessary
1468 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1469 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1470 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1471 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1472 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1473 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1476 // Draw a light-grey rectangle to show the new viewing area
1477 if (direction
== Dygraph
.HORIZONTAL
) {
1478 if (endX
&& startX
) {
1479 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1480 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1481 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1483 } else if (direction
== Dygraph
.VERTICAL
) {
1484 if (endY
&& startY
) {
1485 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1486 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1487 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1491 if (this.isUsingExcanvas_
) {
1492 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1497 * Clear the zoom rectangle (and perform no zoom).
1500 Dygraph
.prototype.clearZoomRect_
= function() {
1501 this.currentZoomRectArgs_
= null;
1502 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1506 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1507 * the canvas. The exact zoom window may be slightly larger if there are no data
1508 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1509 * which accepts dates that match the raw data. This function redraws the graph.
1511 * @param {Number} lowX The leftmost pixel value that should be visible.
1512 * @param {Number} highX The rightmost pixel value that should be visible.
1515 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1516 this.currentZoomRectArgs_
= null;
1517 // Find the earliest and latest dates contained in this canvasx range.
1518 // Convert the call to date ranges of the raw data.
1519 var minDate
= this.toDataXCoord(lowX
);
1520 var maxDate
= this.toDataXCoord(highX
);
1521 this.doZoomXDates_(minDate
, maxDate
);
1525 * Transition function to use in animations. Returns values between 0.0
1526 * (totally old values) and 1.0 (totally new values) for each frame.
1529 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1531 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1535 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1536 * method with doZoomX which accepts pixel coordinates. This function redraws
1539 * @param {Number} minDate The minimum date that should be visible.
1540 * @param {Number} maxDate The maximum date that should be visible.
1543 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1544 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1545 // can produce strange effects. Rather than the y-axis transitioning slowly
1546 // between values, it can jerk around.)
1547 var old_window
= this.xAxisRange();
1548 var new_window
= [minDate
, maxDate
];
1549 this.zoomed_x_
= true;
1551 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1552 if (that
.attr_("zoomCallback")) {
1553 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1559 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1560 * the canvas. This function redraws the graph.
1562 * @param {Number} lowY The topmost pixel value that should be visible.
1563 * @param {Number} highY The lowest pixel value that should be visible.
1566 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1567 this.currentZoomRectArgs_
= null;
1568 // Find the highest and lowest values in pixel range for each axis.
1569 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1570 // This is because pixels increase as you go down on the screen, whereas data
1571 // coordinates increase as you go up the screen.
1572 var oldValueRanges
= this.yAxisRanges();
1573 var newValueRanges
= [];
1574 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1575 var hi
= this.toDataYCoord(lowY
, i
);
1576 var low
= this.toDataYCoord(highY
, i
);
1577 newValueRanges
.push([low
, hi
]);
1580 this.zoomed_y_
= true;
1582 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1583 if (that
.attr_("zoomCallback")) {
1584 var xRange
= that
.xAxisRange();
1585 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1591 * Reset the zoom to the original view coordinates. This is the same as
1592 * double-clicking on the graph.
1594 Dygraph
.prototype.resetZoom
= function() {
1595 var dirty
= false, dirtyX
= false, dirtyY
= false;
1596 if (this.dateWindow_
!== null) {
1601 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1602 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1608 // Clear any selection, since it's likely to be drawn in the wrong place.
1609 this.clearSelection();
1612 this.zoomed_x_
= false;
1613 this.zoomed_y_
= false;
1615 var minDate
= this.rawData_
[0][0];
1616 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1618 // With only one frame, don't bother calculating extreme ranges.
1619 // TODO(danvk): merge this block w/ the code below
.
1620 if (!this.attr_("animatedZooms")) {
1621 this.dateWindow_
= null;
1622 for (i
= 0; i
< this.axes_
.length
; i
++) {
1623 if (this.axes_
[i
].valueWindow
!== null) {
1624 delete this.axes_
[i
].valueWindow
;
1628 if (this.attr_("zoomCallback")) {
1629 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1634 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1636 oldWindow
= this.xAxisRange();
1637 newWindow
= [minDate
, maxDate
];
1641 oldValueRanges
= this.yAxisRanges();
1642 // TODO(danvk): this is pretty inefficient
1643 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1644 var extremes
= packed
.extremes
;
1646 // this has the side-effect of modifying this.axes_.
1647 // this doesn't make much sense in this context, but it's convenient (we
1648 // need this.axes_[*].extremeValues) and not harmful since we'll be
1649 // calling drawGraph_ shortly, which clobbers these values.
1650 this.computeYAxisRanges_(extremes
);
1652 newValueRanges
= [];
1653 for (i
= 0; i
< this.axes_
.length
; i
++) {
1654 var axis
= this.axes_
[i
];
1655 newValueRanges
.push((axis
.valueRange
!== null &&
1656 axis
.valueRange
!== undefined
) ?
1657 axis
.valueRange
: axis
.extremeRange
);
1662 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1664 that
.dateWindow_
= null;
1665 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1666 if (that
.axes_
[i
].valueWindow
!== null) {
1667 delete that
.axes_
[i
].valueWindow
;
1670 if (that
.attr_("zoomCallback")) {
1671 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1678 * Combined animation logic for all zoom functions.
1679 * either the x parameters or y parameters may be null.
1682 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1683 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1686 var valueRanges
= [];
1689 if (oldXRange
!== null && newXRange
!== null) {
1690 for (step
= 1; step
<= steps
; step
++) {
1691 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1692 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1693 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1697 if (oldYRanges
!== null && newYRanges
!== null) {
1698 for (step
= 1; step
<= steps
; step
++) {
1699 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1701 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1702 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1703 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1705 valueRanges
[step
-1] = thisRange
;
1710 Dygraph
.repeatAndCleanup(function(step
) {
1711 if (valueRanges
.length
) {
1712 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1713 var w
= valueRanges
[step
][i
];
1714 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1717 if (windows
.length
) {
1718 that
.dateWindow_
= windows
[step
];
1721 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1725 * Get the current graph's area object.
1727 * Returns: {x, y, w, h}
1729 Dygraph
.prototype.getArea
= function() {
1730 return this.plotter_
.area
;
1734 * Convert a mouse event to DOM coordinates relative to the graph origin.
1736 * Returns a two-element array: [X, Y].
1738 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1739 if (event
.offsetX
&& event
.offsetY
) {
1740 return [ event
.offsetX
, event
.offsetY
];
1742 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1743 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1744 return [canvasx
, canvasy
];
1749 * Given a canvas X coordinate, find the closest row.
1750 * @param {Number} domX graph-relative DOM X coordinate
1751 * Returns: row number, integer
1754 Dygraph
.prototype.findClosestRow
= function(domX
) {
1755 var minDistX
= Infinity
;
1756 var closestRow
= -1;
1757 var sets
= this.layout_
.points
;
1758 for (var i
= 0; i
< sets
.length
; i
++) {
1759 var points
= sets
[i
];
1760 var len
= points
.length
;
1761 for (var j
= 0; j
< len
; j
++) {
1762 var point
= points
[j
];
1763 if (!Dygraph
.isValidPoint(point
, true)) continue;
1764 var dist
= Math
.abs(point
.canvasx
- domX
);
1765 if (dist
< minDistX
) {
1767 closestRow
= point
.idx
;
1776 * Given canvas X,Y coordinates, find the closest point.
1778 * This finds the individual data point across all visible series
1779 * that's closest to the supplied DOM coordinates using the standard
1780 * Euclidean X,Y distance.
1782 * @param {Number} domX graph-relative DOM X coordinate
1783 * @param {Number} domY graph-relative DOM Y coordinate
1784 * Returns: {row, seriesName, point}
1787 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1788 var minDist
= Infinity
;
1789 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1790 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1791 var points
= this.layout_
.points
[setIdx
];
1792 for (var i
= 0; i
< points
.length
; ++i
) {
1794 if (!Dygraph
.isValidPoint(point
)) continue;
1795 dx
= point
.canvasx
- domX
;
1796 dy
= point
.canvasy
- domY
;
1797 dist
= dx
* dx
+ dy
* dy
;
1798 if (dist
< minDist
) {
1800 closestPoint
= point
;
1801 closestSeries
= setIdx
;
1802 closestRow
= point
.idx
;
1806 var name
= this.layout_
.setNames
[closestSeries
];
1815 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1817 * This first finds the X data point closest to the supplied DOM X coordinate,
1818 * then finds the series which puts the Y coordinate on top of its filled area,
1819 * using linear interpolation between adjacent point pairs.
1821 * @param {Number} domX graph-relative DOM X coordinate
1822 * @param {Number} domY graph-relative DOM Y coordinate
1823 * Returns: {row, seriesName, point}
1826 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1827 var row
= this.findClosestRow(domX
);
1828 var closestPoint
, closestSeries
;
1829 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1830 var boundary
= this.getLeftBoundary_(setIdx
);
1831 var rowIdx
= row
- boundary
;
1832 var points
= this.layout_
.points
[setIdx
];
1833 if (rowIdx
>= points
.length
) continue;
1834 var p1
= points
[rowIdx
];
1835 if (!Dygraph
.isValidPoint(p1
)) continue;
1836 var py
= p1
.canvasy
;
1837 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1838 // interpolate series Y value using next point
1839 var p2
= points
[rowIdx
+ 1];
1840 if (Dygraph
.isValidPoint(p2
)) {
1841 var dx
= p2
.canvasx
- p1
.canvasx
;
1843 var r
= (domX
- p1
.canvasx
) / dx
;
1844 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1847 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1848 // interpolate series Y value using previous point
1849 var p0
= points
[rowIdx
- 1];
1850 if (Dygraph
.isValidPoint(p0
)) {
1851 var dx
= p1
.canvasx
- p0
.canvasx
;
1853 var r
= (p1
.canvasx
- domX
) / dx
;
1854 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1858 // Stop if the point (domX, py) is above this series' upper edge
1859 if (setIdx
=== 0 || py
< domY
) {
1861 closestSeries
= setIdx
;
1864 var name
= this.layout_
.setNames
[closestSeries
];
1873 * When the mouse moves in the canvas, display information about a nearby data
1874 * point and draw dots over those points in the data series. This function
1875 * takes care of cleanup of previously-drawn dots.
1876 * @param {Object} event The mousemove event from the browser.
1879 Dygraph
.prototype.mouseMove_
= function(event
) {
1880 // This prevents JS errors when mousing over the canvas before data loads.
1881 var points
= this.layout_
.points
;
1882 if (points
=== undefined
|| points
=== null) return;
1884 var canvasCoords
= this.eventToDomCoords(event
);
1885 var canvasx
= canvasCoords
[0];
1886 var canvasy
= canvasCoords
[1];
1888 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1889 var selectionChanged
= false;
1890 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1892 if (this.attr_("stackedGraph")) {
1893 closest
= this.findStackedPoint(canvasx
, canvasy
);
1895 closest
= this.findClosestPoint(canvasx
, canvasy
);
1897 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1899 var idx
= this.findClosestRow(canvasx
);
1900 selectionChanged
= this.setSelection(idx
);
1903 var callback
= this.attr_("highlightCallback");
1904 if (callback
&& selectionChanged
) {
1909 this.highlightSet_
);
1914 * Fetch left offset from the specified set index or if not passed, the
1915 * first defined boundaryIds record (see bug #236).
1918 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1919 if (this.boundaryIds_
[setIdx
]) {
1920 return this.boundaryIds_
[setIdx
][0];
1922 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1923 if (this.boundaryIds_
[i
] !== undefined
) {
1924 return this.boundaryIds_
[i
][0];
1931 Dygraph
.prototype.animateSelection_
= function(direction
) {
1932 var totalSteps
= 10;
1934 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1935 if (this.animateId
=== undefined
) this.animateId
= 0;
1936 var start
= this.fadeLevel
;
1937 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1939 if (this.fadeLevel
) {
1940 this.updateSelection_(1.0);
1945 var thisId
= ++this.animateId
;
1947 Dygraph
.repeatAndCleanup(
1949 // ignore simultaneous animations
1950 if (that
.animateId
!= thisId
) return;
1952 that
.fadeLevel
+= direction
;
1953 if (that
.fadeLevel
=== 0) {
1954 that
.clearSelection();
1956 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1959 steps
, millis
, function() {});
1963 * Draw dots over the selectied points in the data series. This function
1964 * takes care of cleanup of previously-drawn dots.
1967 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1968 /*var defaultPrevented = */
1969 this.cascadeEvents_('select', {
1970 selectedX
: this.lastx_
,
1971 selectedPoints
: this.selPoints_
1973 // TODO(danvk): use defaultPrevented here?
1975 // Clear the previously drawn vertical, if there is one
1977 var ctx
= this.canvas_ctx_
;
1978 if (this.attr_('highlightSeriesOpts')) {
1979 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1980 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1982 // Activating background fade includes an animation effect for a gradual
1983 // fade. TODO(klausw): make this independently configurable if it causes
1984 // issues? Use a shared preference to control animations?
1985 var animateBackgroundFade
= true;
1986 if (animateBackgroundFade
) {
1987 if (opt_animFraction
=== undefined
) {
1988 // start a new animation
1989 this.animateSelection_(1);
1992 alpha
*= opt_animFraction
;
1994 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1995 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1998 // Redraw only the highlighted series in the interactive canvas (not the
1999 // static plot canvas, which is where series are usually drawn).
2000 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2001 } else if (this.previousVerticalX_
>= 0) {
2002 // Determine the maximum highlight circle size.
2003 var maxCircleSize
= 0;
2004 var labels
= this.attr_('labels');
2005 for (i
= 1; i
< labels
.length
; i
++) {
2006 var r
= this.attr_('highlightCircleSize', labels
[i
]);
2007 if (r
> maxCircleSize
) maxCircleSize
= r
;
2009 var px
= this.previousVerticalX_
;
2010 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2011 2 * maxCircleSize
+ 2, this.height_
);
2014 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2015 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2018 if (this.selPoints_
.length
> 0) {
2019 // Draw colored circles over the center of each selected point
2020 var canvasx
= this.selPoints_
[0].canvasx
;
2022 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2023 var pt
= this.selPoints_
[i
];
2024 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2026 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
2027 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
2028 var color
= this.plotter_
.colors
[pt
.name
];
2030 callback
= Dygraph
.Circles
.DEFAULT
;
2032 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
2033 ctx
.strokeStyle
= color
;
2034 ctx
.fillStyle
= color
;
2035 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2036 color
, circleSize
, pt
.idx
);
2040 this.previousVerticalX_
= canvasx
;
2045 * Manually set the selected points and display information about them in the
2046 * legend. The selection can be cleared using clearSelection() and queried
2047 * using getSelection().
2048 * @param { Integer } row number that should be highlighted (i.e. appear with
2049 * hover dots on the chart). Set to false to clear any selection.
2050 * @param { seriesName } optional series name to highlight that series with the
2051 * the highlightSeriesOpts setting.
2052 * @param { locked } optional If true, keep seriesName selected when mousing
2053 * over the graph, disabling closest-series highlighting. Call clearSelection()
2056 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2057 // Extract the points we've selected
2058 this.selPoints_
= [];
2060 var changed
= false;
2061 if (row
!== false && row
>= 0) {
2062 if (row
!= this.lastRow_
) changed
= true;
2063 this.lastRow_
= row
;
2064 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2065 var points
= this.layout_
.points
[setIdx
];
2066 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2067 if (setRow
< points
.length
) {
2068 var point
= points
[setRow
];
2069 if (point
.yval
!== null) this.selPoints_
.push(point
);
2073 if (this.lastRow_
>= 0) changed
= true;
2077 if (this.selPoints_
.length
) {
2078 this.lastx_
= this.selPoints_
[0].xval
;
2083 if (opt_seriesName
!== undefined
) {
2084 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2085 this.highlightSet_
= opt_seriesName
;
2088 if (opt_locked
!== undefined
) {
2089 this.lockedSet_
= opt_locked
;
2093 this.updateSelection_(undefined
);
2099 * The mouse has left the canvas. Clear out whatever artifacts remain
2100 * @param {Object} event the mouseout event from the browser.
2103 Dygraph
.prototype.mouseOut_
= function(event
) {
2104 if (this.attr_("unhighlightCallback")) {
2105 this.attr_("unhighlightCallback")(event
);
2108 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2109 this.clearSelection();
2114 * Clears the current selection (i.e. points that were highlighted by moving
2115 * the mouse over the chart).
2117 Dygraph
.prototype.clearSelection
= function() {
2118 this.cascadeEvents_('deselect', {});
2120 this.lockedSet_
= false;
2121 // Get rid of the overlay data
2122 if (this.fadeLevel
) {
2123 this.animateSelection_(-1);
2126 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2128 this.selPoints_
= [];
2131 this.highlightSet_
= null;
2135 * Returns the number of the currently selected row. To get data for this row,
2136 * you can use the getValue method.
2137 * @return { Integer } row number, or -1 if nothing is selected
2139 Dygraph
.prototype.getSelection
= function() {
2140 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2144 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2145 var points
= this.layout_
.points
[setIdx
];
2146 for (var row
= 0; row
< points
.length
; row
++) {
2147 if (points
[row
].x
== this.selPoints_
[0].x
) {
2148 return points
[row
].idx
;
2156 * Returns the name of the currently-highlighted series.
2157 * Only available when the highlightSeriesOpts option is in use.
2159 Dygraph
.prototype.getHighlightSeries
= function() {
2160 return this.highlightSet_
;
2164 * Returns true if the currently-highlighted series was locked
2165 * via setSelection(..., seriesName, true).
2167 Dygraph
.prototype.isSeriesLocked
= function() {
2168 return this.lockedSet_
;
2172 * Fires when there's data available to be graphed.
2173 * @param {String} data Raw CSV data to be plotted
2176 Dygraph
.prototype.loadedEvent_
= function(data
) {
2177 this.rawData_
= this.parseCSV_(data
);
2182 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2185 Dygraph
.prototype.addXTicks_
= function() {
2186 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2188 if (this.dateWindow_
) {
2189 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2191 range
= this.xAxisExtremes();
2194 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2195 var xTicks
= xAxisOptionsView('ticker')(
2198 this.width_
, // TODO(danvk): should be area.width
2201 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2202 // console.log(msg);
2203 this.layout_
.setXTicks(xTicks
);
2207 * Returns the correct handler class for the currently set options.
2210 Dygraph
.prototype.getHandlerClass_
= function() {
2212 if (this.attr_('dataHandler')) {
2213 handlerClass
= this.attr_('dataHandler');
2214 } else if (this.fractions_
) {
2215 if (this.attr_('errorBars')) {
2216 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2218 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2220 } else if (this.attr_('customBars')) {
2221 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2222 } else if (this.attr_('errorBars')) {
2223 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2225 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2227 return handlerClass
;
2232 * This function is called once when the chart's data is changed or the options
2233 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2234 * idea is that values derived from the chart's data can be computed here,
2235 * rather than every time the chart is drawn. This includes things like the
2236 * number of axes, rolling averages, etc.
2238 Dygraph
.prototype.predraw_
= function() {
2239 var start
= new Date();
2241 // Create the correct dataHandler
2242 this.dataHandler_
= new (this.getHandlerClass_())();
2244 this.layout_
.computePlotArea();
2246 // TODO(danvk): move more computations out of drawGraph_ and into here.
2247 this.computeYAxes_();
2249 // Create a new plotter.
2250 if (this.plotter_
) {
2251 this.cascadeEvents_('clearChart');
2252 this.plotter_
.clear();
2255 if (!this.is_initial_draw_
) {
2256 this.canvas_ctx_
.restore();
2257 this.hidden_ctx_
.restore();
2260 this.canvas_ctx_
.save();
2261 this.hidden_ctx_
.save();
2263 this.plotter_
= new DygraphCanvasRenderer(this,
2268 // The roller sits in the bottom left corner of the chart. We don't know where
2269 // this will be until the options are available, so it's positioned here.
2270 this.createRollInterface_();
2272 this.cascadeEvents_('predraw');
2274 // Convert the raw data (a 2D array) into the internal format and compute
2275 // rolling averages.
2276 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2277 for (var i
= 1; i
< this.numColumns(); i
++) {
2278 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2279 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2280 if (this.rollPeriod_
> 1) {
2281 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2284 this.rolledSeries_
.push(series
);
2287 // If the data or options have changed, then we'd better redraw.
2290 // This is used to determine whether to do various animations.
2291 var end
= new Date();
2292 this.drawingTimeMs_
= (end
- start
);
2298 * xval_* and yval_* are the original unscaled data values,
2299 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2300 * yval_stacked is the cumulative Y value used for stacking graphs,
2301 * and bottom/top/minus/plus are used for error bar graphs.
2308 * y_bottom: ?number,
2310 * y_stacked: ?number,
2312 * yval_minus: ?number,
2314 * yval_plus: ?number,
2318 Dygraph
.PointType
= undefined
;
2321 * Calculates point stacking for stackedGraph=true.
2323 * For stacking purposes, interpolate or extend neighboring data across
2324 * NaN values based on stackedGraphNaNFill settings. This is for display
2325 * only, the underlying data value as shown in the legend remains NaN.
2327 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2328 * Updates each Point's yval_stacked property.
2329 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2330 * values for the series seen so far. Index is the row number. Updated
2331 * based on the current series's values.
2332 * @param {Array.<number>} seriesExtremes Min and max values, updated
2333 * to reflect the stacked values.
2334 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2338 Dygraph
.stackPoints_
= function(
2339 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2340 var lastXval
= null;
2341 var prevPoint
= null;
2342 var nextPoint
= null;
2343 var nextPointIdx
= -1;
2345 // Find the next stackable point starting from the given index.
2346 var updateNextPoint
= function(idx
) {
2347 // If we've previously found a non-NaN point and haven't gone past it yet,
2349 if (nextPointIdx
>= idx
) return;
2351 // We haven't found a non-NaN point yet or have moved past it,
2352 // look towards the right to find a non-NaN point.
2353 for (var j
= idx
; j
< points
.length
; ++j
) {
2354 // Clear out a previously-found point (if any) since it's no longer
2355 // valid, we shouldn't use it for interpolation anymore.
2357 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2359 nextPoint
= points
[j
];
2365 for (var i
= 0; i
< points
.length
; ++i
) {
2366 var point
= points
[i
];
2367 var xval
= point
.xval
;
2368 if (cumulativeYval
[xval
] === undefined
) {
2369 cumulativeYval
[xval
] = 0;
2372 var actualYval
= point
.yval
;
2373 if (isNaN(actualYval
) || actualYval
=== null) {
2374 // Interpolate/extend
for stacking purposes
if possible
.
2376 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2377 // Use linear interpolation between prevPoint and nextPoint.
2378 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2379 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2380 } else if (prevPoint
&& fillMethod
== 'all') {
2381 actualYval
= prevPoint
.yval
;
2382 } else if (nextPoint
&& fillMethod
== 'all') {
2383 actualYval
= nextPoint
.yval
;
2391 var stackedYval
= cumulativeYval
[xval
];
2392 if (lastXval
!= xval
) {
2393 // If an x-value is repeated, we ignore the duplicates.
2394 stackedYval
+= actualYval
;
2395 cumulativeYval
[xval
] = stackedYval
;
2399 point
.yval_stacked
= stackedYval
;
2401 if (stackedYval
> seriesExtremes
[1]) {
2402 seriesExtremes
[1] = stackedYval
;
2404 if (stackedYval
< seriesExtremes
[0]) {
2405 seriesExtremes
[0] = stackedYval
;
2412 * Loop over all fields and create datasets, calculating extreme y-values for
2413 * each series and extreme x-indices as we go.
2415 * dateWindow is passed in as an explicit parameter so that we can compute
2416 * extreme values "speculatively", i.e. without actually setting state on the
2419 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2420 * rolledSeries[seriesIndex][row] = raw point, where
2421 * seriesIndex is the column number starting with 1, and
2422 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2423 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2425 * points: Array.<Array.<Dygraph.PointType>>,
2426 * seriesExtremes: Array.<Array.<number>>,
2427 * boundaryIds: Array.<number>}}
2430 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2431 var boundaryIds
= [];
2433 var cumulativeYval
= []; // For stacked series.
2434 var extremes
= {}; // series name -> [low, high]
2435 var seriesIdx
, sampleIdx
;
2436 var firstIdx
, lastIdx
;
2438 // Loop over the fields (series). Go from the last to the first,
2439 // because if they're stacked that's how we accumulate the values.
2440 var num_series
= rolledSeries
.length
- 1;
2442 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2443 if (!this.visibility()[seriesIdx
- 1]) continue;
2445 // Prune down to the desired range, if necessary (for zooming)
2446 // Because there can be lines going to points outside of the visible area,
2447 // we actually prune to visible points, plus one on either side.
2449 series
= rolledSeries
[seriesIdx
];
2450 var low
= dateWindow
[0];
2451 var high
= dateWindow
[1];
2453 // TODO(danvk): do binary search instead of linear search.
2454 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2457 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2458 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2459 firstIdx
= sampleIdx
;
2461 if (series
[sampleIdx
][0] <= high
) {
2462 lastIdx
= sampleIdx
;
2466 if (firstIdx
=== null) firstIdx
= 0;
2467 var correctedFirstIdx
= firstIdx
;
2468 var isInvalidValue
= true;
2469 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2470 correctedFirstIdx
--;
2471 // check if the y value is null.
2472 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2475 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2476 var correctedLastIdx
= lastIdx
;
2477 isInvalidValue
= true;
2478 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2480 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2483 if (correctedFirstIdx
!==firstIdx
) {
2484 firstIdx
= correctedFirstIdx
;
2486 if (correctedLastIdx
!== lastIdx
) {
2487 lastIdx
= correctedLastIdx
;
2490 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2492 // .slice's end is exclusive, we want to include lastIdx.
2493 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2495 series
= rolledSeries
[seriesIdx
];
2496 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2499 var seriesName
= this.attr_("labels")[seriesIdx
];
2500 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2501 dateWindow
, this.attr_("stepPlot",seriesName
));
2503 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2504 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2506 if (this.attr_("stackedGraph")) {
2507 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2508 this.attr_("stackedGraphNaNFill"));
2511 extremes
[seriesName
] = seriesExtremes
;
2512 points
[seriesIdx
] = seriesPoints
;
2515 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2519 * Update the graph with new data. This method is called when the viewing area
2520 * has changed. If the underlying data or options have changed, predraw_ will
2521 * be called before drawGraph_ is called.
2525 Dygraph
.prototype.drawGraph_
= function() {
2526 var start
= new Date();
2528 // This is used to set the second parameter to drawCallback, below.
2529 var is_initial_draw
= this.is_initial_draw_
;
2530 this.is_initial_draw_
= false;
2532 this.layout_
.removeAllDatasets();
2534 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2536 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2537 var points
= packed
.points
;
2538 var extremes
= packed
.extremes
;
2539 this.boundaryIds_
= packed
.boundaryIds
;
2541 this.setIndexByName_
= {};
2542 var labels
= this.attr_("labels");
2543 if (labels
.length
> 0) {
2544 this.setIndexByName_
[labels
[0]] = 0;
2547 for (var i
= 1; i
< points
.length
; i
++) {
2548 this.setIndexByName_
[labels
[i
]] = i
;
2549 if (!this.visibility()[i
- 1]) continue;
2550 this.layout_
.addDataset(labels
[i
], points
[i
]);
2551 this.datasetIndex_
[i
] = dataIdx
++;
2554 this.computeYAxisRanges_(extremes
);
2555 this.layout_
.setYAxes(this.axes_
);
2559 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2560 var tmp_zoomed_x
= this.zoomed_x_
;
2561 // Tell PlotKit to use this new data and render itself
2562 this.zoomed_x_
= tmp_zoomed_x
;
2563 this.layout_
.evaluate();
2564 this.renderGraph_(is_initial_draw
);
2566 if (this.attr_("timingName")) {
2567 var end
= new Date();
2568 Dygraph
.info(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2573 * This does the work of drawing the chart. It assumes that the layout and axis
2574 * scales have already been set (e.g. by predraw_).
2578 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2579 this.cascadeEvents_('clearChart');
2580 this.plotter_
.clear();
2582 if (this.attr_('underlayCallback')) {
2583 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2584 // users who expect a deprecated form of this callback.
2585 this.attr_('underlayCallback')(
2586 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2590 canvas
: this.hidden_
,
2591 drawingContext
: this.hidden_ctx_
2593 this.cascadeEvents_('willDrawChart', e
);
2594 this.plotter_
.render();
2595 this.cascadeEvents_('didDrawChart', e
);
2596 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2598 // TODO(danvk): is this a performance bottleneck when panning?
2599 // The interaction canvas should already be empty in that situation.
2600 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2601 this.canvas_
.height
);
2603 if (this.attr_("drawCallback") !== null) {
2604 this.attr_("drawCallback")(this, is_initial_draw
);
2606 if (is_initial_draw
) {
2607 this.readyFired_
= true;
2608 while (this.readyFns_
.length
> 0) {
2609 var fn
= this.readyFns_
.pop();
2617 * Determine properties of the y-axes which are independent of the data
2618 * currently being displayed. This includes things like the number of axes and
2619 * the style of the axes. It does not include the range of each axis and its
2621 * This fills in this.axes_.
2622 * axes_ = [ { options } ]
2623 * indices are into the axes_ array.
2625 Dygraph
.prototype.computeYAxes_
= function() {
2626 // Preserve valueWindow settings if they exist, and if the user hasn't
2627 // specified a new valueRange.
2628 var valueWindows
, axis
, index
, opts
, v
;
2629 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2631 for (index
= 0; index
< this.axes_
.length
; index
++) {
2632 valueWindows
.push(this.axes_
[index
].valueWindow
);
2636 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2637 // data computation as well as options storage.
2638 // Go through once and add all the axes.
2641 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2642 // Add a new axis, making a copy of its per-axis options.
2643 opts
= { g
: this };
2644 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2645 this.axes_
[axis
] = opts
;
2649 // Copy global valueRange option over to the first axis.
2650 // NOTE(konigsberg): Are these two statements necessary?
2651 // I tried removing it. The automated tests pass, and manually
2652 // messing with tests/zoom
.html showed no trouble
.
2653 v
= this.attr_('valueRange');
2654 if (v
) this.axes_
[0].valueRange
= v
;
2656 if (valueWindows
!== undefined
) {
2657 // Restore valueWindow settings.
2659 // When going from two axes back to one, we only restore
2661 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2663 for (index
= 0; index
< idxCount
; index
++) {
2664 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2668 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2670 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2671 v
= opts("valueRange");
2672 if (v
) this.axes_
[axis
].valueRange
= v
;
2673 } else { // To keep old behavior
2674 var axes
= this.user_attrs_
.axes
;
2675 if (axes
&& axes
.y2
) {
2676 v
= axes
.y2
.valueRange
;
2677 if (v
) this.axes_
[axis
].valueRange
= v
;
2684 * Returns the number of y-axes on the chart.
2685 * @return {Number} the number of axes.
2687 Dygraph
.prototype.numAxes
= function() {
2688 return this.attributes_
.numAxes();
2693 * Returns axis properties for the given series.
2694 * @param { String } setName The name of the series for which to get axis
2695 * properties, e.g. 'Y1'.
2696 * @return { Object } The axis properties.
2698 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2699 // TODO(danvk): handle errors.
2700 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2705 * Determine the value range and tick marks for each axis.
2706 * @param {Object} extremes A mapping from seriesName -> [low, high]
2707 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2709 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2710 var isNullUndefinedOrNaN
= function(num
) {
2711 return isNaN(parseFloat(num
));
2713 var numAxes
= this.attributes_
.numAxes();
2714 var ypadCompat
, span
, series
, ypad
;
2718 // Compute extreme values, a span and tick marks for each axis.
2719 for (var i
= 0; i
< numAxes
; i
++) {
2720 var axis
= this.axes_
[i
];
2721 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2722 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2723 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2724 series
= this.attributes_
.seriesForAxis(i
);
2726 // Add some padding. This supports two Y padding operation modes:
2728 // - backwards compatible (yRangePad not set):
2729 // 10% padding for automatic Y ranges, but not for user-supplied
2730 // ranges, and move a close-to-zero edge to zero except if
2731 // avoidMinZero is set, since drawing at the edge results in
2732 // invisible lines. Unfortunately lines drawn at the edge of a
2733 // user-supplied range will still be invisible. If logscale is
2734 // set, add a variable amount of padding at the top but
2735 // none at the bottom.
2737 // - new-style (yRangePad set by the user):
2738 // always add the specified Y padding.
2741 ypad
= 0.1; // add 10%
2742 if (this.attr_('yRangePad') !== null) {
2744 // Convert pixel padding to ratio
2745 ypad
= this.attr_('yRangePad') / this.plotter_
.area
.h
;
2748 if (series
.length
=== 0) {
2749 // If no series are defined or visible then use a reasonable default
2750 axis
.extremeRange
= [0, 1];
2752 // Calculate the extremes of extremes.
2753 var minY
= Infinity
; // extremes[series[0]][0];
2754 var maxY
= -Infinity
; // extremes[series[0]][1];
2755 var extremeMinY
, extremeMaxY
;
2757 for (var j
= 0; j
< series
.length
; j
++) {
2758 // this skips invisible series
2759 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2761 // Only use valid extremes to stop null data series' from corrupting the scale.
2762 extremeMinY
= extremes
[series
[j
]][0];
2763 if (extremeMinY
!== null) {
2764 minY
= Math
.min(extremeMinY
, minY
);
2766 extremeMaxY
= extremes
[series
[j
]][1];
2767 if (extremeMaxY
!== null) {
2768 maxY
= Math
.max(extremeMaxY
, maxY
);
2772 // Include zero if requested by the user.
2773 if (includeZero
&& !logscale
) {
2774 if (minY
> 0) minY
= 0;
2775 if (maxY
< 0) maxY
= 0;
2778 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2779 if (minY
== Infinity
) minY
= 0;
2780 if (maxY
== -Infinity
) maxY
= 1;
2783 // special case: if we have no sense of scale, center on the sole value.
2786 span
= Math
.abs(maxY
);
2788 // ... and if the sole value is zero, use range 0-1.
2794 var maxAxisY
, minAxisY
;
2797 maxAxisY
= maxY
+ ypad
* span
;
2800 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2801 maxAxisY
= maxY
* logpad
;
2802 minAxisY
= minY
/ logpad
;
2805 maxAxisY
= maxY
+ ypad
* span
;
2806 minAxisY
= minY
- ypad
* span
;
2808 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2809 // close to zero, but not if avoidMinZero is set.
2810 if (ypadCompat
&& !this.attr_("avoidMinZero")) {
2811 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2812 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2815 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2817 if (axis
.valueWindow
) {
2818 // This is only set if the user has zoomed on the y-axis. It is never set
2819 // by a user. It takes precedence over axis.valueRange because, if you set
2820 // valueRange, you'd still expect to be able to pan.
2821 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2822 } else if (axis
.valueRange
) {
2823 // This is a user-set value range for this axis.
2824 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2825 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2827 if (axis
.logscale
) {
2828 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2837 axis
.computedValueRange
= [y0
, y1
];
2839 axis
.computedValueRange
= axis
.extremeRange
;
2843 if (independentTicks
) {
2844 axis
.independentTicks
= independentTicks
;
2845 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2846 var ticker
= opts('ticker');
2847 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2848 axis
.computedValueRange
[1],
2849 this.height_
, // TODO(danvk): should be area.height
2852 // Define the first independent axis as primary axis.
2853 if (!p_axis
) p_axis
= axis
;
2856 if (p_axis
=== undefined
) {
2857 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2859 // Add ticks. By default, all axes inherit the tick positions of the
2860 // primary axis. However, if an axis is specifically marked as having
2861 // independent ticks, then that is permissible as well.
2862 for (var i
= 0; i
< numAxes
; i
++) {
2863 var axis
= this.axes_
[i
];
2865 if (!axis
.independentTicks
) {
2866 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2867 var ticker
= opts('ticker');
2868 var p_ticks
= p_axis
.ticks
;
2869 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2870 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2871 var tick_values
= [];
2872 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2873 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2874 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2875 tick_values
.push(y_val
);
2878 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2879 axis
.computedValueRange
[1],
2880 this.height_
, // TODO(danvk): should be area.height
2889 * Detects the type of the str (date or numeric) and sets the various
2890 * formatting attributes in this.attrs_ based on this type.
2891 * @param {String} str An x value.
2894 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2896 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2897 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2898 str
.indexOf('/') >= 0 ||
2899 isNaN(parseFloat(str
))) {
2901 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2902 // TODO(danvk): remove support for this format.
2906 this.setXAxisOptions_(isDate
);
2909 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2911 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2912 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2913 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2914 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2916 /** @private (shut up, jsdoc!) */
2917 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2918 // TODO(danvk): use Dygraph.numberValueFormatter here?
2919 /** @private (shut up, jsdoc!) */
2920 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2921 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2922 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2927 * Parses the value as a floating point number. This is like the parseFloat()
2928 * built-in, but with a few differences:
2929 * - the empty string is parsed as null, rather than NaN.
2930 * - if the string cannot be parsed at all, an error is logged.
2931 * If the string can't be parsed, this method returns null.
2932 * @param {String} x The string to be parsed
2933 * @param {Number} opt_line_no The line number from which the string comes.
2934 * @param {String} opt_line The text of the line from which the string comes.
2938 // Parse the x as a float or return null if it's not a number.
2939 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2940 var val
= parseFloat(x
);
2941 if (!isNaN(val
)) return val
;
2943 // Try to figure out what happeend.
2944 // If the value is the empty string, parse it as null.
2945 if (/^ *$/.test(x
)) return null;
2947 // If it was actually "NaN", return it as NaN.
2948 if (/^ *nan *$/i.test(x
)) return NaN
;
2950 // Looks like a parsing error.
2951 var msg
= "Unable to parse '" + x
+ "' as a number";
2952 if (opt_line
!== null && opt_line_no
!== null) {
2953 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2962 * Parses a string in a special csv format. We expect a csv file where each
2963 * line is a date point, and the first field in each line is the date string.
2964 * We also expect that all remaining fields represent series.
2965 * if the errorBars attribute is set, then interpret the fields as:
2966 * date, series1, stddev1, series2, stddev2, ...
2967 * @param {[Object]} data See above.
2969 * @return [Object] An array with one entry for each row. These entries
2970 * are an array of cells in that row. The first entry is the parsed x-value for
2971 * the row. The second, third, etc. are the y-values. These can take on one of
2972 * three forms, depending on the CSV and constructor parameters:
2974 * 2. [ value, stddev ]
2975 * 3. [ low value, center value, high value ]
2977 Dygraph
.prototype.parseCSV_
= function(data
) {
2979 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2980 var lines
= data
.split(line_delimiter
|| "\n");
2983 // Use the default delimiter or fall back to a tab if that makes sense.
2984 var delim
= this.attr_('delimiter');
2985 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2990 if (!('labels' in this.user_attrs_
)) {
2991 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2993 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2994 this.attributes_
.reparseSeries();
2999 var defaultParserSet
= false; // attempt to auto-detect x value type
3000 var expectedCols
= this.attr_("labels").length
;
3001 var outOfOrder
= false;
3002 for (var i
= start
; i
< lines
.length
; i
++) {
3003 var line
= lines
[i
];
3005 if (line
.length
=== 0) continue; // skip blank lines
3006 if (line
[0] == '#') continue; // skip comment lines
3007 var inFields
= line
.split(delim
);
3008 if (inFields
.length
< 2) continue;
3011 if (!defaultParserSet
) {
3012 this.detectTypeFromString_(inFields
[0]);
3013 xParser
= this.attr_("xValueParser");
3014 defaultParserSet
= true;
3016 fields
[0] = xParser(inFields
[0], this);
3018 // If fractions are expected, parse the numbers as "A/B
"
3019 if (this.fractions_) {
3020 for (j = 1; j < inFields.length; j++) {
3021 // TODO(danvk): figure out an appropriate way to flag parse errors.
3022 vals = inFields[j].split("/");
3023 if (vals.length != 2) {
3024 this.error('Expected fractional "num
/den
" values in CSV data ' +
3025 "but found a value
'" + inFields[j] + "' on line
" +
3026 (1 + i) + " ('" + line + "') which is not of
this form
.");
3029 fields[j] = [this.parseFloat_(vals[0], i, line),
3030 this.parseFloat_(vals[1], i, line)];
3033 } else if (this.attr_("errorBars
")) {
3034 // If there are error bars, values are (value, stddev) pairs
3035 if (inFields.length % 2 != 1) {
3036 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3037 'but line ' + (1 + i) + ' has an odd number of values (' +
3038 (inFields.length - 1) + "): '" + line + "'");
3040 for (j = 1; j < inFields.length; j += 2) {
3041 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3042 this.parseFloat_(inFields[j + 1], i, line)];
3044 } else if (this.attr_("customBars
")) {
3045 // Bars are a low;center;high tuple
3046 for (j = 1; j < inFields.length; j++) {
3047 var val = inFields[j];
3048 if (/^ *$/.test(val)) {
3049 fields[j] = [null, null, null];
3051 vals = val.split(";");
3052 if (vals.length == 3) {
3053 fields[j] = [ this.parseFloat_(vals[0], i, line),
3054 this.parseFloat_(vals[1], i, line),
3055 this.parseFloat_(vals[2], i, line) ];
3057 this.warn('When using customBars, values must be either blank ' +
3058 'or "low
;center
;high
" tuples (got "' + val +
3059 '" on line ' + (1+i));
3064 // Values are just numbers
3065 for (j = 1; j < inFields.length; j++) {
3066 fields[j] = this.parseFloat_(inFields[j], i, line);
3069 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3073 if (fields.length != expectedCols) {
3074 this.error("Number of columns
in line
" + i + " (" + fields.length +
3075 ") does not agree
with number of
labels (" + expectedCols +
3079 // If the user specified the 'labels' option and none of the cells of the
3080 // first row parsed correctly, then they probably double-specified the
3081 // labels. We go with the values set in the option, discard this row and
3082 // log a warning to the JS console.
3083 if (i === 0 && this.attr_('labels')) {
3084 var all_null = true;
3085 for (j = 0; all_null && j < fields.length; j++) {
3086 if (fields[j]) all_null = false;
3089 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3090 "CSV
data ('" + line + "') appears to also contain labels
. " +
3091 "Will drop the CSV labels and
use the option labels
.");
3099 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3100 ret.sort(function(a,b) { return a[0] - b[0]; });
3108 * The user has provided their data as a pre-packaged JS array. If the x values
3109 * are numeric, this is the same as dygraphs' internal format. If the x values
3110 * are dates, we need to convert them from Date objects to ms since epoch.
3111 * @param {[Object]} data
3112 * @return {[Object]} data with numeric x values.
3114 Dygraph.prototype.parseArray_ = function(data) {
3115 // Peek at the first x value to see if it's numeric.
3116 if (data.length === 0) {
3117 this.error("Can
't plot empty data set");
3120 if (data[0].length === 0) {
3121 this.error("Data set cannot contain an empty row");
3126 if (this.attr_("labels") === null) {
3127 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3128 "in the options parameter");
3129 this.attrs_.labels = [ "X" ];
3130 for (i = 1; i < data[0].length; i++) {
3131 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3133 this.attributes_.reparseSeries();
3135 var num_labels = this.attr_("labels");
3136 if (num_labels.length != data[0].length) {
3137 this.error("Mismatch between number of labels (" + num_labels +
3138 ") and number of columns in array (" + data[0].length + ")");
3143 if (Dygraph.isDateLike(data[0][0])) {
3144 // Some intelligent defaults for a date x-axis.
3145 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3146 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3147 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3149 // Assume they're all dates
.
3150 var parsedData
= Dygraph
.clone(data
);
3151 for (i
= 0; i
< data
.length
; i
++) {
3152 if (parsedData
[i
].length
=== 0) {
3153 this.error("Row " + (1 + i
) + " of data is empty");
3156 if (parsedData
[i
][0] === null ||
3157 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3158 isNaN(parsedData
[i
][0].getTime())) {
3159 this.error("x value in row " + (1 + i
) + " is not a Date");
3162 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3166 // Some intelligent defaults for a numeric x-axis.
3167 /** @private (shut up, jsdoc!) */
3168 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3169 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3170 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3176 * Parses a DataTable object from gviz.
3177 * The data is expected to have a first column that is either a date or a
3178 * number. All subsequent columns must be numbers. If there is a clear mismatch
3179 * between this.xValueParser_ and the type of the first column, it will be
3180 * fixed. Fills out rawData_.
3181 * @param {[Object]} data See above.
3184 Dygraph
.prototype.parseDataTable_
= function(data
) {
3185 var shortTextForAnnotationNum
= function(num
) {
3186 // converts [0-9]+ [A-Z][a-z]*
3187 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3188 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3189 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3190 num
= Math
.floor(num
/ 26);
3192 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3193 num
= Math
.floor((num
- 1) / 26);
3198 var cols
= data
.getNumberOfColumns();
3199 var rows
= data
.getNumberOfRows();
3201 var indepType
= data
.getColumnType(0);
3202 if (indepType
== 'date' || indepType
== 'datetime') {
3203 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3204 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3205 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3206 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3207 } else if (indepType
== 'number') {
3208 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3209 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3210 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3211 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3213 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3214 "column 1 of DataTable input (Got '" + indepType
+ "')");
3218 // Array of the column indices which contain data (and not annotations).
3220 var annotationCols
= {}; // data index -> [annotation cols]
3221 var hasAnnotations
= false;
3223 for (i
= 1; i
< cols
; i
++) {
3224 var type
= data
.getColumnType(i
);
3225 if (type
== 'number') {
3227 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3228 // This is OK -- it's an annotation column.
3229 var dataIdx
= colIdx
[colIdx
.length
- 1];
3230 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3231 annotationCols
[dataIdx
] = [i
];
3233 annotationCols
[dataIdx
].push(i
);
3235 hasAnnotations
= true;
3237 this.error("Only 'number' is supported as a dependent type with Gviz." +
3238 " 'string' is only supported if displayAnnotations is true");
3242 // Read column labels
3243 // TODO(danvk): add support back for errorBars
3244 var labels
= [data
.getColumnLabel(0)];
3245 for (i
= 0; i
< colIdx
.length
; i
++) {
3246 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3247 if (this.attr_("errorBars")) i
+= 1;
3249 this.attrs_
.labels
= labels
;
3250 cols
= labels
.length
;
3253 var outOfOrder
= false;
3254 var annotations
= [];
3255 for (i
= 0; i
< rows
; i
++) {
3257 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3258 data
.getValue(i
, 0) === null) {
3259 this.warn("Ignoring row " + i
+
3260 " of DataTable because of undefined or null first column.");
3264 if (indepType
== 'date' || indepType
== 'datetime') {
3265 row
.push(data
.getValue(i
, 0).getTime());
3267 row
.push(data
.getValue(i
, 0));
3269 if (!this.attr_("errorBars")) {
3270 for (j
= 0; j
< colIdx
.length
; j
++) {
3271 var col
= colIdx
[j
];
3272 row
.push(data
.getValue(i
, col
));
3273 if (hasAnnotations
&&
3274 annotationCols
.hasOwnProperty(col
) &&
3275 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3277 ann
.series
= data
.getColumnLabel(col
);
3279 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3281 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3282 if (k
) ann
.text
+= "\n";
3283 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3285 annotations
.push(ann
);
3289 // Strip out infinities, which give dygraphs problems later on.
3290 for (j
= 0; j
< row
.length
; j
++) {
3291 if (!isFinite(row
[j
])) row
[j
] = null;
3294 for (j
= 0; j
< cols
- 1; j
++) {
3295 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3298 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3305 this.warn("DataTable is out of order; order it correctly to speed loading.");
3306 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3308 this.rawData_
= ret
;
3310 if (annotations
.length
> 0) {
3311 this.setAnnotations(annotations
, true);
3313 this.attributes_
.reparseSeries();
3317 * Get the CSV data. If it's in a function, call that function. If it's in a
3318 * file, do an XMLHttpRequest to get it.
3321 Dygraph
.prototype.start_
= function() {
3322 var data
= this.file_
;
3324 // Functions can return references of all other types.
3325 if (typeof data
== 'function') {
3329 if (Dygraph
.isArrayLike(data
)) {
3330 this.rawData_
= this.parseArray_(data
);
3332 } else if (typeof data
== 'object' &&
3333 typeof data
.getColumnRange
== 'function') {
3334 // must be a DataTable from gviz.
3335 this.parseDataTable_(data
);
3337 } else if (typeof data
== 'string') {
3338 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3339 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3340 if (line_delimiter
) {
3341 this.loadedEvent_(data
);
3345 if (window
.XMLHttpRequest
) {
3346 // Firefox, Opera, IE7, and other browsers will use the native object
3347 req
= new XMLHttpRequest();
3349 // IE 5 and 6 will use the ActiveX control
3350 req
= new ActiveXObject("Microsoft.XMLHTTP");
3354 req
.onreadystatechange
= function () {
3355 if (req
.readyState
== 4) {
3356 if (req
.status
=== 200 || // Normal http
3357 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3358 caller
.loadedEvent_(req
.responseText
);
3363 req
.open("GET", data
, true);
3367 this.error("Unknown data format: " + (typeof data
));
3372 * Changes various properties of the graph. These can include:
3374 * <li>file: changes the source data for the graph</li>
3375 * <li>errorBars: changes whether the data contains stddev</li>
3378 * There's a huge variety of options that can be passed to this method. For a
3379 * full list, see http://dygraphs.com/options.html.
3381 * @param {Object} attrs The new properties and values
3382 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3383 * call to updateOptions(). If you know better, you can pass true to explicitly
3384 * block the redraw. This can be useful for chaining updateOptions() calls,
3385 * avoiding the occasional infinite loop and preventing redraws when it's not
3386 * necessary (e.g. when updating a callback).
3388 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3389 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3391 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3392 var file
= input_attrs
.file
;
3393 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3395 // TODO(danvk): this is a mess. Move these options into attr_.
3396 if ('rollPeriod' in attrs
) {
3397 this.rollPeriod_
= attrs
.rollPeriod
;
3399 if ('dateWindow' in attrs
) {
3400 this.dateWindow_
= attrs
.dateWindow
;
3401 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3402 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3405 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3406 this.zoomed_y_
= (attrs
.valueRange
!== null);
3409 // TODO(danvk): validate per-series options.
3414 // highlightCircleSize
3416 // Check if this set options will require new points.
3417 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3419 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3421 this.attributes_
.reparseSeries();
3425 if (!block_redraw
) this.start_();
3427 if (!block_redraw
) {
3428 if (requiresNewPoints
) {
3431 this.renderGraph_(false);
3438 * Returns a copy of the options with deprecated names converted into current
3439 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3440 * interested in that, they should save a copy before calling this.
3443 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3445 for (var k
in attrs
) {
3446 if (k
== 'file') continue;
3447 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3450 var set
= function(axis
, opt
, value
) {
3451 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3452 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3453 my_attrs
.axes
[axis
][opt
] = value
;
3455 var map
= function(opt
, axis
, new_opt
) {
3456 if (typeof(attrs
[opt
]) != 'undefined') {
3457 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3458 new_opt
+ " option for the " + axis
+ " axis instead. " +
3459 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3460 "(see http://dygraphs.com/per-axis.html for more information.");
3461 set(axis
, new_opt
, attrs
[opt
]);
3462 delete my_attrs
[opt
];
3466 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3467 map('xValueFormatter', 'x', 'valueFormatter');
3468 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3469 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3470 map('xTicker', 'x', 'ticker');
3471 map('yValueFormatter', 'y', 'valueFormatter');
3472 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3473 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3474 map('yTicker', 'y', 'ticker');
3475 map('drawXGrid', 'x', 'drawGrid');
3476 map('drawXAxis', 'x', 'drawAxis');
3477 map('drawYGrid', 'y', 'drawGrid');
3478 map('drawYAxis', 'y', 'drawAxis');
3483 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3484 * containing div (which has presumably changed size since the dygraph was
3485 * instantiated. If the width/height are specified, the div will be resized.
3487 * This is far more efficient than destroying and re-instantiating a
3488 * Dygraph, since it doesn't have to reparse the underlying data.
3490 * @param {Number} [width] Width (in pixels)
3491 * @param {Number} [height] Height (in pixels)
3493 Dygraph
.prototype.resize
= function(width
, height
) {
3494 if (this.resize_lock
) {
3497 this.resize_lock
= true;
3499 if ((width
=== null) != (height
=== null)) {
3500 this.warn("Dygraph.resize() should be called with zero parameters or " +
3501 "two non-NULL parameters. Pretending it was zero.");
3502 width
= height
= null;
3505 var old_width
= this.width_
;
3506 var old_height
= this.height_
;
3509 this.maindiv_
.style
.width
= width
+ "px";
3510 this.maindiv_
.style
.height
= height
+ "px";
3511 this.width_
= width
;
3512 this.height_
= height
;
3514 this.width_
= this.maindiv_
.clientWidth
;
3515 this.height_
= this.maindiv_
.clientHeight
;
3518 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3519 // Resizing a canvas erases it, even when the size doesn't change, so
3520 // any resize needs to be followed by a redraw.
3521 this.resizeElements_();
3525 this.resize_lock
= false;
3529 * Adjusts the number of points in the rolling average. Updates the graph to
3530 * reflect the new averaging period.
3531 * @param {Number} length Number of points over which to average the data.
3533 Dygraph
.prototype.adjustRoll
= function(length
) {
3534 this.rollPeriod_
= length
;
3539 * Returns a boolean array of visibility statuses.
3541 Dygraph
.prototype.visibility
= function() {
3542 // Do lazy-initialization, so that this happens after we know the number of
3544 if (!this.attr_("visibility")) {
3545 this.attrs_
.visibility
= [];
3547 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3548 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3549 this.attrs_
.visibility
.push(true);
3551 return this.attr_("visibility");
3555 * Changes the visiblity of a series.
3557 * @param {number} num the series index
3558 * @param {boolean} value true or false, identifying the visibility.
3560 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3561 var x
= this.visibility();
3562 if (num
< 0 || num
>= x
.length
) {
3563 this.warn("invalid series number in setVisibility: " + num
);
3571 * How large of an area will the dygraph render itself in?
3572 * This is used for testing.
3573 * @return A {width: w, height: h} object.
3576 Dygraph
.prototype.size
= function() {
3577 return { width
: this.width_
, height
: this.height_
};
3581 * Update the list of annotations and redraw the chart.
3582 * See dygraphs.com/annotations.html for more info on how to use annotations.
3583 * @param ann {Array} An array of annotation objects.
3584 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3586 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3587 // Only add the annotation CSS rule once we know it will be used.
3588 Dygraph
.addAnnotationRule();
3589 this.annotations_
= ann
;
3590 if (!this.layout_
) {
3591 this.warn("Tried to setAnnotations before dygraph was ready. " +
3592 "Try setting them in a ready() block. See " +
3593 "dygraphs.com/tests/annotation.html");
3597 this.layout_
.setAnnotations(this.annotations_
);
3598 if (!suppressDraw
) {
3604 * Return the list of annotations.
3606 Dygraph
.prototype.annotations
= function() {
3607 return this.annotations_
;
3611 * Get the list of label names for this graph. The first column is the
3612 * x-axis, so the data series names start at index 1.
3614 * Returns null when labels have not yet been defined.
3616 Dygraph
.prototype.getLabels
= function() {
3617 var labels
= this.attr_("labels");
3618 return labels
? labels
.slice() : null;
3622 * Get the index of a series (column) given its name. The first column is the
3623 * x-axis, so the data series start with index 1.
3625 Dygraph
.prototype.indexFromSetName
= function(name
) {
3626 return this.setIndexByName_
[name
];
3630 * Trigger a callback when the dygraph has drawn itself and is ready to be
3631 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3632 * data (i.e. a URL is passed as the data source) and the chart is drawn
3633 * asynchronously. If the chart has already drawn, the callback will fire
3636 * This is a good place to call setAnnotation().
3638 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3641 Dygraph
.prototype.ready
= function(callback
) {
3642 if (this.is_initial_draw_
) {
3643 this.readyFns_
.push(callback
);
3651 * Adds a default style for the annotation CSS classes to the document. This is
3652 * only executed when annotations are actually used. It is designed to only be
3653 * called once -- all calls after the first will return immediately.
3655 Dygraph
.addAnnotationRule
= function() {
3656 // TODO(danvk): move this function into plugins/annotations.js
?
3657 if (Dygraph
.addedAnnotationCSS
) return;
3659 var rule
= "border: 1px solid black; " +
3660 "background-color: white; " +
3661 "text-align: center;";
3663 var styleSheetElement
= document
.createElement("style");
3664 styleSheetElement
.type
= "text/css";
3665 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3667 // Find the first style sheet that we can access.
3668 // We may not add a rule to a style sheet from another domain for security
3669 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3670 // adds its own style sheets from google.com.
3671 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3672 if (document
.styleSheets
[i
].disabled
) continue;
3673 var mysheet
= document
.styleSheets
[i
];
3675 if (mysheet
.insertRule
) { // Firefox
3676 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3677 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3678 } else if (mysheet
.addRule
) { // IE
3679 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3681 Dygraph
.addedAnnotationCSS
= true;
3684 // Was likely a security exception.
3688 this.warn("Unable to add default annotation CSS rule; display may be off.");