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 // For "production" code, this gets set to false by uglifyjs.
47 if (typeof(DEBUG
) === 'undefined') DEBUG
=true;
49 var Dygraph
= (function() {
50 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
54 * Creates an interactive, zoomable chart.
57 * @param {div | String} div A div or the id of a div into which to construct
59 * @param {String | Function} file A file containing CSV data or a function
60 * that returns this data. The most basic expected format for each line is
61 * "YYYY/MM/DD,val1,val2,...". For more information, see
62 * http://dygraphs.com/data.html.
63 * @param {Object} attrs Various other attributes, e.g. errorBars determines
64 * whether the input data contains error ranges. For a complete list of
65 * options, see http://dygraphs.com/options.html.
67 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
68 // These have to go above the "Hack for IE" in __init__ since .ready() can be
69 // called as soon as the constructor returns. Once support for OldIE is
70 // dropped, this can go down with the rest of the initializers.
71 this.is_initial_draw_
= true;
74 if (opt_fourth_param
!== undefined
) {
75 // Old versions of dygraphs took in the series labels as a constructor
76 // parameter. This doesn't make sense anymore, but it's easy to continue
77 // to support this usage.
78 console
.warn("Using deprecated four-argument dygraph constructor");
79 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
81 this.__init__(div
, data
, opts
);
85 Dygraph
.NAME
= "Dygraph";
86 Dygraph
.VERSION
= "1.1.0";
87 Dygraph
.__repr__
= function() {
88 return "[" + Dygraph
.NAME
+ " " + Dygraph
.VERSION
+ "]";
92 * Returns information about the Dygraph class.
94 Dygraph
.toString
= function() {
95 return Dygraph
.__repr__();
98 // Various default values
99 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
100 Dygraph
.DEFAULT_WIDTH
= 480;
101 Dygraph
.DEFAULT_HEIGHT
= 320;
103 // For max 60 Hz. animation:
104 Dygraph
.ANIMATION_STEPS
= 12;
105 Dygraph
.ANIMATION_DURATION
= 200;
107 // Label constants for the labelsKMB and labelsKMG2 options.
108 // (i.e. '100000' -> '100K')
109 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
110 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
111 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
113 // These are defined before DEFAULT_ATTRS so that it can refer to them.
116 * Return a string version of a number. This respects the digitsAfterDecimal
117 * and maxNumberWidth options.
118 * @param {number} x The number to be formatted
119 * @param {Dygraph} opts An options view
121 Dygraph
.numberValueFormatter
= function(x
, opts
) {
122 var sigFigs
= opts('sigFigs');
124 if (sigFigs
!== null) {
125 // User has opted for a fixed number of significant figures.
126 return Dygraph
.floatFormat(x
, sigFigs
);
129 var digits
= opts('digitsAfterDecimal');
130 var maxNumberWidth
= opts('maxNumberWidth');
132 var kmb
= opts('labelsKMB');
133 var kmg2
= opts('labelsKMG2');
137 // switch to scientific notation if we underflow or overflow fixed display.
139 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
140 Math
.abs(x
) < Math
.pow(10, -digits
))) {
141 label
= x
.toExponential(digits
);
143 label
= '' + Dygraph
.round_(x
, digits
);
152 k_labels
= Dygraph
.KMB_LABELS
;
155 if (kmb
) console
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
157 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
158 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
161 var absx
= Math
.abs(x
);
162 var n
= Dygraph
.pow(k
, k_labels
.length
);
163 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
165 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
170 // TODO(danvk): clean up this logic. Why so different than kmb?
171 var x_parts
= String(x
.toExponential()).split('e-');
172 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
173 if (x_parts
[1] % 3 > 0) {
174 label
= Dygraph
.round_(x_parts
[0] /
175 Dygraph
.pow(10, (x_parts
[1] % 3)),
178 label
= Number(x_parts
[0]).toFixed(2);
180 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
189 * variant for use as an axisLabelFormatter.
192 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
) {
193 return Dygraph
.numberValueFormatter
.call(this, x
, opts
);
197 * @type {!Array.<string>}
201 Dygraph
.SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
205 * Convert a JS date to a string appropriate to display on an axis that
206 * is displaying values at the stated granularity. This respects the
208 * @param {Date} date The date to format
209 * @param {number} granularity One of the Dygraph granularity constants
210 * @param {Dygraph} opts An options view
211 * @return {string} The date formatted as local time
214 Dygraph
.dateAxisLabelFormatter
= function(date
, granularity
, opts
) {
215 var utc
= opts('labelsUTC');
216 var accessors
= utc
? Dygraph
.DateAccessorsUTC
: Dygraph
.DateAccessorsLocal
;
218 var year
= accessors
.getFullYear(date
),
219 month
= accessors
.getMonth(date
),
220 day
= accessors
.getDate(date
),
221 hours
= accessors
.getHours(date
),
222 mins
= accessors
.getMinutes(date
),
223 secs
= accessors
.getSeconds(date
),
224 millis
= accessors
.getSeconds(date
);
226 if (granularity
>= Dygraph
.DECADAL
) {
228 } else if (granularity
>= Dygraph
.MONTHLY
) {
229 return Dygraph
.SHORT_MONTH_NAMES_
[month
] + ' ' + year
;
231 var frac
= hours
* 3600 + mins
* 60 + secs
+ 1e-3 * millis
;
232 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
233 // e.g. '21 Jan' (%d%b)
234 return Dygraph
.zeropad(day
) + ' ' + Dygraph
.SHORT_MONTH_NAMES_
[month
];
236 return Dygraph
.hmsString_(hours
, mins
, secs
);
240 // alias in case anyone is referencing the old method.
241 Dygraph
.dateAxisFormatter
= Dygraph
.dateAxisLabelFormatter
;
244 * Return a string version of a JS date for a value label. This respects the
246 * @param {Date} date The date to be formatted
247 * @param {Dygraph} opts An options view
250 Dygraph
.dateValueFormatter
= function(d
, opts
) {
251 return Dygraph
.dateString_(d
, opts('labelsUTC'));
255 * Standard plotters. These may be used by clients.
256 * Available plotters are:
257 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
258 * - Dygraph.Plotters.errorPlotter: draws error bars
259 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
261 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
262 * This causes all the lines to be drawn over all the fills/error bars.
264 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
267 // Default attribute values.
268 Dygraph
.DEFAULT_ATTRS
= {
269 highlightCircleSize
: 3,
270 highlightSeriesOpts
: null,
271 highlightSeriesBackgroundAlpha
: 0.5,
275 // TODO(danvk): move defaults from createStatusMessage_ here.
277 labelsSeparateLines
: false,
278 labelsShowZeroValues
: true,
281 showLabelsOnHighlight
: true,
283 digitsAfterDecimal
: 2,
288 strokeBorderWidth
: 0,
289 strokeBorderColor
: "white",
292 axisLabelFontSize
: 14,
296 xValueParser
: Dygraph
.dateParser
,
303 wilsonInterval
: true, // only relevant if fractions is true
307 connectSeparatedPoints
: false,
310 stackedGraphNaNFill
: 'all',
311 hideOverlayOnMouseOut
: true,
313 legend
: 'onmouseover',
318 drawAxesAtZero
: false,
320 // Sizes of the various chart labels.
325 axisLineColor
: "black",
328 axisLabelColor
: "black",
330 gridLineColor
: "rgb(128,128,128)",
332 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
333 animatedZooms
: false, // (for now)
335 // Range selector options
336 showRangeSelector
: false,
337 rangeSelectorHeight
: 40,
338 rangeSelectorPlotStrokeColor
: "#808FAB",
339 rangeSelectorPlotFillColor
: "#A7B1C4",
340 showInRangeSelector
: null,
342 // The ordering here ensures that central lines always appear above any
343 // fill bars/error bars
.
345 Dygraph
.Plotters
.fillPlotter
,
346 Dygraph
.Plotters
.errorPlotter
,
347 Dygraph
.Plotters
.linePlotter
357 axisLabelFormatter
: Dygraph
.dateAxisLabelFormatter
,
358 valueFormatter
: Dygraph
.dateValueFormatter
,
361 independentTicks
: true,
362 ticker
: null // will be set in dygraph-tickers.js
367 valueFormatter
: Dygraph
.numberValueFormatter
,
368 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
371 independentTicks
: true,
372 ticker
: null // will be set in dygraph-tickers.js
377 valueFormatter
: Dygraph
.numberValueFormatter
,
378 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
379 drawAxis
: true, // only applies when there are two axes of data.
381 independentTicks
: false,
382 ticker
: null // will be set in dygraph-tickers.js
387 // Directions for panning and zooming. Use bit operations when combined
388 // values are possible.
389 Dygraph
.HORIZONTAL
= 1;
390 Dygraph
.VERTICAL
= 2;
392 // Installed plugins, in order of precedence (most-general to most-specific).
393 // Plugins are installed after they are defined, in plugins/install.js
.
397 // Used for initializing annotation CSS rules only once.
398 Dygraph
.addedAnnotationCSS
= false;
400 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
401 // Labels is no longer a constructor parameter, since it's typically set
402 // directly from the data source. It also conains a name for the x-axis,
403 // which the previous constructor form did not.
404 if (labels
!== null) {
405 var new_labels
= ["Date"];
406 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
407 Dygraph
.update(attrs
, { 'labels': new_labels
});
409 this.__init__(div
, file
, attrs
);
413 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
414 * and context <canvas> inside of it. See the constructor for details.
416 * @param {Element} div the Element to render the graph into.
417 * @param {string | Function} file Source data
418 * @param {Object} attrs Miscellaneous other options
421 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
422 // Support two-argument constructor
423 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
425 attrs
= Dygraph
.copyUserAttrs_(attrs
);
427 if (typeof(div
) == 'string') {
428 div
= document
.getElementById(div
);
432 console
.error("Constructing dygraph with a non-existent div!");
436 // Copy the important bits into the object
437 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
440 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
441 this.previousVerticalX_
= -1;
442 this.fractions_
= attrs
.fractions
|| false;
443 this.dateWindow_
= attrs
.dateWindow
|| null;
445 this.annotations_
= [];
447 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
448 this.zoomed_x_
= false;
449 this.zoomed_y_
= false;
451 // Clear the div. This ensure that, if multiple dygraphs are passed the same
452 // div, then only one will be drawn.
455 // For historical reasons, the 'width' and 'height' options trump all CSS
456 // rules _except_ for an explicit 'width' or 'height' on the div.
457 // As an added convenience, if the div has zero height (like <div></div> does
458 // without any styles), then we use a default height/width
.
459 if (div
.style
.width
=== '' && attrs
.width
) {
460 div
.style
.width
= attrs
.width
+ "px";
462 if (div
.style
.height
=== '' && attrs
.height
) {
463 div
.style
.height
= attrs
.height
+ "px";
465 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
466 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
467 if (div
.style
.width
=== '') {
468 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
471 // These will be zero if the dygraph's div is hidden. In that case,
472 // use the user-specified attributes if present. If not, use zero
473 // and assume the user will call resize to fix things later.
474 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
475 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
477 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
478 if (attrs
.stackedGraph
) {
479 attrs
.fillGraph
= true;
480 // TODO(nikhilk): Add any other stackedGraph checks here.
483 // DEPRECATION WARNING: All option processing should be moved from
484 // attrs_ and user_attrs_ to options_, which holds all this information.
486 // Dygraphs has many options, some of which interact with one another.
487 // To keep track of everything, we maintain two sets of options:
489 // this.user_attrs_ only options explicitly set by the user.
490 // this.attrs_ defaults, options derived from user_attrs_, data.
492 // Options are then accessed this.attr_('attr'), which first looks at
493 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
494 // defaults without overriding behavior that the user specifically asks for.
495 this.user_attrs_
= {};
496 Dygraph
.update(this.user_attrs_
, attrs
);
498 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
500 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
502 this.boundaryIds_
= [];
503 this.setIndexByName_
= {};
504 this.datasetIndex_
= [];
506 this.registeredEvents_
= [];
507 this.eventListeners_
= {};
509 this.attributes_
= new DygraphOptions(this);
511 // Create the containing DIV and other interactive elements
512 this.createInterface_();
516 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
517 for (var i
= 0; i
< plugins
.length
; i
++) {
518 // the plugins option may contain either plugin classes or instances.
519 // Plugin instances contain an activate method.
520 var Plugin
= plugins
[i
]; // either a constructor or an instance.
522 if (typeof(Plugin
.activate
) !== 'undefined') {
523 pluginInstance
= Plugin
;
525 pluginInstance
= new Plugin();
529 plugin
: pluginInstance
,
535 var handlers
= pluginInstance
.activate(this);
536 for (var eventName
in handlers
) {
537 if (!handlers
.hasOwnProperty(eventName
)) continue;
538 // TODO(danvk): validate eventName.
539 pluginDict
.events
[eventName
] = handlers
[eventName
];
542 this.plugins_
.push(pluginDict
);
545 // At this point, plugins can no longer register event handlers.
546 // Construct a map from event -> ordered list of [callback, plugin].
547 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
548 var plugin_dict
= this.plugins_
[i
];
549 for (var eventName
in plugin_dict
.events
) {
550 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
551 var callback
= plugin_dict
.events
[eventName
];
553 var pair
= [plugin_dict
.plugin
, callback
];
554 if (!(eventName
in this.eventListeners_
)) {
555 this.eventListeners_
[eventName
] = [pair
];
557 this.eventListeners_
[eventName
].push(pair
);
562 this.createDragInterface_();
568 * Triggers a cascade of events to the various plugins which are interested in them.
569 * Returns true if the "default behavior" should be prevented, i.e. if one
570 * of the event listeners called event.preventDefault().
573 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
574 if (!(name
in this.eventListeners_
)) return false;
576 // QUESTION: can we use objects & prototypes to speed this up?
580 defaultPrevented
: false,
581 preventDefault
: function() {
582 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
583 e
.defaultPrevented
= true;
585 propagationStopped
: false,
586 stopPropagation
: function() {
587 e
.propagationStopped
= true;
590 Dygraph
.update(e
, extra_props
);
592 var callback_plugin_pairs
= this.eventListeners_
[name
];
593 if (callback_plugin_pairs
) {
594 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
595 var plugin
= callback_plugin_pairs
[i
][0];
596 var callback
= callback_plugin_pairs
[i
][1];
597 callback
.call(plugin
, e
);
598 if (e
.propagationStopped
) break;
601 return e
.defaultPrevented
;
605 * Fetch a plugin instance of a particular class. Only for testing.
607 * @param {!Class} type The type of the plugin.
608 * @return {Object} Instance of the plugin, or null if there is none.
610 Dygraph
.prototype.getPluginInstance_
= function(type
) {
611 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
612 var p
= this.plugins_
[i
];
613 if (p
.plugin
instanceof type
) {
621 * Returns the zoomed status of the chart for one or both axes.
623 * Axis is an optional parameter. Can be set to 'x' or 'y'.
625 * The zoomed status for an axis is set whenever a user zooms using the mouse
626 * or when the dateWindow or valueRange are updated (unless the
627 * isZoomedIgnoreProgrammaticZoom option is also specified).
629 Dygraph
.prototype.isZoomed
= function(axis
) {
630 if (axis
=== null || axis
=== undefined
) {
631 return this.zoomed_x_
|| this.zoomed_y_
;
633 if (axis
=== 'x') return this.zoomed_x_
;
634 if (axis
=== 'y') return this.zoomed_y_
;
635 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
639 * Returns information about the Dygraph object, including its containing ID.
641 Dygraph
.prototype.toString
= function() {
642 var maindiv
= this.maindiv_
;
643 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
644 return "[Dygraph " + id
+ "]";
649 * Returns the value of an option. This may be set by the user (either in the
650 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
652 * @param {string} name The name of the option, e.g. 'rollPeriod'.
653 * @param {string} [seriesName] The name of the series to which the option
654 * will be applied. If no per-series value of this option is available, then
655 * the global value is returned. This is optional.
656 * @return { ... } The value of the option.
658 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
660 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
661 console
.error('Must include options reference JS for testing');
662 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
663 console
.error('Dygraphs is using property ' + name
+ ', which has no ' +
664 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
665 // Only log this error once.
666 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
669 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
673 * Returns the current value for an option, as set in the constructor or via
674 * updateOptions. You may pass in an (optional) series name to get per-series
675 * values for the option.
677 * All values returned by this method should be considered immutable. If you
678 * modify them, there is no guarantee that the changes will be honored or that
679 * dygraphs will remain in a consistent state. If you want to modify an option,
680 * use updateOptions() instead.
682 * @param {string} name The name of the option (e.g. 'strokeWidth')
683 * @param {string=} opt_seriesName Series name to get per-series values.
684 * @return {*} The value of the option.
686 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
687 return this.attr_(name
, opt_seriesName
);
691 * Like getOption(), but specifically returns a number.
692 * This is a convenience function for working with the Closure Compiler.
693 * @param {string} name The name of the option (e.g. 'strokeWidth')
694 * @param {string=} opt_seriesName Series name to get per-series values.
695 * @return {number} The value of the option.
698 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
699 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
703 * Like getOption(), but specifically returns a string.
704 * This is a convenience function for working with the Closure Compiler.
705 * @param {string} name The name of the option (e.g. 'strokeWidth')
706 * @param {string=} opt_seriesName Series name to get per-series values.
707 * @return {string} The value of the option.
710 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
711 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
715 * Like getOption(), but specifically returns a boolean.
716 * This is a convenience function for working with the Closure Compiler.
717 * @param {string} name The name of the option (e.g. 'strokeWidth')
718 * @param {string=} opt_seriesName Series name to get per-series values.
719 * @return {boolean} The value of the option.
722 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
723 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
727 * Like getOption(), but specifically returns a function.
728 * This is a convenience function for working with the Closure Compiler.
729 * @param {string} name The name of the option (e.g. 'strokeWidth')
730 * @param {string=} opt_seriesName Series name to get per-series values.
731 * @return {function(...)} The value of the option.
734 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
735 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
738 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
739 return this.attributes_
.getForAxis(name
, axis
);
744 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
745 * @return { ... } A function mapping string -> option value
747 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
749 return function(opt
) {
750 var axis_opts
= self
.user_attrs_
.axes
;
751 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
752 return axis_opts
[axis
][opt
];
755 // I don't like that this is in a second spot.
756 if (axis
=== 'x' && opt
=== 'logscale') {
757 // return the default value.
758 // TODO(konigsberg): pull the default from a global default.
762 // user-specified attributes always trump defaults, even if they're less
764 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
765 return self
.user_attrs_
[opt
];
768 axis_opts
= self
.attrs_
.axes
;
769 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
770 return axis_opts
[axis
][opt
];
772 // check old-style axis options
773 // TODO(danvk): add a deprecation warning if either of these match.
774 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
775 return self
.axes_
[0][opt
];
776 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
777 return self
.axes_
[1][opt
];
779 return self
.attr_(opt
);
784 * Returns the current rolling period, as set by the user or an option.
785 * @return {number} The number of points in the rolling window
787 Dygraph
.prototype.rollPeriod
= function() {
788 return this.rollPeriod_
;
792 * Returns the currently-visible x-range. This can be affected by zooming,
793 * panning or a call to updateOptions.
794 * Returns a two-element array: [left, right].
795 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
797 Dygraph
.prototype.xAxisRange
= function() {
798 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
802 * Returns the lower- and upper-bound x-axis values of the
805 Dygraph
.prototype.xAxisExtremes
= function() {
806 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
807 if (this.numRows() === 0) {
808 return [0 - pad
, 1 + pad
];
810 var left
= this.rawData_
[0][0];
811 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
813 // Must keep this in sync with dygraph-layout _evaluateLimits()
814 var range
= right
- left
;
816 right
+= range
* pad
;
818 return [left
, right
];
822 * Returns the currently-visible y-range for an axis. This can be affected by
823 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
824 * called with no arguments, returns the range of the first axis.
825 * Returns a two-element array: [bottom, top].
827 Dygraph
.prototype.yAxisRange
= function(idx
) {
828 if (typeof(idx
) == "undefined") idx
= 0;
829 if (idx
< 0 || idx
>= this.axes_
.length
) {
832 var axis
= this.axes_
[idx
];
833 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
837 * Returns the currently-visible y-ranges for each axis. This can be affected by
838 * zooming, panning, calls to updateOptions, etc.
839 * Returns an array of [bottom, top] pairs, one for each y-axis.
841 Dygraph
.prototype.yAxisRanges
= function() {
843 for (var i
= 0; i
< this.axes_
.length
; i
++) {
844 ret
.push(this.yAxisRange(i
));
849 // TODO(danvk): use these functions throughout dygraphs.
851 * Convert from data coordinates to canvas/div X/Y coordinates.
852 * If specified, do this conversion for the coordinate system of a particular
853 * axis. Uses the first axis by default.
854 * Returns a two-element array: [X, Y]
856 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
857 * instead of toDomCoords(null, y, axis).
859 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
860 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
864 * Convert from data x coordinates to canvas/div X coordinate.
865 * If specified, do this conversion for the coordinate system of a particular
867 * Returns a single value or null if x is null.
869 Dygraph
.prototype.toDomXCoord
= function(x
) {
874 var area
= this.plotter_
.area
;
875 var xRange
= this.xAxisRange();
876 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
880 * Convert from data x coordinates to canvas/div Y coordinate and optional
881 * axis. Uses the first axis by default.
883 * returns a single value or null if y is null.
885 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
886 var pct
= this.toPercentYCoord(y
, axis
);
891 var area
= this.plotter_
.area
;
892 return area
.y
+ pct
* area
.h
;
896 * Convert from canvas/div coords to data coordinates.
897 * If specified, do this conversion for the coordinate system of a particular
898 * axis. Uses the first axis by default.
899 * Returns a two-element array: [X, Y].
901 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
902 * instead of toDataCoords(null, y, axis).
904 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
905 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
909 * Convert from canvas/div x coordinate to data coordinate.
911 * If x is null, this returns null.
913 Dygraph
.prototype.toDataXCoord
= function(x
) {
918 var area
= this.plotter_
.area
;
919 var xRange
= this.xAxisRange();
921 if (!this.attributes_
.getForAxis("logscale", 'x')) {
922 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
924 // TODO: remove duplicate code?
925 // Computing the inverse of toDomCoord.
926 var pct
= (x
- area
.x
) / area
.w
;
928 // Computing the inverse of toPercentXCoord. The function was arrived at with
929 // the following steps:
931 // Original calcuation:
932 // pct = (log(x) - log(xRange[0])) / (log(xRange
[1]) - log(xRange
[0])));
934 // Multiply both sides by the right-side demoninator.
935 // pct * (log(xRange[1] - log(xRange[0]))) = log(x) - log(xRange[0])
937 // add log(xRange[0]) to both sides
938 // log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])) = log(x);
940 // Swap both sides of the equation,
941 // log(x) = log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0]))
943 // Use both sides as the exponent in 10^exp and we're done.
944 // x = 10 ^ (log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])))
945 var logr0
= Dygraph
.log10(xRange
[0]);
946 var logr1
= Dygraph
.log10(xRange
[1]);
947 var exponent
= logr0
+ (pct
* (logr1
- logr0
));
948 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
954 * Convert from canvas/div y coord to value.
956 * If y is null, this returns null.
957 * if axis is null, this uses the first axis.
959 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
964 var area
= this.plotter_
.area
;
965 var yRange
= this.yAxisRange(axis
);
967 if (typeof(axis
) == "undefined") axis
= 0;
968 if (!this.attributes_
.getForAxis("logscale", axis
)) {
969 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
971 // Computing the inverse of toDomCoord.
972 var pct
= (y
- area
.y
) / area
.h
;
974 // Computing the inverse of toPercentYCoord. The function was arrived at with
975 // the following steps:
977 // Original calcuation:
978 // pct = (log(yRange[1]) - log(y)) / (log(yRange
[1]) - log(yRange
[0]));
980 // Multiply both sides by the right-side demoninator.
981 // pct * (log(yRange[1]) - log(yRange[0])) = log(yRange[1]) - log(y);
983 // subtract log(yRange[1]) from both sides.
984 // (pct * (log(yRange[1]) - log(yRange[0]))) - log(yRange[1]) = -log(y);
986 // and multiply both sides by -1.
987 // log(yRange[1]) - (pct * (logr1 - log(yRange[0])) = log(y);
989 // Swap both sides of the equation,
990 // log(y) = log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0])));
992 // Use both sides as the exponent in 10^exp and we're done.
993 // y = 10 ^ (log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0]))));
994 var logr0
= Dygraph
.log10(yRange
[0]);
995 var logr1
= Dygraph
.log10(yRange
[1]);
996 var exponent
= logr1
- (pct
* (logr1
- logr0
));
997 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
1003 * Converts a y for an axis to a percentage from the top to the
1004 * bottom of the drawing area.
1006 * If the coordinate represents a value visible on the canvas, then
1007 * the value will be between 0 and 1, where 0 is the top of the canvas.
1008 * However, this method will return values outside the range, as
1009 * values can fall outside the canvas.
1011 * If y is null, this returns null.
1012 * if axis is null, this uses the first axis.
1014 * @param {number} y The data y-coordinate.
1015 * @param {number} [axis] The axis number on which the data coordinate lives.
1016 * @return {number} A fraction in [0, 1] where 0 = the top edge.
1018 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
1022 if (typeof(axis
) == "undefined") axis
= 0;
1024 var yRange
= this.yAxisRange(axis
);
1027 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
1029 var logr0
= Dygraph
.log10(yRange
[0]);
1030 var logr1
= Dygraph
.log10(yRange
[1]);
1031 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- logr0
);
1033 // yRange[1] - y is unit distance from the bottom.
1034 // yRange[1] - yRange[0] is the scale of the range.
1035 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
1036 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
1042 * Converts an x value to a percentage from the left to the right of
1045 * If the coordinate represents a value visible on the canvas, then
1046 * the value will be between 0 and 1, where 0 is the left of the canvas.
1047 * However, this method will return values outside the range, as
1048 * values can fall outside the canvas.
1050 * If x is null, this returns null.
1051 * @param {number} x The data x-coordinate.
1052 * @return {number} A fraction in [0, 1] where 0 = the left edge.
1054 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1059 var xRange
= this.xAxisRange();
1061 var logscale
= this.attributes_
.getForAxis("logscale", 'x') ;
1062 if (logscale
=== true) { // logscale can be null so we test for true explicitly.
1063 var logr0
= Dygraph
.log10(xRange
[0]);
1064 var logr1
= Dygraph
.log10(xRange
[1]);
1065 pct
= (Dygraph
.log10(x
) - logr0
) / (logr1
- logr0
);
1067 // x - xRange[0] is unit distance from the left.
1068 // xRange[1] - xRange[0] is the scale of the range.
1069 // The full expression below is the % from the left.
1070 pct
= (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1076 * Returns the number of columns (including the independent variable).
1077 * @return {number} The number of columns.
1079 Dygraph
.prototype.numColumns
= function() {
1080 if (!this.rawData_
) return 0;
1081 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1085 * Returns the number of rows (excluding any header/label row).
1086 * @return {number} The number of rows, less any header.
1088 Dygraph
.prototype.numRows
= function() {
1089 if (!this.rawData_
) return 0;
1090 return this.rawData_
.length
;
1094 * Returns the value in the given row and column. If the row and column exceed
1095 * the bounds on the data, returns null. Also returns null if the value is
1097 * @param {number} row The row number of the data (0-based). Row 0 is the
1098 * first row of data, not a header row.
1099 * @param {number} col The column number of the data (0-based)
1100 * @return {number} The value in the specified cell or null if the row/col
1101 * were out of range.
1103 Dygraph
.prototype.getValue
= function(row
, col
) {
1104 if (row
< 0 || row
> this.rawData_
.length
) return null;
1105 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1107 return this.rawData_
[row
][col
];
1111 * Generates interface elements for the Dygraph: a containing div, a div to
1112 * display the current point, and a textbox to adjust the rolling average
1113 * period. Also creates the Renderer/Layout elements.
1116 Dygraph
.prototype.createInterface_
= function() {
1117 // Create the all-enclosing graph div
1118 var enclosing
= this.maindiv_
;
1120 this.graphDiv
= document
.createElement("div");
1122 // TODO(danvk): any other styles that are useful to set here?
1123 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1124 this.graphDiv
.style
.position
= 'relative';
1125 enclosing
.appendChild(this.graphDiv
);
1127 // Create the canvas for interactive parts of the chart.
1128 this.canvas_
= Dygraph
.createCanvas();
1129 this.canvas_
.style
.position
= "absolute";
1131 // ... and for static parts of the chart.
1132 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1134 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1135 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1137 this.resizeElements_();
1139 // The interactive parts of the graph are drawn on top of the chart.
1140 this.graphDiv
.appendChild(this.hidden_
);
1141 this.graphDiv
.appendChild(this.canvas_
);
1142 this.mouseEventElement_
= this.createMouseEventElement_();
1144 // Create the grapher
1145 this.layout_
= new DygraphLayout(this);
1149 this.mouseMoveHandler_
= function(e
) {
1150 dygraph
.mouseMove_(e
);
1153 this.mouseOutHandler_
= function(e
) {
1154 // The mouse has left the chart if:
1155 // 1. e.target is inside the chart
1156 // 2. e.relatedTarget is outside the chart
1157 var target
= e
.target
|| e
.fromElement
;
1158 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1159 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1160 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1161 dygraph
.mouseOut_(e
);
1165 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1166 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1168 // Don't recreate and register the resize handler on subsequent calls.
1169 // This happens when the graph is resized.
1170 if (!this.resizeHandler_
) {
1171 this.resizeHandler_
= function(e
) {
1175 // Update when the window is resized.
1176 // TODO(danvk): drop frames depending on complexity of the chart.
1177 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1181 Dygraph
.prototype.resizeElements_
= function() {
1182 this.graphDiv
.style
.width
= this.width_
+ "px";
1183 this.graphDiv
.style
.height
= this.height_
+ "px";
1185 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1186 this.canvas_
.width
= this.width_
* canvasScale
;
1187 this.canvas_
.height
= this.height_
* canvasScale
;
1188 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1189 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1190 if (canvasScale
!== 1) {
1191 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1194 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1195 this.hidden_
.width
= this.width_
* hiddenScale
;
1196 this.hidden_
.height
= this.height_
* hiddenScale
;
1197 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1198 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1199 if (hiddenScale
!== 1) {
1200 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1205 * Detach DOM elements in the dygraph and null out all data references.
1206 * Calling this when you're done with a dygraph can dramatically reduce memory
1207 * usage. See, e.g., the tests/perf.html example.
1209 Dygraph
.prototype.destroy
= function() {
1210 this.canvas_ctx_
.restore();
1211 this.hidden_ctx_
.restore();
1213 // Destroy any plugins, in the reverse order that they were registered.
1214 for (var i
= this.plugins_
.length
- 1; i
>= 0; i
--) {
1215 var p
= this.plugins_
.pop();
1216 if (p
.plugin
.destroy
) p
.plugin
.destroy();
1219 var removeRecursive
= function(node
) {
1220 while (node
.hasChildNodes()) {
1221 removeRecursive(node
.firstChild
);
1222 node
.removeChild(node
.firstChild
);
1226 this.removeTrackedEvents_();
1228 // remove mouse event handlers (This may not be necessary anymore)
1229 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1230 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1232 // remove window handlers
1233 Dygraph
.removeEvent(window
,'resize', this.resizeHandler_
);
1234 this.resizeHandler_
= null;
1236 removeRecursive(this.maindiv_
);
1238 var nullOut
= function(obj
) {
1239 for (var n
in obj
) {
1240 if (typeof(obj
[n
]) === 'object') {
1245 // These may not all be necessary, but it can't hurt...
1246 nullOut(this.layout_
);
1247 nullOut(this.plotter_
);
1252 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1253 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1254 * or the zoom rectangles) is done on this.canvas_.
1255 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1256 * @return {Object} The newly-created canvas
1259 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1260 var h
= Dygraph
.createCanvas();
1261 h
.style
.position
= "absolute";
1262 // TODO(danvk): h should be offset from canvas. canvas needs to include
1263 // some extra area to make it easier to zoom in on the far left and far
1264 // right. h needs to be precisely the plot area, so that clipping occurs.
1265 h
.style
.top
= canvas
.style
.top
;
1266 h
.style
.left
= canvas
.style
.left
;
1267 h
.width
= this.width_
;
1268 h
.height
= this.height_
;
1269 h
.style
.width
= this.width_
+ "px"; // for IE
1270 h
.style
.height
= this.height_
+ "px"; // for IE
1275 * Creates an overlay element used to handle mouse events.
1276 * @return {Object} The mouse event element.
1279 Dygraph
.prototype.createMouseEventElement_
= function() {
1280 return this.canvas_
;
1284 * Generate a set of distinct colors for the data series. This is done with a
1285 * color wheel. Saturation/Value are customizable, and the hue is
1286 * equally-spaced around the color wheel. If a custom set of colors is
1287 * specified, that is used instead.
1290 Dygraph
.prototype.setColors_
= function() {
1291 var labels
= this.getLabels();
1292 var num
= labels
.length
- 1;
1294 this.colorsMap_
= {};
1296 // These are used for when no custom colors are specified.
1297 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1298 var val
= this.getNumericOption('colorValue') || 0.5;
1299 var half
= Math
.ceil(num
/ 2);
1301 var colors
= this.getOption('colors');
1302 var visibility
= this.visibility();
1303 for (var i
= 0; i
< num
; i
++) {
1304 if (!visibility
[i
]) {
1307 var label
= labels
[i
+ 1];
1308 var colorStr
= this.attributes_
.getForSeries('color', label
);
1311 colorStr
= colors
[i
% colors
.length
];
1313 // alternate colors for high contrast.
1314 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1315 var hue
= (1.0 * idx
/ (1 + num
));
1316 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1319 this.colors_
.push(colorStr
);
1320 this.colorsMap_
[label
] = colorStr
;
1325 * Return the list of colors. This is either the list of colors passed in the
1326 * attributes or the autogenerated list of rgb(r,g,b) strings.
1327 * This does not return colors for invisible series.
1328 * @return {Array.<string>} The list of colors.
1330 Dygraph
.prototype.getColors
= function() {
1331 return this.colors_
;
1335 * Returns a few attributes of a series, i.e. its color, its visibility, which
1336 * axis it's assigned to, and its column in the original data.
1337 * Returns null if the series does not exist.
1338 * Otherwise, returns an object with column, visibility, color and axis properties.
1339 * The "axis" property will be set to 1 for y1 and 2 for y2.
1340 * The "column" property can be fed back into getValue(row, column) to get
1341 * values for this series.
1343 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1345 var labels
= this.getLabels();
1346 for (var i
= 1; i
< labels
.length
; i
++) {
1347 if (labels
[i
] == series_name
) {
1352 if (idx
== -1) return null;
1357 visible
: this.visibility()[idx
- 1],
1358 color
: this.colorsMap_
[series_name
],
1359 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1364 * Create the text box to adjust the averaging period
1367 Dygraph
.prototype.createRollInterface_
= function() {
1368 // Create a roller if one doesn't exist already.
1369 if (!this.roller_
) {
1370 this.roller_
= document
.createElement("input");
1371 this.roller_
.type
= "text";
1372 this.roller_
.style
.display
= "none";
1373 this.graphDiv
.appendChild(this.roller_
);
1376 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1378 var area
= this.plotter_
.area
;
1379 var textAttr
= { "position": "absolute",
1381 "top": (area
.y
+ area
.h
- 25) + "px",
1382 "left": (area
.x
+ 1) + "px",
1385 this.roller_
.size
= "2";
1386 this.roller_
.value
= this.rollPeriod_
;
1387 for (var name
in textAttr
) {
1388 if (textAttr
.hasOwnProperty(name
)) {
1389 this.roller_
.style
[name
] = textAttr
[name
];
1394 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1398 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1402 Dygraph
.prototype.createDragInterface_
= function() {
1404 // Tracks whether the mouse is down right now
1406 isPanning
: false, // is this drag part of a pan?
1407 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1408 dragStartX
: null, // pixel coordinates
1409 dragStartY
: null, // pixel coordinates
1410 dragEndX
: null, // pixel coordinates
1411 dragEndY
: null, // pixel coordinates
1412 dragDirection
: null,
1413 prevEndX
: null, // pixel coordinates
1414 prevEndY
: null, // pixel coordinates
1415 prevDragDirection
: null,
1416 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1418 // The value on the left side of the graph when a pan operation starts.
1419 initialLeftmostDate
: null,
1421 // The number of units each pixel spans. (This won't be valid for log
1423 xUnitsPerPixel
: null,
1425 // TODO(danvk): update this comment
1426 // The range in second/value units that the viewport encompasses during a
1427 // panning operation.
1430 // Top-left corner of the canvas, in DOM coords
1431 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1435 // Values for use with panEdgeFraction, which limit how far outside the
1436 // graph's data boundaries it can be panned.
1437 boundedDates
: null, // [minDate, maxDate]
1438 boundedValues
: null, // [[minValue, maxValue] ...]
1440 // We cover iframes during mouse interactions. See comments in
1441 // dygraph-utils.js for more info on why this is a good idea.
1442 tarp
: new Dygraph
.IFrameTarp(),
1444 // contextB is the same thing as this context object but renamed.
1445 initializeMouseDown
: function(event
, g
, contextB
) {
1446 // prevents mouse drags from selecting page text.
1447 if (event
.preventDefault
) {
1448 event
.preventDefault(); // Firefox, Chrome, etc.
1450 event
.returnValue
= false; // IE
1451 event
.cancelBubble
= true;
1454 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1455 contextB
.px
= canvasPos
.x
;
1456 contextB
.py
= canvasPos
.y
;
1457 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1458 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1459 contextB
.cancelNextDblclick
= false;
1460 contextB
.tarp
.cover();
1462 destroy
: function() {
1464 if (context
.isZooming
|| context
.isPanning
) {
1465 context
.isZooming
= false;
1466 context
.dragStartX
= null;
1467 context
.dragStartY
= null;
1470 if (context
.isPanning
) {
1471 context
.isPanning
= false;
1472 context
.draggingDate
= null;
1473 context
.dateRange
= null;
1474 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1475 delete self
.axes_
[i
].draggingValue
;
1476 delete self
.axes_
[i
].dragValueRange
;
1480 context
.tarp
.uncover();
1484 var interactionModel
= this.getOption("interactionModel");
1486 // Self is the graph.
1489 // Function that binds the graph and context to the handler.
1490 var bindHandler
= function(handler
) {
1491 return function(event
) {
1492 handler(event
, self
, context
);
1496 for (var eventName
in interactionModel
) {
1497 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1498 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1499 bindHandler(interactionModel
[eventName
]));
1502 // If the user releases the mouse button during a drag, but not over the
1503 // canvas, then it doesn't count as a zooming action.
1504 if (!interactionModel
.willDestroyContextMyself
) {
1505 var mouseUpHandler
= function(event
) {
1509 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1514 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1515 * up any previous zoom rectangles that were drawn. This could be optimized to
1516 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1519 * @param {number} direction the direction of the zoom rectangle. Acceptable
1520 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1521 * @param {number} startX The X position where the drag started, in canvas
1523 * @param {number} endX The current X position of the drag, in canvas coords.
1524 * @param {number} startY The Y position where the drag started, in canvas
1526 * @param {number} endY The current Y position of the drag, in canvas coords.
1527 * @param {number} prevDirection the value of direction on the previous call to
1528 * this function. Used to avoid excess redrawing
1529 * @param {number} prevEndX The value of endX on the previous call to this
1530 * function. Used to avoid excess redrawing
1531 * @param {number} prevEndY The value of endY on the previous call to this
1532 * function. Used to avoid excess redrawing
1535 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1536 endY
, prevDirection
, prevEndX
,
1538 var ctx
= this.canvas_ctx_
;
1540 // Clean up from the previous rect if necessary
1541 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1542 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1543 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1544 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1545 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1546 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1549 // Draw a light-grey rectangle to show the new viewing area
1550 if (direction
== Dygraph
.HORIZONTAL
) {
1551 if (endX
&& startX
) {
1552 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1553 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1554 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1556 } else if (direction
== Dygraph
.VERTICAL
) {
1557 if (endY
&& startY
) {
1558 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1559 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1560 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1566 * Clear the zoom rectangle (and perform no zoom).
1569 Dygraph
.prototype.clearZoomRect_
= function() {
1570 this.currentZoomRectArgs_
= null;
1571 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
1575 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1576 * the canvas. The exact zoom window may be slightly larger if there are no data
1577 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1578 * which accepts dates that match the raw data. This function redraws the graph.
1580 * @param {number} lowX The leftmost pixel value that should be visible.
1581 * @param {number} highX The rightmost pixel value that should be visible.
1584 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1585 this.currentZoomRectArgs_
= null;
1586 // Find the earliest and latest dates contained in this canvasx range.
1587 // Convert the call to date ranges of the raw data.
1588 var minDate
= this.toDataXCoord(lowX
);
1589 var maxDate
= this.toDataXCoord(highX
);
1590 this.doZoomXDates_(minDate
, maxDate
);
1594 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1595 * method with doZoomX which accepts pixel coordinates. This function redraws
1598 * @param {number} minDate The minimum date that should be visible.
1599 * @param {number} maxDate The maximum date that should be visible.
1602 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1603 // TODO(danvk): when xAxisRange is null (i.e. "fit to data", the animation
1604 // can produce strange effects. Rather than the x-axis transitioning slowly
1605 // between values, it can jerk around.)
1606 var old_window
= this.xAxisRange();
1607 var new_window
= [minDate
, maxDate
];
1608 this.zoomed_x_
= true;
1610 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1611 if (that
.getFunctionOption("zoomCallback")) {
1612 that
.getFunctionOption("zoomCallback").call(that
,
1613 minDate
, maxDate
, that
.yAxisRanges());
1619 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1620 * the canvas. This function redraws the graph.
1622 * @param {number} lowY The topmost pixel value that should be visible.
1623 * @param {number} highY The lowest pixel value that should be visible.
1626 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1627 this.currentZoomRectArgs_
= null;
1628 // Find the highest and lowest values in pixel range for each axis.
1629 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1630 // This is because pixels increase as you go down on the screen, whereas data
1631 // coordinates increase as you go up the screen.
1632 var oldValueRanges
= this.yAxisRanges();
1633 var newValueRanges
= [];
1634 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1635 var hi
= this.toDataYCoord(lowY
, i
);
1636 var low
= this.toDataYCoord(highY
, i
);
1637 newValueRanges
.push([low
, hi
]);
1640 this.zoomed_y_
= true;
1642 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1643 if (that
.getFunctionOption("zoomCallback")) {
1644 var xRange
= that
.xAxisRange();
1645 that
.getFunctionOption("zoomCallback").call(that
,
1646 xRange
[0], xRange
[1], that
.yAxisRanges());
1652 * Transition function to use in animations. Returns values between 0.0
1653 * (totally old values) and 1.0 (totally new values) for each frame.
1656 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1658 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1662 * Reset the zoom to the original view coordinates. This is the same as
1663 * double-clicking on the graph.
1665 Dygraph
.prototype.resetZoom
= function() {
1666 var dirty
= false, dirtyX
= false, dirtyY
= false;
1667 if (this.dateWindow_
!== null) {
1672 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1673 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1679 // Clear any selection, since it's likely to be drawn in the wrong place.
1680 this.clearSelection();
1683 this.zoomed_x_
= false;
1684 this.zoomed_y_
= false;
1686 var minDate
= this.rawData_
[0][0];
1687 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1689 // With only one frame, don't bother calculating extreme ranges.
1690 // TODO(danvk): merge this block w/ the code below
.
1691 if (!this.getBooleanOption("animatedZooms")) {
1692 this.dateWindow_
= null;
1693 for (i
= 0; i
< this.axes_
.length
; i
++) {
1694 if (this.axes_
[i
].valueWindow
!== null) {
1695 delete this.axes_
[i
].valueWindow
;
1699 if (this.getFunctionOption("zoomCallback")) {
1700 this.getFunctionOption("zoomCallback").call(this,
1701 minDate
, maxDate
, this.yAxisRanges());
1706 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1708 oldWindow
= this.xAxisRange();
1709 newWindow
= [minDate
, maxDate
];
1713 oldValueRanges
= this.yAxisRanges();
1714 // TODO(danvk): this is pretty inefficient
1715 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1716 var extremes
= packed
.extremes
;
1718 // this has the side-effect of modifying this.axes_.
1719 // this doesn't make much sense in this context, but it's convenient (we
1720 // need this.axes_[*].extremeValues) and not harmful since we'll be
1721 // calling drawGraph_ shortly, which clobbers these values.
1722 this.computeYAxisRanges_(extremes
);
1724 newValueRanges
= [];
1725 for (i
= 0; i
< this.axes_
.length
; i
++) {
1726 var axis
= this.axes_
[i
];
1727 newValueRanges
.push((axis
.valueRange
!== null &&
1728 axis
.valueRange
!== undefined
) ?
1729 axis
.valueRange
: axis
.extremeRange
);
1734 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1736 that
.dateWindow_
= null;
1737 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1738 if (that
.axes_
[i
].valueWindow
!== null) {
1739 delete that
.axes_
[i
].valueWindow
;
1742 if (that
.getFunctionOption("zoomCallback")) {
1743 that
.getFunctionOption("zoomCallback").call(that
,
1744 minDate
, maxDate
, that
.yAxisRanges());
1751 * Combined animation logic for all zoom functions.
1752 * either the x parameters or y parameters may be null.
1755 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1756 var steps
= this.getBooleanOption("animatedZooms") ?
1757 Dygraph
.ANIMATION_STEPS
: 1;
1760 var valueRanges
= [];
1763 if (oldXRange
!== null && newXRange
!== null) {
1764 for (step
= 1; step
<= steps
; step
++) {
1765 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1766 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1767 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1771 if (oldYRanges
!== null && newYRanges
!== null) {
1772 for (step
= 1; step
<= steps
; step
++) {
1773 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1775 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1776 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1777 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1779 valueRanges
[step
-1] = thisRange
;
1784 Dygraph
.repeatAndCleanup(function(step
) {
1785 if (valueRanges
.length
) {
1786 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1787 var w
= valueRanges
[step
][i
];
1788 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1791 if (windows
.length
) {
1792 that
.dateWindow_
= windows
[step
];
1795 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1799 * Get the current graph's area object.
1801 * Returns: {x, y, w, h}
1803 Dygraph
.prototype.getArea
= function() {
1804 return this.plotter_
.area
;
1808 * Convert a mouse event to DOM coordinates relative to the graph origin.
1810 * Returns a two-element array: [X, Y].
1812 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1813 if (event
.offsetX
&& event
.offsetY
) {
1814 return [ event
.offsetX
, event
.offsetY
];
1816 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1817 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1818 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1819 return [canvasx
, canvasy
];
1824 * Given a canvas X coordinate, find the closest row.
1825 * @param {number} domX graph-relative DOM X coordinate
1826 * Returns {number} row number.
1829 Dygraph
.prototype.findClosestRow
= function(domX
) {
1830 var minDistX
= Infinity
;
1831 var closestRow
= -1;
1832 var sets
= this.layout_
.points
;
1833 for (var i
= 0; i
< sets
.length
; i
++) {
1834 var points
= sets
[i
];
1835 var len
= points
.length
;
1836 for (var j
= 0; j
< len
; j
++) {
1837 var point
= points
[j
];
1838 if (!Dygraph
.isValidPoint(point
, true)) continue;
1839 var dist
= Math
.abs(point
.canvasx
- domX
);
1840 if (dist
< minDistX
) {
1842 closestRow
= point
.idx
;
1851 * Given canvas X,Y coordinates, find the closest point.
1853 * This finds the individual data point across all visible series
1854 * that's closest to the supplied DOM coordinates using the standard
1855 * Euclidean X,Y distance.
1857 * @param {number} domX graph-relative DOM X coordinate
1858 * @param {number} domY graph-relative DOM Y coordinate
1859 * Returns: {row, seriesName, point}
1862 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1863 var minDist
= Infinity
;
1864 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1865 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1866 var points
= this.layout_
.points
[setIdx
];
1867 for (var i
= 0; i
< points
.length
; ++i
) {
1869 if (!Dygraph
.isValidPoint(point
)) continue;
1870 dx
= point
.canvasx
- domX
;
1871 dy
= point
.canvasy
- domY
;
1872 dist
= dx
* dx
+ dy
* dy
;
1873 if (dist
< minDist
) {
1875 closestPoint
= point
;
1876 closestSeries
= setIdx
;
1877 closestRow
= point
.idx
;
1881 var name
= this.layout_
.setNames
[closestSeries
];
1890 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1892 * This first finds the X data point closest to the supplied DOM X coordinate,
1893 * then finds the series which puts the Y coordinate on top of its filled area,
1894 * using linear interpolation between adjacent point pairs.
1896 * @param {number} domX graph-relative DOM X coordinate
1897 * @param {number} domY graph-relative DOM Y coordinate
1898 * Returns: {row, seriesName, point}
1901 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1902 var row
= this.findClosestRow(domX
);
1903 var closestPoint
, closestSeries
;
1904 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1905 var boundary
= this.getLeftBoundary_(setIdx
);
1906 var rowIdx
= row
- boundary
;
1907 var points
= this.layout_
.points
[setIdx
];
1908 if (rowIdx
>= points
.length
) continue;
1909 var p1
= points
[rowIdx
];
1910 if (!Dygraph
.isValidPoint(p1
)) continue;
1911 var py
= p1
.canvasy
;
1912 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1913 // interpolate series Y value using next point
1914 var p2
= points
[rowIdx
+ 1];
1915 if (Dygraph
.isValidPoint(p2
)) {
1916 var dx
= p2
.canvasx
- p1
.canvasx
;
1918 var r
= (domX
- p1
.canvasx
) / dx
;
1919 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1922 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1923 // interpolate series Y value using previous point
1924 var p0
= points
[rowIdx
- 1];
1925 if (Dygraph
.isValidPoint(p0
)) {
1926 var dx
= p1
.canvasx
- p0
.canvasx
;
1928 var r
= (p1
.canvasx
- domX
) / dx
;
1929 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1933 // Stop if the point (domX, py) is above this series' upper edge
1934 if (setIdx
=== 0 || py
< domY
) {
1936 closestSeries
= setIdx
;
1939 var name
= this.layout_
.setNames
[closestSeries
];
1948 * When the mouse moves in the canvas, display information about a nearby data
1949 * point and draw dots over those points in the data series. This function
1950 * takes care of cleanup of previously-drawn dots.
1951 * @param {Object} event The mousemove event from the browser.
1954 Dygraph
.prototype.mouseMove_
= function(event
) {
1955 // This prevents JS errors when mousing over the canvas before data loads.
1956 var points
= this.layout_
.points
;
1957 if (points
=== undefined
|| points
=== null) return;
1959 var canvasCoords
= this.eventToDomCoords(event
);
1960 var canvasx
= canvasCoords
[0];
1961 var canvasy
= canvasCoords
[1];
1963 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1964 var selectionChanged
= false;
1965 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1967 if (this.getBooleanOption("stackedGraph")) {
1968 closest
= this.findStackedPoint(canvasx
, canvasy
);
1970 closest
= this.findClosestPoint(canvasx
, canvasy
);
1972 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1974 var idx
= this.findClosestRow(canvasx
);
1975 selectionChanged
= this.setSelection(idx
);
1978 var callback
= this.getFunctionOption("highlightCallback");
1979 if (callback
&& selectionChanged
) {
1980 callback
.call(this, event
,
1984 this.highlightSet_
);
1989 * Fetch left offset from the specified set index or if not passed, the
1990 * first defined boundaryIds record (see bug #236).
1993 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1994 if (this.boundaryIds_
[setIdx
]) {
1995 return this.boundaryIds_
[setIdx
][0];
1997 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1998 if (this.boundaryIds_
[i
] !== undefined
) {
1999 return this.boundaryIds_
[i
][0];
2006 Dygraph
.prototype.animateSelection_
= function(direction
) {
2007 var totalSteps
= 10;
2009 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
2010 if (this.animateId
=== undefined
) this.animateId
= 0;
2011 var start
= this.fadeLevel
;
2012 var steps
= direction
< 0 ? start
: totalSteps
- start
;
2014 if (this.fadeLevel
) {
2015 this.updateSelection_(1.0);
2020 var thisId
= ++this.animateId
;
2022 var cleanupIfClearing
= function() {
2023 // if we haven't reached fadeLevel 0 in the max frame time,
2024 // ensure that the clear happens and just go to 0
2025 if (that
.fadeLevel
!== 0 && direction
< 0) {
2027 that
.clearSelection();
2030 Dygraph
.repeatAndCleanup(
2032 // ignore simultaneous animations
2033 if (that
.animateId
!= thisId
) return;
2035 that
.fadeLevel
+= direction
;
2036 if (that
.fadeLevel
=== 0) {
2037 that
.clearSelection();
2039 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
2042 steps
, millis
, cleanupIfClearing
);
2046 * Draw dots over the selectied points in the data series. This function
2047 * takes care of cleanup of previously-drawn dots.
2050 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
2051 /*var defaultPrevented = */
2052 this.cascadeEvents_('select', {
2053 selectedRow
: this.lastRow_
,
2054 selectedX
: this.lastx_
,
2055 selectedPoints
: this.selPoints_
2057 // TODO(danvk): use defaultPrevented here?
2059 // Clear the previously drawn vertical, if there is one
2061 var ctx
= this.canvas_ctx_
;
2062 if (this.getOption('highlightSeriesOpts')) {
2063 ctx
.clearRect(0, 0, this.width_
, this.height_
);
2064 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
2066 // Activating background fade includes an animation effect for a gradual
2067 // fade. TODO(klausw): make this independently configurable if it causes
2068 // issues? Use a shared preference to control animations?
2069 var animateBackgroundFade
= true;
2070 if (animateBackgroundFade
) {
2071 if (opt_animFraction
=== undefined
) {
2072 // start a new animation
2073 this.animateSelection_(1);
2076 alpha
*= opt_animFraction
;
2078 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2079 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2082 // Redraw only the highlighted series in the interactive canvas (not the
2083 // static plot canvas, which is where series are usually drawn).
2084 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2085 } else if (this.previousVerticalX_
>= 0) {
2086 // Determine the maximum highlight circle size.
2087 var maxCircleSize
= 0;
2088 var labels
= this.attr_('labels');
2089 for (i
= 1; i
< labels
.length
; i
++) {
2090 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2091 if (r
> maxCircleSize
) maxCircleSize
= r
;
2093 var px
= this.previousVerticalX_
;
2094 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2095 2 * maxCircleSize
+ 2, this.height_
);
2098 if (this.selPoints_
.length
> 0) {
2099 // Draw colored circles over the center of each selected point
2100 var canvasx
= this.selPoints_
[0].canvasx
;
2102 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2103 var pt
= this.selPoints_
[i
];
2104 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2106 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2107 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2108 var color
= this.plotter_
.colors
[pt
.name
];
2110 callback
= Dygraph
.Circles
.DEFAULT
;
2112 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2113 ctx
.strokeStyle
= color
;
2114 ctx
.fillStyle
= color
;
2115 callback
.call(this, this, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2116 color
, circleSize
, pt
.idx
);
2120 this.previousVerticalX_
= canvasx
;
2125 * Manually set the selected points and display information about them in the
2126 * legend. The selection can be cleared using clearSelection() and queried
2127 * using getSelection().
2128 * @param {number} row Row number that should be highlighted (i.e. appear with
2129 * hover dots on the chart).
2130 * @param {seriesName} optional series name to highlight that series with the
2131 * the highlightSeriesOpts setting.
2132 * @param { locked } optional If true, keep seriesName selected when mousing
2133 * over the graph, disabling closest-series highlighting. Call clearSelection()
2136 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2137 // Extract the points we've selected
2138 this.selPoints_
= [];
2140 var changed
= false;
2141 if (row
!== false && row
>= 0) {
2142 if (row
!= this.lastRow_
) changed
= true;
2143 this.lastRow_
= row
;
2144 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2145 var points
= this.layout_
.points
[setIdx
];
2146 // Check if the point at the appropriate index is the point we're looking
2147 // for. If it is, just use it, otherwise search the array for a point
2148 // in the proper place.
2149 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2150 if (setRow
< points
.length
&& points
[setRow
].idx
== row
) {
2151 var point
= points
[setRow
];
2152 if (point
.yval
!== null) this.selPoints_
.push(point
);
2154 for (var pointIdx
= 0; pointIdx
< points
.length
; ++pointIdx
) {
2155 var point
= points
[pointIdx
];
2156 if (point
.idx
== row
) {
2157 if (point
.yval
!== null) {
2158 this.selPoints_
.push(point
);
2166 if (this.lastRow_
>= 0) changed
= true;
2170 if (this.selPoints_
.length
) {
2171 this.lastx_
= this.selPoints_
[0].xval
;
2176 if (opt_seriesName
!== undefined
) {
2177 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2178 this.highlightSet_
= opt_seriesName
;
2181 if (opt_locked
!== undefined
) {
2182 this.lockedSet_
= opt_locked
;
2186 this.updateSelection_(undefined
);
2192 * The mouse has left the canvas. Clear out whatever artifacts remain
2193 * @param {Object} event the mouseout event from the browser.
2196 Dygraph
.prototype.mouseOut_
= function(event
) {
2197 if (this.getFunctionOption("unhighlightCallback")) {
2198 this.getFunctionOption("unhighlightCallback").call(this, event
);
2201 if (this.getBooleanOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2202 this.clearSelection();
2207 * Clears the current selection (i.e. points that were highlighted by moving
2208 * the mouse over the chart).
2210 Dygraph
.prototype.clearSelection
= function() {
2211 this.cascadeEvents_('deselect', {});
2213 this.lockedSet_
= false;
2214 // Get rid of the overlay data
2215 if (this.fadeLevel
) {
2216 this.animateSelection_(-1);
2219 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2221 this.selPoints_
= [];
2224 this.highlightSet_
= null;
2228 * Returns the number of the currently selected row. To get data for this row,
2229 * you can use the getValue method.
2230 * @return {number} row number, or -1 if nothing is selected
2232 Dygraph
.prototype.getSelection
= function() {
2233 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2237 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2238 var points
= this.layout_
.points
[setIdx
];
2239 for (var row
= 0; row
< points
.length
; row
++) {
2240 if (points
[row
].x
== this.selPoints_
[0].x
) {
2241 return points
[row
].idx
;
2249 * Returns the name of the currently-highlighted series.
2250 * Only available when the highlightSeriesOpts option is in use.
2252 Dygraph
.prototype.getHighlightSeries
= function() {
2253 return this.highlightSet_
;
2257 * Returns true if the currently-highlighted series was locked
2258 * via setSelection(..., seriesName, true).
2260 Dygraph
.prototype.isSeriesLocked
= function() {
2261 return this.lockedSet_
;
2265 * Fires when there's data available to be graphed.
2266 * @param {string} data Raw CSV data to be plotted
2269 Dygraph
.prototype.loadedEvent_
= function(data
) {
2270 this.rawData_
= this.parseCSV_(data
);
2271 this.cascadeDataDidUpdateEvent_();
2276 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2279 Dygraph
.prototype.addXTicks_
= function() {
2280 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2282 if (this.dateWindow_
) {
2283 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2285 range
= this.xAxisExtremes();
2288 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2289 var xTicks
= xAxisOptionsView('ticker')(
2292 this.plotter_
.area
.w
, // TODO(danvk): should be area.width
2295 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2296 // console.log(msg);
2297 this.layout_
.setXTicks(xTicks
);
2301 * Returns the correct handler class for the currently set options.
2304 Dygraph
.prototype.getHandlerClass_
= function() {
2306 if (this.attr_('dataHandler')) {
2307 handlerClass
= this.attr_('dataHandler');
2308 } else if (this.fractions_
) {
2309 if (this.getBooleanOption('errorBars')) {
2310 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2312 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2314 } else if (this.getBooleanOption('customBars')) {
2315 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2316 } else if (this.getBooleanOption('errorBars')) {
2317 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2319 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2321 return handlerClass
;
2326 * This function is called once when the chart's data is changed or the options
2327 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2328 * idea is that values derived from the chart's data can be computed here,
2329 * rather than every time the chart is drawn. This includes things like the
2330 * number of axes, rolling averages, etc.
2332 Dygraph
.prototype.predraw_
= function() {
2333 var start
= new Date();
2335 // Create the correct dataHandler
2336 this.dataHandler_
= new (this.getHandlerClass_())();
2338 this.layout_
.computePlotArea();
2340 // TODO(danvk): move more computations out of drawGraph_ and into here.
2341 this.computeYAxes_();
2343 if (!this.is_initial_draw_
) {
2344 this.canvas_ctx_
.restore();
2345 this.hidden_ctx_
.restore();
2348 this.canvas_ctx_
.save();
2349 this.hidden_ctx_
.save();
2351 // Create a new plotter.
2352 this.plotter_
= new DygraphCanvasRenderer(this,
2357 // The roller sits in the bottom left corner of the chart. We don't know where
2358 // this will be until the options are available, so it's positioned here.
2359 this.createRollInterface_();
2361 this.cascadeEvents_('predraw');
2363 // Convert the raw data (a 2D array) into the internal format and compute
2364 // rolling averages.
2365 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2366 for (var i
= 1; i
< this.numColumns(); i
++) {
2367 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2368 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2369 if (this.rollPeriod_
> 1) {
2370 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2373 this.rolledSeries_
.push(series
);
2376 // If the data or options have changed, then we'd better redraw.
2379 // This is used to determine whether to do various animations.
2380 var end
= new Date();
2381 this.drawingTimeMs_
= (end
- start
);
2387 * xval_* and yval_* are the original unscaled data values,
2388 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2389 * yval_stacked is the cumulative Y value used for stacking graphs,
2390 * and bottom/top/minus/plus are used for error bar graphs.
2397 * y_bottom: ?number,
2399 * y_stacked: ?number,
2401 * yval_minus: ?number,
2403 * yval_plus: ?number,
2407 Dygraph
.PointType
= undefined
;
2410 * Calculates point stacking for stackedGraph=true.
2412 * For stacking purposes, interpolate or extend neighboring data across
2413 * NaN values based on stackedGraphNaNFill settings. This is for display
2414 * only, the underlying data value as shown in the legend remains NaN.
2416 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2417 * Updates each Point's yval_stacked property.
2418 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2419 * values for the series seen so far. Index is the row number. Updated
2420 * based on the current series's values.
2421 * @param {Array.<number>} seriesExtremes Min and max values, updated
2422 * to reflect the stacked values.
2423 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2427 Dygraph
.stackPoints_
= function(
2428 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2429 var lastXval
= null;
2430 var prevPoint
= null;
2431 var nextPoint
= null;
2432 var nextPointIdx
= -1;
2434 // Find the next stackable point starting from the given index.
2435 var updateNextPoint
= function(idx
) {
2436 // If we've previously found a non-NaN point and haven't gone past it yet,
2438 if (nextPointIdx
>= idx
) return;
2440 // We haven't found a non-NaN point yet or have moved past it,
2441 // look towards the right to find a non-NaN point.
2442 for (var j
= idx
; j
< points
.length
; ++j
) {
2443 // Clear out a previously-found point (if any) since it's no longer
2444 // valid, we shouldn't use it for interpolation anymore.
2446 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2448 nextPoint
= points
[j
];
2454 for (var i
= 0; i
< points
.length
; ++i
) {
2455 var point
= points
[i
];
2456 var xval
= point
.xval
;
2457 if (cumulativeYval
[xval
] === undefined
) {
2458 cumulativeYval
[xval
] = 0;
2461 var actualYval
= point
.yval
;
2462 if (isNaN(actualYval
) || actualYval
=== null) {
2463 if(fillMethod
== 'none') {
2466 // Interpolate/extend
for stacking purposes
if possible
.
2468 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2469 // Use linear interpolation between prevPoint and nextPoint.
2470 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2471 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2472 } else if (prevPoint
&& fillMethod
== 'all') {
2473 actualYval
= prevPoint
.yval
;
2474 } else if (nextPoint
&& fillMethod
== 'all') {
2475 actualYval
= nextPoint
.yval
;
2484 var stackedYval
= cumulativeYval
[xval
];
2485 if (lastXval
!= xval
) {
2486 // If an x-value is repeated, we ignore the duplicates.
2487 stackedYval
+= actualYval
;
2488 cumulativeYval
[xval
] = stackedYval
;
2492 point
.yval_stacked
= stackedYval
;
2494 if (stackedYval
> seriesExtremes
[1]) {
2495 seriesExtremes
[1] = stackedYval
;
2497 if (stackedYval
< seriesExtremes
[0]) {
2498 seriesExtremes
[0] = stackedYval
;
2505 * Loop over all fields and create datasets, calculating extreme y-values for
2506 * each series and extreme x-indices as we go.
2508 * dateWindow is passed in as an explicit parameter so that we can compute
2509 * extreme values "speculatively", i.e. without actually setting state on the
2512 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2513 * rolledSeries[seriesIndex][row] = raw point, where
2514 * seriesIndex is the column number starting with 1, and
2515 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2516 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2518 * points: Array.<Array.<Dygraph.PointType>>,
2519 * seriesExtremes: Array.<Array.<number>>,
2520 * boundaryIds: Array.<number>}}
2523 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2524 var boundaryIds
= [];
2526 var cumulativeYval
= []; // For stacked series.
2527 var extremes
= {}; // series name -> [low, high]
2528 var seriesIdx
, sampleIdx
;
2529 var firstIdx
, lastIdx
;
2532 // Loop over the fields (series). Go from the last to the first,
2533 // because if they're stacked that's how we accumulate the values.
2534 var num_series
= rolledSeries
.length
- 1;
2536 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2537 if (!this.visibility()[seriesIdx
- 1]) continue;
2539 // Prune down to the desired range, if necessary (for zooming)
2540 // Because there can be lines going to points outside of the visible area,
2541 // we actually prune to visible points, plus one on either side.
2543 series
= rolledSeries
[seriesIdx
];
2544 var low
= dateWindow
[0];
2545 var high
= dateWindow
[1];
2547 // TODO(danvk): do binary search instead of linear search.
2548 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2551 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2552 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2553 firstIdx
= sampleIdx
;
2555 if (series
[sampleIdx
][0] <= high
) {
2556 lastIdx
= sampleIdx
;
2560 if (firstIdx
=== null) firstIdx
= 0;
2561 var correctedFirstIdx
= firstIdx
;
2562 var isInvalidValue
= true;
2563 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2564 correctedFirstIdx
--;
2565 // check if the y value is null.
2566 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2569 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2570 var correctedLastIdx
= lastIdx
;
2571 isInvalidValue
= true;
2572 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2574 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2577 if (correctedFirstIdx
!==firstIdx
) {
2578 firstIdx
= correctedFirstIdx
;
2580 if (correctedLastIdx
!== lastIdx
) {
2581 lastIdx
= correctedLastIdx
;
2584 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2586 // .slice's end is exclusive, we want to include lastIdx.
2587 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2589 series
= rolledSeries
[seriesIdx
];
2590 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2593 var seriesName
= this.attr_("labels")[seriesIdx
];
2594 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2595 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2597 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2598 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2600 if (this.getBooleanOption("stackedGraph")) {
2601 axisIdx
= this.attributes_
.axisForSeries(seriesName
);
2602 if (cumulativeYval
[axisIdx
] === undefined
) {
2603 cumulativeYval
[axisIdx
] = [];
2605 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
[axisIdx
], seriesExtremes
,
2606 this.getBooleanOption("stackedGraphNaNFill"));
2609 extremes
[seriesName
] = seriesExtremes
;
2610 points
[seriesIdx
] = seriesPoints
;
2613 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2617 * Update the graph with new data. This method is called when the viewing area
2618 * has changed. If the underlying data or options have changed, predraw_ will
2619 * be called before drawGraph_ is called.
2623 Dygraph
.prototype.drawGraph_
= function() {
2624 var start
= new Date();
2626 // This is used to set the second parameter to drawCallback, below.
2627 var is_initial_draw
= this.is_initial_draw_
;
2628 this.is_initial_draw_
= false;
2630 this.layout_
.removeAllDatasets();
2632 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2634 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2635 var points
= packed
.points
;
2636 var extremes
= packed
.extremes
;
2637 this.boundaryIds_
= packed
.boundaryIds
;
2639 this.setIndexByName_
= {};
2640 var labels
= this.attr_("labels");
2641 if (labels
.length
> 0) {
2642 this.setIndexByName_
[labels
[0]] = 0;
2645 for (var i
= 1; i
< points
.length
; i
++) {
2646 this.setIndexByName_
[labels
[i
]] = i
;
2647 if (!this.visibility()[i
- 1]) continue;
2648 this.layout_
.addDataset(labels
[i
], points
[i
]);
2649 this.datasetIndex_
[i
] = dataIdx
++;
2652 this.computeYAxisRanges_(extremes
);
2653 this.layout_
.setYAxes(this.axes_
);
2657 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2658 var tmp_zoomed_x
= this.zoomed_x_
;
2659 // Tell PlotKit to use this new data and render itself
2660 this.zoomed_x_
= tmp_zoomed_x
;
2661 this.layout_
.evaluate();
2662 this.renderGraph_(is_initial_draw
);
2664 if (this.getStringOption("timingName")) {
2665 var end
= new Date();
2666 console
.log(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2671 * This does the work of drawing the chart. It assumes that the layout and axis
2672 * scales have already been set (e.g. by predraw_).
2676 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2677 this.cascadeEvents_('clearChart');
2678 this.plotter_
.clear();
2680 if (this.getFunctionOption('underlayCallback')) {
2681 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2682 // users who expect a deprecated form of this callback.
2683 this.getFunctionOption('underlayCallback').call(this,
2684 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2688 canvas
: this.hidden_
,
2689 drawingContext
: this.hidden_ctx_
2691 this.cascadeEvents_('willDrawChart', e
);
2692 this.plotter_
.render();
2693 this.cascadeEvents_('didDrawChart', e
);
2694 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2696 // TODO(danvk): is this a performance bottleneck when panning?
2697 // The interaction canvas should already be empty in that situation.
2698 this.canvas_
.getContext('2d').clearRect(0, 0, this.width_
, this.height_
);
2700 if (this.getFunctionOption("drawCallback") !== null) {
2701 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2703 if (is_initial_draw
) {
2704 this.readyFired_
= true;
2705 while (this.readyFns_
.length
> 0) {
2706 var fn
= this.readyFns_
.pop();
2714 * Determine properties of the y-axes which are independent of the data
2715 * currently being displayed. This includes things like the number of axes and
2716 * the style of the axes. It does not include the range of each axis and its
2718 * This fills in this.axes_.
2719 * axes_ = [ { options } ]
2720 * indices are into the axes_ array.
2722 Dygraph
.prototype.computeYAxes_
= function() {
2723 // Preserve valueWindow settings if they exist, and if the user hasn't
2724 // specified a new valueRange.
2725 var valueWindows
, axis
, index
, opts
, v
;
2726 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2728 for (index
= 0; index
< this.axes_
.length
; index
++) {
2729 valueWindows
.push(this.axes_
[index
].valueWindow
);
2733 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2734 // data computation as well as options storage.
2735 // Go through once and add all the axes.
2738 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2739 // Add a new axis, making a copy of its per-axis options.
2740 opts
= { g
: this };
2741 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2742 this.axes_
[axis
] = opts
;
2746 // Copy global valueRange option over to the first axis.
2747 // NOTE(konigsberg): Are these two statements necessary?
2748 // I tried removing it. The automated tests pass, and manually
2749 // messing with tests/zoom
.html showed no trouble
.
2750 v
= this.attr_('valueRange');
2751 if (v
) this.axes_
[0].valueRange
= v
;
2753 if (valueWindows
!== undefined
) {
2754 // Restore valueWindow settings.
2756 // When going from two axes back to one, we only restore
2758 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2760 for (index
= 0; index
< idxCount
; index
++) {
2761 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2765 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2767 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2768 v
= opts("valueRange");
2769 if (v
) this.axes_
[axis
].valueRange
= v
;
2770 } else { // To keep old behavior
2771 var axes
= this.user_attrs_
.axes
;
2772 if (axes
&& axes
.y2
) {
2773 v
= axes
.y2
.valueRange
;
2774 if (v
) this.axes_
[axis
].valueRange
= v
;
2781 * Returns the number of y-axes on the chart.
2782 * @return {number} the number of axes.
2784 Dygraph
.prototype.numAxes
= function() {
2785 return this.attributes_
.numAxes();
2790 * Returns axis properties for the given series.
2791 * @param {string} setName The name of the series for which to get axis
2792 * properties, e.g. 'Y1'.
2793 * @return {Object} The axis properties.
2795 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2796 // TODO(danvk): handle errors.
2797 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2802 * Determine the value range and tick marks for each axis.
2803 * @param {Object} extremes A mapping from seriesName -> [low, high]
2804 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2806 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2807 var isNullUndefinedOrNaN
= function(num
) {
2808 return isNaN(parseFloat(num
));
2810 var numAxes
= this.attributes_
.numAxes();
2811 var ypadCompat
, span
, series
, ypad
;
2815 // Compute extreme values, a span and tick marks for each axis.
2816 for (var i
= 0; i
< numAxes
; i
++) {
2817 var axis
= this.axes_
[i
];
2818 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2819 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2820 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2821 series
= this.attributes_
.seriesForAxis(i
);
2823 // Add some padding. This supports two Y padding operation modes:
2825 // - backwards compatible (yRangePad not set):
2826 // 10% padding for automatic Y ranges, but not for user-supplied
2827 // ranges, and move a close-to-zero edge to zero except if
2828 // avoidMinZero is set, since drawing at the edge results in
2829 // invisible lines. Unfortunately lines drawn at the edge of a
2830 // user-supplied range will still be invisible. If logscale is
2831 // set, add a variable amount of padding at the top but
2832 // none at the bottom.
2834 // - new-style (yRangePad set by the user):
2835 // always add the specified Y padding.
2838 ypad
= 0.1; // add 10%
2839 if (this.getNumericOption('yRangePad') !== null) {
2841 // Convert pixel padding to ratio
2842 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2845 if (series
.length
=== 0) {
2846 // If no series are defined or visible then use a reasonable default
2847 axis
.extremeRange
= [0, 1];
2849 // Calculate the extremes of extremes.
2850 var minY
= Infinity
; // extremes[series[0]][0];
2851 var maxY
= -Infinity
; // extremes[series[0]][1];
2852 var extremeMinY
, extremeMaxY
;
2854 for (var j
= 0; j
< series
.length
; j
++) {
2855 // this skips invisible series
2856 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2858 // Only use valid extremes to stop null data series' from corrupting the scale.
2859 extremeMinY
= extremes
[series
[j
]][0];
2860 if (extremeMinY
!== null) {
2861 minY
= Math
.min(extremeMinY
, minY
);
2863 extremeMaxY
= extremes
[series
[j
]][1];
2864 if (extremeMaxY
!== null) {
2865 maxY
= Math
.max(extremeMaxY
, maxY
);
2869 // Include zero if requested by the user.
2870 if (includeZero
&& !logscale
) {
2871 if (minY
> 0) minY
= 0;
2872 if (maxY
< 0) maxY
= 0;
2875 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2876 if (minY
== Infinity
) minY
= 0;
2877 if (maxY
== -Infinity
) maxY
= 1;
2880 // special case: if we have no sense of scale, center on the sole value.
2883 span
= Math
.abs(maxY
);
2885 // ... and if the sole value is zero, use range 0-1.
2891 var maxAxisY
, minAxisY
;
2894 maxAxisY
= maxY
+ ypad
* span
;
2897 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2898 maxAxisY
= maxY
* logpad
;
2899 minAxisY
= minY
/ logpad
;
2902 maxAxisY
= maxY
+ ypad
* span
;
2903 minAxisY
= minY
- ypad
* span
;
2905 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2906 // close to zero, but not if avoidMinZero is set.
2907 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2908 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2909 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2912 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2914 if (axis
.valueWindow
) {
2915 // This is only set if the user has zoomed on the y-axis. It is never set
2916 // by a user. It takes precedence over axis.valueRange because, if you set
2917 // valueRange, you'd still expect to be able to pan.
2918 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2919 } else if (axis
.valueRange
) {
2920 // This is a user-set value range for this axis.
2921 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2922 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2924 if (axis
.logscale
) {
2925 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2934 axis
.computedValueRange
= [y0
, y1
];
2936 axis
.computedValueRange
= axis
.extremeRange
;
2940 if (independentTicks
) {
2941 axis
.independentTicks
= independentTicks
;
2942 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2943 var ticker
= opts('ticker');
2944 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2945 axis
.computedValueRange
[1],
2946 this.plotter_
.area
.h
,
2949 // Define the first independent axis as primary axis.
2950 if (!p_axis
) p_axis
= axis
;
2953 if (p_axis
=== undefined
) {
2954 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2956 // Add ticks. By default, all axes inherit the tick positions of the
2957 // primary axis. However, if an axis is specifically marked as having
2958 // independent ticks, then that is permissible as well.
2959 for (var i
= 0; i
< numAxes
; i
++) {
2960 var axis
= this.axes_
[i
];
2962 if (!axis
.independentTicks
) {
2963 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2964 var ticker
= opts('ticker');
2965 var p_ticks
= p_axis
.ticks
;
2966 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2967 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2968 var tick_values
= [];
2969 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2970 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2971 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2972 tick_values
.push(y_val
);
2975 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2976 axis
.computedValueRange
[1],
2977 this.plotter_
.area
.h
,
2986 * Detects the type of the str (date or numeric) and sets the various
2987 * formatting attributes in this.attrs_ based on this type.
2988 * @param {string} str An x value.
2991 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2993 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2994 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2995 str
.indexOf('/') >= 0 ||
2996 isNaN(parseFloat(str
))) {
2998 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2999 // TODO(danvk): remove support for this format.
3003 this.setXAxisOptions_(isDate
);
3006 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
3008 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3009 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3010 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3011 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3013 /** @private (shut up, jsdoc!) */
3014 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3015 // TODO(danvk): use Dygraph.numberValueFormatter here?
3016 /** @private (shut up, jsdoc!) */
3017 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3018 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3019 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3025 * Parses a string in a special csv format. We expect a csv file where each
3026 * line is a date point, and the first field in each line is the date string.
3027 * We also expect that all remaining fields represent series.
3028 * if the errorBars attribute is set, then interpret the fields as:
3029 * date, series1, stddev1, series2, stddev2, ...
3030 * @param {[Object]} data See above.
3032 * @return [Object] An array with one entry for each row. These entries
3033 * are an array of cells in that row. The first entry is the parsed x-value for
3034 * the row. The second, third, etc. are the y-values. These can take on one of
3035 * three forms, depending on the CSV and constructor parameters:
3037 * 2. [ value, stddev ]
3038 * 3. [ low value, center value, high value ]
3040 Dygraph
.prototype.parseCSV_
= function(data
) {
3042 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3043 var lines
= data
.split(line_delimiter
|| "\n");
3046 // Use the default delimiter or fall back to a tab if that makes sense.
3047 var delim
= this.getStringOption('delimiter');
3048 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3053 if (!('labels' in this.user_attrs_
)) {
3054 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3056 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3057 this.attributes_
.reparseSeries();
3062 var defaultParserSet
= false; // attempt to auto-detect x value type
3063 var expectedCols
= this.attr_("labels").length
;
3064 var outOfOrder
= false;
3065 for (var i
= start
; i
< lines
.length
; i
++) {
3066 var line
= lines
[i
];
3068 if (line
.length
=== 0) continue; // skip blank lines
3069 if (line
[0] == '#') continue; // skip comment lines
3070 var inFields
= line
.split(delim
);
3071 if (inFields
.length
< 2) continue;
3074 if (!defaultParserSet
) {
3075 this.detectTypeFromString_(inFields
[0]);
3076 xParser
= this.getFunctionOption("xValueParser");
3077 defaultParserSet
= true;
3079 fields
[0] = xParser(inFields
[0], this);
3081 // If fractions are expected, parse the numbers as "A/B
"
3082 if (this.fractions_) {
3083 for (j = 1; j < inFields.length; j++) {
3084 // TODO(danvk): figure out an appropriate way to flag parse errors.
3085 vals = inFields[j].split("/");
3086 if (vals.length != 2) {
3087 console.error('Expected fractional "num
/den
" values in CSV data ' +
3088 "but found a value
'" + inFields[j] + "' on line
" +
3089 (1 + i) + " ('" + line + "') which is not of
this form
.");
3092 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3093 Dygraph.parseFloat_(vals[1], i, line)];
3096 } else if (this.getBooleanOption("errorBars
")) {
3097 // If there are error bars, values are (value, stddev) pairs
3098 if (inFields.length % 2 != 1) {
3099 console.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3100 'but line ' + (1 + i) + ' has an odd number of values (' +
3101 (inFields.length - 1) + "): '" + line + "'");
3103 for (j = 1; j < inFields.length; j += 2) {
3104 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3105 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3107 } else if (this.getBooleanOption("customBars
")) {
3108 // Bars are a low;center;high tuple
3109 for (j = 1; j < inFields.length; j++) {
3110 var val = inFields[j];
3111 if (/^ *$/.test(val)) {
3112 fields[j] = [null, null, null];
3114 vals = val.split(";");
3115 if (vals.length == 3) {
3116 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3117 Dygraph.parseFloat_(vals[1], i, line),
3118 Dygraph.parseFloat_(vals[2], i, line) ];
3120 console.warn('When using customBars, values must be either blank ' +
3121 'or "low
;center
;high
" tuples (got "' + val +
3122 '" on line ' + (1+i));
3127 // Values are just numbers
3128 for (j = 1; j < inFields.length; j++) {
3129 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3132 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3136 if (fields.length != expectedCols) {
3137 console.error("Number of columns
in line
" + i + " (" + fields.length +
3138 ") does not agree
with number of
labels (" + expectedCols +
3142 // If the user specified the 'labels' option and none of the cells of the
3143 // first row parsed correctly, then they probably double-specified the
3144 // labels. We go with the values set in the option, discard this row and
3145 // log a warning to the JS console.
3146 if (i === 0 && this.attr_('labels')) {
3147 var all_null = true;
3148 for (j = 0; all_null && j < fields.length; j++) {
3149 if (fields[j]) all_null = false;
3152 console.warn("The dygraphs
'labels' option is set
, but the first row
" +
3153 "of CSV
data ('" + line + "') appears to also contain
" +
3154 "labels
. Will drop the CSV labels and
use the option
" +
3163 console.warn("CSV is out of order
; order it correctly to speed loading
.");
3164 ret.sort(function(a,b) { return a[0] - b[0]; });
3171 * The user has provided their data as a pre-packaged JS array. If the x values
3172 * are numeric, this is the same as dygraphs' internal format. If the x values
3173 * are dates, we need to convert them from Date objects to ms since epoch.
3174 * @param {!Array} data
3175 * @return {Object} data with numeric x values.
3178 Dygraph.prototype.parseArray_ = function(data) {
3179 // Peek at the first x value to see if it's numeric.
3180 if (data.length === 0) {
3181 console.error("Can
't plot empty data set");
3184 if (data[0].length === 0) {
3185 console.error("Data set cannot contain an empty row");
3190 if (this.attr_("labels") === null) {
3191 console.warn("Using default labels. Set labels explicitly via 'labels
' " +
3192 "in the options parameter");
3193 this.attrs_.labels = [ "X" ];
3194 for (i = 1; i < data[0].length; i++) {
3195 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3197 this.attributes_.reparseSeries();
3199 var num_labels = this.attr_("labels");
3200 if (num_labels.length != data[0].length) {
3201 console.error("Mismatch between number of labels (" + num_labels + ")" +
3202 " and number of columns in array (" + data[0].length + ")");
3207 if (Dygraph.isDateLike(data[0][0])) {
3208 // Some intelligent defaults for a date x-axis.
3209 this.attrs_.axes.x.valueFormatter = Dygraph.dateValueFormatter;
3210 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3211 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisLabelFormatter;
3213 // Assume they're all dates
.
3214 var parsedData
= Dygraph
.clone(data
);
3215 for (i
= 0; i
< data
.length
; i
++) {
3216 if (parsedData
[i
].length
=== 0) {
3217 console
.error("Row " + (1 + i
) + " of data is empty");
3220 if (parsedData
[i
][0] === null ||
3221 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3222 isNaN(parsedData
[i
][0].getTime())) {
3223 console
.error("x value in row " + (1 + i
) + " is not a Date");
3226 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3230 // Some intelligent defaults for a numeric x-axis.
3231 /** @private (shut up, jsdoc!) */
3232 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3233 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3234 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3240 * Parses a DataTable object from gviz.
3241 * The data is expected to have a first column that is either a date or a
3242 * number. All subsequent columns must be numbers. If there is a clear mismatch
3243 * between this.xValueParser_ and the type of the first column, it will be
3244 * fixed. Fills out rawData_.
3245 * @param {!google.visualization.DataTable} data See above.
3248 Dygraph
.prototype.parseDataTable_
= function(data
) {
3249 var shortTextForAnnotationNum
= function(num
) {
3250 // converts [0-9]+ [A-Z][a-z]*
3251 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3252 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3253 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3254 num
= Math
.floor(num
/ 26);
3256 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3257 num
= Math
.floor((num
- 1) / 26);
3262 var cols
= data
.getNumberOfColumns();
3263 var rows
= data
.getNumberOfRows();
3265 var indepType
= data
.getColumnType(0);
3266 if (indepType
== 'date' || indepType
== 'datetime') {
3267 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3268 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3269 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3270 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3271 } else if (indepType
== 'number') {
3272 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3273 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3274 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3275 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3277 console
.error("only 'date', 'datetime' and 'number' types are supported " +
3278 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3282 // Array of the column indices which contain data (and not annotations).
3284 var annotationCols
= {}; // data index -> [annotation cols]
3285 var hasAnnotations
= false;
3287 for (i
= 1; i
< cols
; i
++) {
3288 var type
= data
.getColumnType(i
);
3289 if (type
== 'number') {
3291 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3292 // This is OK -- it's an annotation column.
3293 var dataIdx
= colIdx
[colIdx
.length
- 1];
3294 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3295 annotationCols
[dataIdx
] = [i
];
3297 annotationCols
[dataIdx
].push(i
);
3299 hasAnnotations
= true;
3301 console
.error("Only 'number' is supported as a dependent type with Gviz." +
3302 " 'string' is only supported if displayAnnotations is true");
3306 // Read column labels
3307 // TODO(danvk): add support back for errorBars
3308 var labels
= [data
.getColumnLabel(0)];
3309 for (i
= 0; i
< colIdx
.length
; i
++) {
3310 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3311 if (this.getBooleanOption("errorBars")) i
+= 1;
3313 this.attrs_
.labels
= labels
;
3314 cols
= labels
.length
;
3317 var outOfOrder
= false;
3318 var annotations
= [];
3319 for (i
= 0; i
< rows
; i
++) {
3321 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3322 data
.getValue(i
, 0) === null) {
3323 console
.warn("Ignoring row " + i
+
3324 " of DataTable because of undefined or null first column.");
3328 if (indepType
== 'date' || indepType
== 'datetime') {
3329 row
.push(data
.getValue(i
, 0).getTime());
3331 row
.push(data
.getValue(i
, 0));
3333 if (!this.getBooleanOption("errorBars")) {
3334 for (j
= 0; j
< colIdx
.length
; j
++) {
3335 var col
= colIdx
[j
];
3336 row
.push(data
.getValue(i
, col
));
3337 if (hasAnnotations
&&
3338 annotationCols
.hasOwnProperty(col
) &&
3339 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3341 ann
.series
= data
.getColumnLabel(col
);
3343 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3345 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3346 if (k
) ann
.text
+= "\n";
3347 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3349 annotations
.push(ann
);
3353 // Strip out infinities, which give dygraphs problems later on.
3354 for (j
= 0; j
< row
.length
; j
++) {
3355 if (!isFinite(row
[j
])) row
[j
] = null;
3358 for (j
= 0; j
< cols
- 1; j
++) {
3359 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3362 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3369 console
.warn("DataTable is out of order; order it correctly to speed loading.");
3370 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3372 this.rawData_
= ret
;
3374 if (annotations
.length
> 0) {
3375 this.setAnnotations(annotations
, true);
3377 this.attributes_
.reparseSeries();
3381 * Signals to plugins that the chart data has updated.
3382 * This happens after the data has updated but before the chart has redrawn.
3384 Dygraph
.prototype.cascadeDataDidUpdateEvent_
= function() {
3385 // TODO(danvk): there are some issues checking xAxisRange() and using
3386 // toDomCoords from handlers of this event. The visible range should be set
3387 // when the chart is drawn, not derived from the data.
3388 this.cascadeEvents_('dataDidUpdate', {});
3392 * Get the CSV data. If it's in a function, call that function. If it's in a
3393 * file, do an XMLHttpRequest to get it.
3396 Dygraph
.prototype.start_
= function() {
3397 var data
= this.file_
;
3399 // Functions can return references of all other types.
3400 if (typeof data
== 'function') {
3404 if (Dygraph
.isArrayLike(data
)) {
3405 this.rawData_
= this.parseArray_(data
);
3406 this.cascadeDataDidUpdateEvent_();
3408 } else if (typeof data
== 'object' &&
3409 typeof data
.getColumnRange
== 'function') {
3410 // must be a DataTable from gviz.
3411 this.parseDataTable_(data
);
3412 this.cascadeDataDidUpdateEvent_();
3414 } else if (typeof data
== 'string') {
3415 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3416 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3417 if (line_delimiter
) {
3418 this.loadedEvent_(data
);
3422 if (window
.XMLHttpRequest
) {
3423 // Firefox, Opera, IE7, and other browsers will use the native object
3424 req
= new XMLHttpRequest();
3426 // IE 5 and 6 will use the ActiveX control
3427 req
= new ActiveXObject("Microsoft.XMLHTTP");
3431 req
.onreadystatechange
= function () {
3432 if (req
.readyState
== 4) {
3433 if (req
.status
=== 200 || // Normal http
3434 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3435 caller
.loadedEvent_(req
.responseText
);
3440 req
.open("GET", data
, true);
3444 console
.error("Unknown data format: " + (typeof data
));
3449 * Changes various properties of the graph. These can include:
3451 * <li>file: changes the source data for the graph</li>
3452 * <li>errorBars: changes whether the data contains stddev</li>
3455 * There's a huge variety of options that can be passed to this method. For a
3456 * full list, see http://dygraphs.com/options.html.
3458 * @param {Object} input_attrs The new properties and values
3459 * @param {boolean} block_redraw Usually the chart is redrawn after every
3460 * call to updateOptions(). If you know better, you can pass true to
3461 * explicitly block the redraw. This can be useful for chaining
3462 * updateOptions() calls, avoiding the occasional infinite loop and
3463 * preventing redraws when it's not necessary (e.g. when updating a
3466 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3467 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3469 // copyUserAttrs_ drops the "file" parameter as a convenience to us.
3470 var file
= input_attrs
.file
;
3471 var attrs
= Dygraph
.copyUserAttrs_(input_attrs
);
3473 // TODO(danvk): this is a mess. Move these options into attr_.
3474 if ('rollPeriod' in attrs
) {
3475 this.rollPeriod_
= attrs
.rollPeriod
;
3477 if ('dateWindow' in attrs
) {
3478 this.dateWindow_
= attrs
.dateWindow
;
3479 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3480 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3483 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3484 this.zoomed_y_
= (attrs
.valueRange
!== null);
3487 // TODO(danvk): validate per-series options.
3492 // highlightCircleSize
3494 // Check if this set options will require new points.
3495 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3497 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3499 this.attributes_
.reparseSeries();
3502 // This event indicates that the data is about to change, but hasn't yet.
3503 // TODO(danvk): support cancelation of the update via this event.
3504 this.cascadeEvents_('dataWillUpdate', {});
3507 if (!block_redraw
) this.start_();
3509 if (!block_redraw
) {
3510 if (requiresNewPoints
) {
3513 this.renderGraph_(false);
3520 * Make a copy of input attributes, removing file as a convenience.
3522 Dygraph
.copyUserAttrs_
= function(attrs
) {
3524 for (var k
in attrs
) {
3525 if (!attrs
.hasOwnProperty(k
)) continue;
3526 if (k
== 'file') continue;
3527 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3533 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3534 * containing div (which has presumably changed size since the dygraph was
3535 * instantiated. If the width/height are specified, the div will be resized.
3537 * This is far more efficient than destroying and re-instantiating a
3538 * Dygraph, since it doesn't have to reparse the underlying data.
3540 * @param {number} width Width (in pixels)
3541 * @param {number} height Height (in pixels)
3543 Dygraph
.prototype.resize
= function(width
, height
) {
3544 if (this.resize_lock
) {
3547 this.resize_lock
= true;
3549 if ((width
=== null) != (height
=== null)) {
3550 console
.warn("Dygraph.resize() should be called with zero parameters or " +
3551 "two non-NULL parameters. Pretending it was zero.");
3552 width
= height
= null;
3555 var old_width
= this.width_
;
3556 var old_height
= this.height_
;
3559 this.maindiv_
.style
.width
= width
+ "px";
3560 this.maindiv_
.style
.height
= height
+ "px";
3561 this.width_
= width
;
3562 this.height_
= height
;
3564 this.width_
= this.maindiv_
.clientWidth
;
3565 this.height_
= this.maindiv_
.clientHeight
;
3568 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3569 // Resizing a canvas erases it, even when the size doesn't change, so
3570 // any resize needs to be followed by a redraw.
3571 this.resizeElements_();
3575 this.resize_lock
= false;
3579 * Adjusts the number of points in the rolling average. Updates the graph to
3580 * reflect the new averaging period.
3581 * @param {number} length Number of points over which to average the data.
3583 Dygraph
.prototype.adjustRoll
= function(length
) {
3584 this.rollPeriod_
= length
;
3589 * Returns a boolean array of visibility statuses.
3591 Dygraph
.prototype.visibility
= function() {
3592 // Do lazy-initialization, so that this happens after we know the number of
3594 if (!this.getOption("visibility")) {
3595 this.attrs_
.visibility
= [];
3597 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3598 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3599 this.attrs_
.visibility
.push(true);
3601 return this.getOption("visibility");
3605 * Changes the visiblity of a series.
3607 * @param {number} num the series index
3608 * @param {boolean} value true or false, identifying the visibility.
3610 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3611 var x
= this.visibility();
3612 if (num
< 0 || num
>= x
.length
) {
3613 console
.warn("invalid series number in setVisibility: " + num
);
3621 * How large of an area will the dygraph render itself in?
3622 * This is used for testing.
3623 * @return A {width: w, height: h} object.
3626 Dygraph
.prototype.size
= function() {
3627 return { width
: this.width_
, height
: this.height_
};
3631 * Update the list of annotations and redraw the chart.
3632 * See dygraphs.com/annotations.html for more info on how to use annotations.
3633 * @param ann {Array} An array of annotation objects.
3634 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3636 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3637 // Only add the annotation CSS rule once we know it will be used.
3638 Dygraph
.addAnnotationRule();
3639 this.annotations_
= ann
;
3640 if (!this.layout_
) {
3641 console
.warn("Tried to setAnnotations before dygraph was ready. " +
3642 "Try setting them in a ready() block. See " +
3643 "dygraphs.com/tests/annotation.html");
3647 this.layout_
.setAnnotations(this.annotations_
);
3648 if (!suppressDraw
) {
3654 * Return the list of annotations.
3656 Dygraph
.prototype.annotations
= function() {
3657 return this.annotations_
;
3661 * Get the list of label names for this graph. The first column is the
3662 * x-axis, so the data series names start at index 1.
3664 * Returns null when labels have not yet been defined.
3666 Dygraph
.prototype.getLabels
= function() {
3667 var labels
= this.attr_("labels");
3668 return labels
? labels
.slice() : null;
3672 * Get the index of a series (column) given its name. The first column is the
3673 * x-axis, so the data series start with index 1.
3675 Dygraph
.prototype.indexFromSetName
= function(name
) {
3676 return this.setIndexByName_
[name
];
3680 * Trigger a callback when the dygraph has drawn itself and is ready to be
3681 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3682 * data (i.e. a URL is passed as the data source) and the chart is drawn
3683 * asynchronously. If the chart has already drawn, the callback will fire
3686 * This is a good place to call setAnnotation().
3688 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3691 Dygraph
.prototype.ready
= function(callback
) {
3692 if (this.is_initial_draw_
) {
3693 this.readyFns_
.push(callback
);
3695 callback
.call(this, this);
3701 * Adds a default style for the annotation CSS classes to the document. This is
3702 * only executed when annotations are actually used. It is designed to only be
3703 * called once -- all calls after the first will return immediately.
3705 Dygraph
.addAnnotationRule
= function() {
3706 // TODO(danvk): move this function into plugins/annotations.js
?
3707 if (Dygraph
.addedAnnotationCSS
) return;
3709 var rule
= "border: 1px solid black; " +
3710 "background-color: white; " +
3711 "text-align: center;";
3713 var styleSheetElement
= document
.createElement("style");
3714 styleSheetElement
.type
= "text/css";
3715 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3717 // Find the first style sheet that we can access.
3718 // We may not add a rule to a style sheet from another domain for security
3719 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3720 // adds its own style sheets from google.com.
3721 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3722 if (document
.styleSheets
[i
].disabled
) continue;
3723 var mysheet
= document
.styleSheets
[i
];
3725 if (mysheet
.insertRule
) { // Firefox
3726 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3727 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3728 } else if (mysheet
.addRule
) { // IE
3729 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3731 Dygraph
.addedAnnotationCSS
= true;
3734 // Was likely a security exception.
3738 console
.warn("Unable to add default annotation CSS rule; display may be off.");