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 /*jshint globalstrict: true */
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.0.1";
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
120 * @param {string} name The name of the point's data series
121 * @param {Dygraph} g The dygraph object
123 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
124 var sigFigs
= opts('sigFigs');
126 if (sigFigs
!== null) {
127 // User has opted for a fixed number of significant figures.
128 return Dygraph
.floatFormat(x
, sigFigs
);
131 var digits
= opts('digitsAfterDecimal');
132 var maxNumberWidth
= opts('maxNumberWidth');
134 var kmb
= opts('labelsKMB');
135 var kmg2
= opts('labelsKMG2');
139 // switch to scientific notation if we underflow or overflow fixed display.
141 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
142 Math
.abs(x
) < Math
.pow(10, -digits
))) {
143 label
= x
.toExponential(digits
);
145 label
= '' + Dygraph
.round_(x
, digits
);
154 k_labels
= Dygraph
.KMB_LABELS
;
157 if (kmb
) console
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
159 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
160 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
163 var absx
= Math
.abs(x
);
164 var n
= Dygraph
.pow(k
, k_labels
.length
);
165 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
167 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
172 // TODO(danvk): clean up this logic. Why so different than kmb?
173 var x_parts
= String(x
.toExponential()).split('e-');
174 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
175 if (x_parts
[1] % 3 > 0) {
176 label
= Dygraph
.round_(x_parts
[0] /
177 Dygraph
.pow(10, (x_parts
[1] % 3)),
180 label
= Number(x_parts
[0]).toFixed(2);
182 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
191 * variant for use as an axisLabelFormatter.
194 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
195 return Dygraph
.numberValueFormatter(x
, opts
, g
);
199 * @type {!Array.<string>}
203 Dygraph
.SHORT_MONTH_NAMES_
= ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
207 * Convert a JS date to a string appropriate to display on an axis that
208 * is displaying values at the stated granularity. This respects the
210 * @param {Date} date The date to format
211 * @param {number} granularity One of the Dygraph granularity constants
212 * @param {Dygraph} opts An options view
213 * @return {string} The date formatted as local time
216 Dygraph
.dateAxisLabelFormatter
= function(date
, granularity
, opts
) {
217 var utc
= opts('labelsUTC');
218 var accessors
= utc
? Dygraph
.DateAccessorsUTC
: Dygraph
.DateAccessorsLocal
;
220 var year
= accessors
.getFullYear(date
),
221 month
= accessors
.getMonth(date
),
222 day
= accessors
.getDate(date
),
223 hours
= accessors
.getHours(date
),
224 mins
= accessors
.getMinutes(date
),
225 secs
= accessors
.getSeconds(date
),
226 millis
= accessors
.getSeconds(date
);
228 if (granularity
>= Dygraph
.DECADAL
) {
230 } else if (granularity
>= Dygraph
.MONTHLY
) {
231 return Dygraph
.SHORT_MONTH_NAMES_
[month
] + ' ' + year
;
233 var frac
= hours
* 3600 + mins
* 60 + secs
+ 1e-3 * millis
;
234 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
235 // e.g. '21Jan' (%d%b)
236 return Dygraph
.zeropad(day
) + Dygraph
.SHORT_MONTH_NAMES_
[month
];
238 return Dygraph
.hmsString_(hours
, mins
, secs
);
242 // alias in case anyone is referencing the old method.
243 Dygraph
.dateAxisFormatter
= Dygraph
.dateAxisLabelFormatter
;
246 * Return a string version of a JS date for a value label. This respects the
248 * @param {Date} date The date to be formatted
249 * @param {Dygraph} opts An options view
252 Dygraph
.dateValueFormatter
= function(d
, opts
) {
253 return Dygraph
.dateString_(d
, opts('labelsUTC'));
257 * Standard plotters. These may be used by clients.
258 * Available plotters are:
259 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
260 * - Dygraph.Plotters.errorPlotter: draws error bars
261 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
263 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
264 * This causes all the lines to be drawn over all the fills/error bars.
266 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
269 // Default attribute values.
270 Dygraph
.DEFAULT_ATTRS
= {
271 highlightCircleSize
: 3,
272 highlightSeriesOpts
: null,
273 highlightSeriesBackgroundAlpha
: 0.5,
277 // TODO(danvk): move defaults from createStatusMessage_ here.
279 labelsSeparateLines
: false,
280 labelsShowZeroValues
: true,
283 showLabelsOnHighlight
: true,
285 digitsAfterDecimal
: 2,
290 strokeBorderWidth
: 0,
291 strokeBorderColor
: "white",
294 axisLabelFontSize
: 14,
300 xValueParser
: Dygraph
.dateParser
,
307 wilsonInterval
: true, // only relevant if fractions is true
311 connectSeparatedPoints
: false,
314 stackedGraphNaNFill
: 'all',
315 hideOverlayOnMouseOut
: true,
317 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
318 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
324 drawAxesAtZero
: false,
326 // Sizes of the various chart labels.
333 axisLineColor
: "black",
336 axisLabelColor
: "black",
337 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
341 gridLineColor
: "rgb(128,128,128)",
343 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
344 animatedZooms
: false, // (for now)
346 // Range selector options
347 showRangeSelector
: false,
348 rangeSelectorHeight
: 40,
349 rangeSelectorPlotStrokeColor
: "#808FAB",
350 rangeSelectorPlotFillColor
: "#A7B1C4",
351 showInRangeSelector
: null,
353 // The ordering here ensures that central lines always appear above any
354 // fill bars/error bars
.
356 Dygraph
.Plotters
.fillPlotter
,
357 Dygraph
.Plotters
.errorPlotter
,
358 Dygraph
.Plotters
.linePlotter
367 axisLabelFormatter
: Dygraph
.dateAxisLabelFormatter
,
368 valueFormatter
: Dygraph
.dateValueFormatter
,
371 independentTicks
: true,
372 ticker
: null // will be set in dygraph-tickers.js
376 valueFormatter
: Dygraph
.numberValueFormatter
,
377 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
380 independentTicks
: true,
381 ticker
: null // will be set in dygraph-tickers.js
385 valueFormatter
: Dygraph
.numberValueFormatter
,
386 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
389 independentTicks
: false,
390 ticker
: null // will be set in dygraph-tickers.js
395 // Directions for panning and zooming. Use bit operations when combined
396 // values are possible.
397 Dygraph
.HORIZONTAL
= 1;
398 Dygraph
.VERTICAL
= 2;
400 // Installed plugins, in order of precedence (most-general to most-specific).
401 // Plugins are installed after they are defined, in plugins/install.js
.
405 // Used for initializing annotation CSS rules only once.
406 Dygraph
.addedAnnotationCSS
= false;
408 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
409 // Labels is no longer a constructor parameter, since it's typically set
410 // directly from the data source. It also conains a name for the x-axis,
411 // which the previous constructor form did not.
412 if (labels
!== null) {
413 var new_labels
= ["Date"];
414 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
415 Dygraph
.update(attrs
, { 'labels': new_labels
});
417 this.__init__(div
, file
, attrs
);
421 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
422 * and context <canvas> inside of it. See the constructor for details.
424 * @param {Element} div the Element to render the graph into.
425 * @param {string | Function} file Source data
426 * @param {Object} attrs Miscellaneous other options
429 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
430 // Hack for IE: if we're using excanvas and the document hasn't finished
431 // loading yet (and hence may not have initialized whatever it needs to
432 // initialize), then keep calling this routine periodically until it has.
433 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
434 typeof(G_vmlCanvasManager
) != 'undefined' &&
435 document
.readyState
!= 'complete') {
437 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
441 // Support two-argument constructor
442 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
444 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
446 if (typeof(div
) == 'string') {
447 div
= document
.getElementById(div
);
451 console
.error("Constructing dygraph with a non-existent div!");
455 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
457 // Copy the important bits into the object
458 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
461 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
462 this.previousVerticalX_
= -1;
463 this.fractions_
= attrs
.fractions
|| false;
464 this.dateWindow_
= attrs
.dateWindow
|| null;
466 this.annotations_
= [];
468 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
469 this.zoomed_x_
= false;
470 this.zoomed_y_
= false;
472 // Clear the div. This ensure that, if multiple dygraphs are passed the same
473 // div, then only one will be drawn.
476 // For historical reasons, the 'width' and 'height' options trump all CSS
477 // rules _except_ for an explicit 'width' or 'height' on the div.
478 // As an added convenience, if the div has zero height (like <div></div> does
479 // without any styles), then we use a default height/width
.
480 if (div
.style
.width
=== '' && attrs
.width
) {
481 div
.style
.width
= attrs
.width
+ "px";
483 if (div
.style
.height
=== '' && attrs
.height
) {
484 div
.style
.height
= attrs
.height
+ "px";
486 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
487 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
488 if (div
.style
.width
=== '') {
489 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
492 // These will be zero if the dygraph's div is hidden. In that case,
493 // use the user-specified attributes if present. If not, use zero
494 // and assume the user will call resize to fix things later.
495 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
496 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
498 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
499 if (attrs
.stackedGraph
) {
500 attrs
.fillGraph
= true;
501 // TODO(nikhilk): Add any other stackedGraph checks here.
504 // DEPRECATION WARNING: All option processing should be moved from
505 // attrs_ and user_attrs_ to options_, which holds all this information.
507 // Dygraphs has many options, some of which interact with one another.
508 // To keep track of everything, we maintain two sets of options:
510 // this.user_attrs_ only options explicitly set by the user.
511 // this.attrs_ defaults, options derived from user_attrs_, data.
513 // Options are then accessed this.attr_('attr'), which first looks at
514 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
515 // defaults without overriding behavior that the user specifically asks for.
516 this.user_attrs_
= {};
517 Dygraph
.update(this.user_attrs_
, attrs
);
519 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
521 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
523 this.boundaryIds_
= [];
524 this.setIndexByName_
= {};
525 this.datasetIndex_
= [];
527 this.registeredEvents_
= [];
528 this.eventListeners_
= {};
530 this.attributes_
= new DygraphOptions(this);
532 // Create the containing DIV and other interactive elements
533 this.createInterface_();
537 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
538 for (var i
= 0; i
< plugins
.length
; i
++) {
539 // the plugins option may contain either plugin classes or instances.
540 // Plugin instances contain an activate method.
541 var Plugin
= plugins
[i
]; // either a constructor or an instance.
543 if (typeof(Plugin
.activate
) !== 'undefined') {
544 pluginInstance
= Plugin
;
546 pluginInstance
= new Plugin();
550 plugin
: pluginInstance
,
556 var handlers
= pluginInstance
.activate(this);
557 for (var eventName
in handlers
) {
558 // TODO(danvk): validate eventName.
559 pluginDict
.events
[eventName
] = handlers
[eventName
];
562 this.plugins_
.push(pluginDict
);
565 // At this point, plugins can no longer register event handlers.
566 // Construct a map from event -> ordered list of [callback, plugin].
567 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
568 var plugin_dict
= this.plugins_
[i
];
569 for (var eventName
in plugin_dict
.events
) {
570 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
571 var callback
= plugin_dict
.events
[eventName
];
573 var pair
= [plugin_dict
.plugin
, callback
];
574 if (!(eventName
in this.eventListeners_
)) {
575 this.eventListeners_
[eventName
] = [pair
];
577 this.eventListeners_
[eventName
].push(pair
);
582 this.createDragInterface_();
588 * Triggers a cascade of events to the various plugins which are interested in them.
589 * Returns true if the "default behavior" should be prevented, i.e. if one
590 * of the event listeners called event.preventDefault().
593 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
594 if (!(name
in this.eventListeners_
)) return false;
596 // QUESTION: can we use objects & prototypes to speed this up?
600 defaultPrevented
: false,
601 preventDefault
: function() {
602 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
603 e
.defaultPrevented
= true;
605 propagationStopped
: false,
606 stopPropagation
: function() {
607 e
.propagationStopped
= true;
610 Dygraph
.update(e
, extra_props
);
612 var callback_plugin_pairs
= this.eventListeners_
[name
];
613 if (callback_plugin_pairs
) {
614 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
615 var plugin
= callback_plugin_pairs
[i
][0];
616 var callback
= callback_plugin_pairs
[i
][1];
617 callback
.call(plugin
, e
);
618 if (e
.propagationStopped
) break;
621 return e
.defaultPrevented
;
625 * Fetch a plugin instance of a particular class. Only for testing.
627 * @param {!Class} type The type of the plugin.
628 * @return {Object} Instance of the plugin, or null if there is none.
630 Dygraph
.prototype.getPluginInstance_
= function(type
) {
631 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
632 var p
= this.plugins_
[i
];
633 if (p
.plugin
instanceof type
) {
641 * Returns the zoomed status of the chart for one or both axes.
643 * Axis is an optional parameter. Can be set to 'x' or 'y'.
645 * The zoomed status for an axis is set whenever a user zooms using the mouse
646 * or when the dateWindow or valueRange are updated (unless the
647 * isZoomedIgnoreProgrammaticZoom option is also specified).
649 Dygraph
.prototype.isZoomed
= function(axis
) {
650 if (axis
=== null || axis
=== undefined
) {
651 return this.zoomed_x_
|| this.zoomed_y_
;
653 if (axis
=== 'x') return this.zoomed_x_
;
654 if (axis
=== 'y') return this.zoomed_y_
;
655 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
659 * Returns information about the Dygraph object, including its containing ID.
661 Dygraph
.prototype.toString
= function() {
662 var maindiv
= this.maindiv_
;
663 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
664 return "[Dygraph " + id
+ "]";
669 * Returns the value of an option. This may be set by the user (either in the
670 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
672 * @param {string} name The name of the option, e.g. 'rollPeriod'.
673 * @param {string} [seriesName] The name of the series to which the option
674 * will be applied. If no per-series value of this option is available, then
675 * the global value is returned. This is optional.
676 * @return { ... } The value of the option.
678 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
680 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
681 console
.error('Must include options reference JS for testing');
682 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
683 console
.error('Dygraphs is using property ' + name
+ ', which has no ' +
684 'entry in the Dygraphs.OPTIONS_REFERENCE listing.');
685 // Only log this error once.
686 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
689 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
693 * Returns the current value for an option, as set in the constructor or via
694 * updateOptions. You may pass in an (optional) series name to get per-series
695 * values for the option.
697 * All values returned by this method should be considered immutable. If you
698 * modify them, there is no guarantee that the changes will be honored or that
699 * dygraphs will remain in a consistent state. If you want to modify an option,
700 * use updateOptions() instead.
702 * @param {string} name The name of the option (e.g. 'strokeWidth')
703 * @param {string=} opt_seriesName Series name to get per-series values.
704 * @return {*} The value of the option.
706 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
707 return this.attr_(name
, opt_seriesName
);
711 * Like getOption(), but specifically returns a number.
712 * This is a convenience function for working with the Closure Compiler.
713 * @param {string} name The name of the option (e.g. 'strokeWidth')
714 * @param {string=} opt_seriesName Series name to get per-series values.
715 * @return {number} The value of the option.
718 Dygraph
.prototype.getNumericOption
= function(name
, opt_seriesName
) {
719 return /** @type{number} */(this.getOption(name
, opt_seriesName
));
723 * Like getOption(), but specifically returns a string.
724 * This is a convenience function for working with the Closure Compiler.
725 * @param {string} name The name of the option (e.g. 'strokeWidth')
726 * @param {string=} opt_seriesName Series name to get per-series values.
727 * @return {string} The value of the option.
730 Dygraph
.prototype.getStringOption
= function(name
, opt_seriesName
) {
731 return /** @type{string} */(this.getOption(name
, opt_seriesName
));
735 * Like getOption(), but specifically returns a boolean.
736 * This is a convenience function for working with the Closure Compiler.
737 * @param {string} name The name of the option (e.g. 'strokeWidth')
738 * @param {string=} opt_seriesName Series name to get per-series values.
739 * @return {boolean} The value of the option.
742 Dygraph
.prototype.getBooleanOption
= function(name
, opt_seriesName
) {
743 return /** @type{boolean} */(this.getOption(name
, opt_seriesName
));
747 * Like getOption(), but specifically returns a function.
748 * This is a convenience function for working with the Closure Compiler.
749 * @param {string} name The name of the option (e.g. 'strokeWidth')
750 * @param {string=} opt_seriesName Series name to get per-series values.
751 * @return {function(...)} The value of the option.
754 Dygraph
.prototype.getFunctionOption
= function(name
, opt_seriesName
) {
755 return /** @type{function(...)} */(this.getOption(name
, opt_seriesName
));
758 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
759 return this.attributes_
.getForAxis(name
, axis
);
764 * @param {string} axis The name of the axis (i.e. 'x', 'y' or 'y2')
765 * @return { ... } A function mapping string -> option value
767 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
769 return function(opt
) {
770 var axis_opts
= self
.user_attrs_
.axes
;
771 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
772 return axis_opts
[axis
][opt
];
775 // I don't like that this is in a second spot.
776 if (axis
=== 'x' && opt
=== 'logscale') {
777 // return the default value.
778 // TODO(konigsberg): pull the default from a global default.
782 // user-specified attributes always trump defaults, even if they're less
784 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
785 return self
.user_attrs_
[opt
];
788 axis_opts
= self
.attrs_
.axes
;
789 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
790 return axis_opts
[axis
][opt
];
792 // check old-style axis options
793 // TODO(danvk): add a deprecation warning if either of these match.
794 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
795 return self
.axes_
[0][opt
];
796 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
797 return self
.axes_
[1][opt
];
799 return self
.attr_(opt
);
804 * Returns the current rolling period, as set by the user or an option.
805 * @return {number} The number of points in the rolling window
807 Dygraph
.prototype.rollPeriod
= function() {
808 return this.rollPeriod_
;
812 * Returns the currently-visible x-range. This can be affected by zooming,
813 * panning or a call to updateOptions.
814 * Returns a two-element array: [left, right].
815 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
817 Dygraph
.prototype.xAxisRange
= function() {
818 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
822 * Returns the lower- and upper-bound x-axis values of the
825 Dygraph
.prototype.xAxisExtremes
= function() {
826 var pad
= this.getNumericOption('xRangePad') / this.plotter_
.area
.w
;
827 if (this.numRows() === 0) {
828 return [0 - pad
, 1 + pad
];
830 var left
= this.rawData_
[0][0];
831 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
833 // Must keep this in sync with dygraph-layout _evaluateLimits()
834 var range
= right
- left
;
836 right
+= range
* pad
;
838 return [left
, right
];
842 * Returns the currently-visible y-range for an axis. This can be affected by
843 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
844 * called with no arguments, returns the range of the first axis.
845 * Returns a two-element array: [bottom, top].
847 Dygraph
.prototype.yAxisRange
= function(idx
) {
848 if (typeof(idx
) == "undefined") idx
= 0;
849 if (idx
< 0 || idx
>= this.axes_
.length
) {
852 var axis
= this.axes_
[idx
];
853 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
857 * Returns the currently-visible y-ranges for each axis. This can be affected by
858 * zooming, panning, calls to updateOptions, etc.
859 * Returns an array of [bottom, top] pairs, one for each y-axis.
861 Dygraph
.prototype.yAxisRanges
= function() {
863 for (var i
= 0; i
< this.axes_
.length
; i
++) {
864 ret
.push(this.yAxisRange(i
));
869 // TODO(danvk): use these functions throughout dygraphs.
871 * Convert from data coordinates to canvas/div X/Y coordinates.
872 * If specified, do this conversion for the coordinate system of a particular
873 * axis. Uses the first axis by default.
874 * Returns a two-element array: [X, Y]
876 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
877 * instead of toDomCoords(null, y, axis).
879 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
880 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
884 * Convert from data x coordinates to canvas/div X coordinate.
885 * If specified, do this conversion for the coordinate system of a particular
887 * Returns a single value or null if x is null.
889 Dygraph
.prototype.toDomXCoord
= function(x
) {
894 var area
= this.plotter_
.area
;
895 var xRange
= this.xAxisRange();
896 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
900 * Convert from data x coordinates to canvas/div Y coordinate and optional
901 * axis. Uses the first axis by default.
903 * returns a single value or null if y is null.
905 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
906 var pct
= this.toPercentYCoord(y
, axis
);
911 var area
= this.plotter_
.area
;
912 return area
.y
+ pct
* area
.h
;
916 * Convert from canvas/div coords to data coordinates.
917 * If specified, do this conversion for the coordinate system of a particular
918 * axis. Uses the first axis by default.
919 * Returns a two-element array: [X, Y].
921 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
922 * instead of toDataCoords(null, y, axis).
924 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
925 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
929 * Convert from canvas/div x coordinate to data coordinate.
931 * If x is null, this returns null.
933 Dygraph
.prototype.toDataXCoord
= function(x
) {
938 var area
= this.plotter_
.area
;
939 var xRange
= this.xAxisRange();
941 if (!this.attributes_
.getForAxis("logscale", 'x')) {
942 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
944 // TODO: remove duplicate code?
945 // Computing the inverse of toDomCoord.
946 var pct
= (x
- area
.x
) / area
.w
;
948 // Computing the inverse of toPercentXCoord. The function was arrived at with
949 // the following steps:
951 // Original calcuation:
952 // pct = (log(x) - log(xRange[0])) / (log(xRange
[1]) - log(xRange
[0])));
954 // Multiply both sides by the right-side demoninator.
955 // pct * (log(xRange[1] - log(xRange[0]))) = log(x) - log(xRange[0])
957 // add log(xRange[0]) to both sides
958 // log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])) = log(x);
960 // Swap both sides of the equation,
961 // log(x) = log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0]))
963 // Use both sides as the exponent in 10^exp and we're done.
964 // x = 10 ^ (log(xRange[0]) + (pct * (log(xRange[1]) - log(xRange[0])))
965 var logr0
= Dygraph
.log10(xRange
[0]);
966 var logr1
= Dygraph
.log10(xRange
[1]);
967 var exponent
= logr0
+ (pct
* (logr1
- logr0
));
968 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
974 * Convert from canvas/div y coord to value.
976 * If y is null, this returns null.
977 * if axis is null, this uses the first axis.
979 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
984 var area
= this.plotter_
.area
;
985 var yRange
= this.yAxisRange(axis
);
987 if (typeof(axis
) == "undefined") axis
= 0;
988 if (!this.attributes_
.getForAxis("logscale", axis
)) {
989 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
991 // Computing the inverse of toDomCoord.
992 var pct
= (y
- area
.y
) / area
.h
;
994 // Computing the inverse of toPercentYCoord. The function was arrived at with
995 // the following steps:
997 // Original calcuation:
998 // pct = (log(yRange[1]) - log(y)) / (log(yRange
[1]) - log(yRange
[0]));
1000 // Multiply both sides by the right-side demoninator.
1001 // pct * (log(yRange[1]) - log(yRange[0])) = log(yRange[1]) - log(y);
1003 // subtract log(yRange[1]) from both sides.
1004 // (pct * (log(yRange[1]) - log(yRange[0]))) - log(yRange[1]) = -log(y);
1006 // and multiply both sides by -1.
1007 // log(yRange[1]) - (pct * (logr1 - log(yRange[0])) = log(y);
1009 // Swap both sides of the equation,
1010 // log(y) = log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0])));
1012 // Use both sides as the exponent in 10^exp and we're done.
1013 // y = 10 ^ (log(yRange[1]) - (pct * (log(yRange[1]) - log(yRange[0]))));
1014 var logr0
= Dygraph
.log10(yRange
[0]);
1015 var logr1
= Dygraph
.log10(yRange
[1]);
1016 var exponent
= logr1
- (pct
* (logr1
- logr0
));
1017 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
1023 * Converts a y for an axis to a percentage from the top to the
1024 * bottom of the drawing area.
1026 * If the coordinate represents a value visible on the canvas, then
1027 * the value will be between 0 and 1, where 0 is the top of the canvas.
1028 * However, this method will return values outside the range, as
1029 * values can fall outside the canvas.
1031 * If y is null, this returns null.
1032 * if axis is null, this uses the first axis.
1034 * @param {number} y The data y-coordinate.
1035 * @param {number} [axis] The axis number on which the data coordinate lives.
1036 * @return {number} A fraction in [0, 1] where 0 = the top edge.
1038 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
1042 if (typeof(axis
) == "undefined") axis
= 0;
1044 var yRange
= this.yAxisRange(axis
);
1047 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
1049 var logr0
= Dygraph
.log10(yRange
[0]);
1050 var logr1
= Dygraph
.log10(yRange
[1]);
1051 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- logr0
);
1053 // yRange[1] - y is unit distance from the bottom.
1054 // yRange[1] - yRange[0] is the scale of the range.
1055 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
1056 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
1062 * Converts an x value to a percentage from the left to the right of
1065 * If the coordinate represents a value visible on the canvas, then
1066 * the value will be between 0 and 1, where 0 is the left of the canvas.
1067 * However, this method will return values outside the range, as
1068 * values can fall outside the canvas.
1070 * If x is null, this returns null.
1071 * @param {number} x The data x-coordinate.
1072 * @return {number} A fraction in [0, 1] where 0 = the left edge.
1074 Dygraph
.prototype.toPercentXCoord
= function(x
) {
1079 var xRange
= this.xAxisRange();
1081 var logscale
= this.attributes_
.getForAxis("logscale", 'x') ;
1082 if (logscale
== true) { // logscale can be null so we test for true explicitly.
1083 var logr0
= Dygraph
.log10(xRange
[0]);
1084 var logr1
= Dygraph
.log10(xRange
[1]);
1085 pct
= (Dygraph
.log10(x
) - logr0
) / (logr1
- logr0
);
1087 // x - xRange[0] is unit distance from the left.
1088 // xRange[1] - xRange[0] is the scale of the range.
1089 // The full expression below is the % from the left.
1090 pct
= (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
1096 * Returns the number of columns (including the independent variable).
1097 * @return {number} The number of columns.
1099 Dygraph
.prototype.numColumns
= function() {
1100 if (!this.rawData_
) return 0;
1101 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
1105 * Returns the number of rows (excluding any header/label row).
1106 * @return {number} The number of rows, less any header.
1108 Dygraph
.prototype.numRows
= function() {
1109 if (!this.rawData_
) return 0;
1110 return this.rawData_
.length
;
1114 * Returns the value in the given row and column. If the row and column exceed
1115 * the bounds on the data, returns null. Also returns null if the value is
1117 * @param {number} row The row number of the data (0-based). Row 0 is the
1118 * first row of data, not a header row.
1119 * @param {number} col The column number of the data (0-based)
1120 * @return {number} The value in the specified cell or null if the row/col
1121 * were out of range.
1123 Dygraph
.prototype.getValue
= function(row
, col
) {
1124 if (row
< 0 || row
> this.rawData_
.length
) return null;
1125 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
1127 return this.rawData_
[row
][col
];
1131 * Generates interface elements for the Dygraph: a containing div, a div to
1132 * display the current point, and a textbox to adjust the rolling average
1133 * period. Also creates the Renderer/Layout elements.
1136 Dygraph
.prototype.createInterface_
= function() {
1137 // Create the all-enclosing graph div
1138 var enclosing
= this.maindiv_
;
1140 this.graphDiv
= document
.createElement("div");
1142 // TODO(danvk): any other styles that are useful to set here?
1143 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1144 this.graphDiv
.style
.position
= 'relative';
1145 enclosing
.appendChild(this.graphDiv
);
1147 // Create the canvas for interactive parts of the chart.
1148 this.canvas_
= Dygraph
.createCanvas();
1149 this.canvas_
.style
.position
= "absolute";
1151 // ... and for static parts of the chart.
1152 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1154 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1155 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1157 this.resizeElements_();
1159 // The interactive parts of the graph are drawn on top of the chart.
1160 this.graphDiv
.appendChild(this.hidden_
);
1161 this.graphDiv
.appendChild(this.canvas_
);
1162 this.mouseEventElement_
= this.createMouseEventElement_();
1164 // Create the grapher
1165 this.layout_
= new DygraphLayout(this);
1169 this.mouseMoveHandler_
= function(e
) {
1170 dygraph
.mouseMove_(e
);
1173 this.mouseOutHandler_
= function(e
) {
1174 // The mouse has left the chart if:
1175 // 1. e.target is inside the chart
1176 // 2. e.relatedTarget is outside the chart
1177 var target
= e
.target
|| e
.fromElement
;
1178 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1179 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1180 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1181 dygraph
.mouseOut_(e
);
1185 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1186 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1188 // Don't recreate and register the resize handler on subsequent calls.
1189 // This happens when the graph is resized.
1190 if (!this.resizeHandler_
) {
1191 this.resizeHandler_
= function(e
) {
1195 // Update when the window is resized.
1196 // TODO(danvk): drop frames depending on complexity of the chart.
1197 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1201 Dygraph
.prototype.resizeElements_
= function() {
1202 this.graphDiv
.style
.width
= this.width_
+ "px";
1203 this.graphDiv
.style
.height
= this.height_
+ "px";
1205 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1206 this.canvas_
.width
= this.width_
* canvasScale
;
1207 this.canvas_
.height
= this.height_
* canvasScale
;
1208 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1209 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1210 if (canvasScale
!== 1) {
1211 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1214 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1215 this.hidden_
.width
= this.width_
* hiddenScale
;
1216 this.hidden_
.height
= this.height_
* hiddenScale
;
1217 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1218 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1219 if (hiddenScale
!== 1) {
1220 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1225 * Detach DOM elements in the dygraph and null out all data references.
1226 * Calling this when you're done with a dygraph can dramatically reduce memory
1227 * usage. See, e.g., the tests/perf.html example.
1229 Dygraph
.prototype.destroy
= function() {
1230 this.canvas_ctx_
.restore();
1231 this.hidden_ctx_
.restore();
1233 var removeRecursive
= function(node
) {
1234 while (node
.hasChildNodes()) {
1235 removeRecursive(node
.firstChild
);
1236 node
.removeChild(node
.firstChild
);
1240 this.removeTrackedEvents_();
1242 // remove mouse event handlers (This may not be necessary anymore)
1243 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1244 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1246 // remove window handlers
1247 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1248 this.resizeHandler_
= null;
1250 removeRecursive(this.maindiv_
);
1252 var nullOut
= function(obj
) {
1253 for (var n
in obj
) {
1254 if (typeof(obj
[n
]) === 'object') {
1259 // These may not all be necessary, but it can't hurt...
1260 nullOut(this.layout_
);
1261 nullOut(this.plotter_
);
1266 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1267 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1268 * or the zoom rectangles) is done on this.canvas_.
1269 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1270 * @return {Object} The newly-created canvas
1273 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1274 var h
= Dygraph
.createCanvas();
1275 h
.style
.position
= "absolute";
1276 // TODO(danvk): h should be offset from canvas. canvas needs to include
1277 // some extra area to make it easier to zoom in on the far left and far
1278 // right. h needs to be precisely the plot area, so that clipping occurs.
1279 h
.style
.top
= canvas
.style
.top
;
1280 h
.style
.left
= canvas
.style
.left
;
1281 h
.width
= this.width_
;
1282 h
.height
= this.height_
;
1283 h
.style
.width
= this.width_
+ "px"; // for IE
1284 h
.style
.height
= this.height_
+ "px"; // for IE
1289 * Creates an overlay element used to handle mouse events.
1290 * @return {Object} The mouse event element.
1293 Dygraph
.prototype.createMouseEventElement_
= function() {
1294 if (this.isUsingExcanvas_
) {
1295 var elem
= document
.createElement("div");
1296 elem
.style
.position
= 'absolute';
1297 elem
.style
.backgroundColor
= 'white';
1298 elem
.style
.filter
= 'alpha(opacity=0)';
1299 elem
.style
.width
= this.width_
+ "px";
1300 elem
.style
.height
= this.height_
+ "px";
1301 this.graphDiv
.appendChild(elem
);
1304 return this.canvas_
;
1309 * Generate a set of distinct colors for the data series. This is done with a
1310 * color wheel. Saturation/Value are customizable, and the hue is
1311 * equally-spaced around the color wheel. If a custom set of colors is
1312 * specified, that is used instead.
1315 Dygraph
.prototype.setColors_
= function() {
1316 var labels
= this.getLabels();
1317 var num
= labels
.length
- 1;
1319 this.colorsMap_
= {};
1321 // These are used for when no custom colors are specified.
1322 var sat
= this.getNumericOption('colorSaturation') || 1.0;
1323 var val
= this.getNumericOption('colorValue') || 0.5;
1324 var half
= Math
.ceil(num
/ 2);
1326 var colors
= this.getOption('colors');
1327 var visibility
= this.visibility();
1328 for (var i
= 0; i
< num
; i
++) {
1329 if (!visibility
[i
]) {
1332 var label
= labels
[i
+ 1];
1333 var colorStr
= this.attributes_
.getForSeries('color', label
);
1336 colorStr
= colors
[i
% colors
.length
];
1338 // alternate colors for high contrast.
1339 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1340 var hue
= (1.0 * idx
/ (1 + num
));
1341 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1344 this.colors_
.push(colorStr
);
1345 this.colorsMap_
[label
] = colorStr
;
1350 * Return the list of colors. This is either the list of colors passed in the
1351 * attributes or the autogenerated list of rgb(r,g,b) strings.
1352 * This does not return colors for invisible series.
1353 * @return {Array.<string>} The list of colors.
1355 Dygraph
.prototype.getColors
= function() {
1356 return this.colors_
;
1360 * Returns a few attributes of a series, i.e. its color, its visibility, which
1361 * axis it's assigned to, and its column in the original data.
1362 * Returns null if the series does not exist.
1363 * Otherwise, returns an object with column, visibility, color and axis properties.
1364 * The "axis" property will be set to 1 for y1 and 2 for y2.
1365 * The "column" property can be fed back into getValue(row, column) to get
1366 * values for this series.
1368 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1370 var labels
= this.getLabels();
1371 for (var i
= 1; i
< labels
.length
; i
++) {
1372 if (labels
[i
] == series_name
) {
1377 if (idx
== -1) return null;
1382 visible
: this.visibility()[idx
- 1],
1383 color
: this.colorsMap_
[series_name
],
1384 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1389 * Create the text box to adjust the averaging period
1392 Dygraph
.prototype.createRollInterface_
= function() {
1393 // Create a roller if one doesn't exist already.
1394 if (!this.roller_
) {
1395 this.roller_
= document
.createElement("input");
1396 this.roller_
.type
= "text";
1397 this.roller_
.style
.display
= "none";
1398 this.graphDiv
.appendChild(this.roller_
);
1401 var display
= this.getBooleanOption('showRoller') ? 'block' : 'none';
1403 var area
= this.plotter_
.area
;
1404 var textAttr
= { "position": "absolute",
1406 "top": (area
.y
+ area
.h
- 25) + "px",
1407 "left": (area
.x
+ 1) + "px",
1410 this.roller_
.size
= "2";
1411 this.roller_
.value
= this.rollPeriod_
;
1412 for (var name
in textAttr
) {
1413 if (textAttr
.hasOwnProperty(name
)) {
1414 this.roller_
.style
[name
] = textAttr
[name
];
1419 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1423 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1427 Dygraph
.prototype.createDragInterface_
= function() {
1429 // Tracks whether the mouse is down right now
1431 isPanning
: false, // is this drag part of a pan?
1432 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1433 dragStartX
: null, // pixel coordinates
1434 dragStartY
: null, // pixel coordinates
1435 dragEndX
: null, // pixel coordinates
1436 dragEndY
: null, // pixel coordinates
1437 dragDirection
: null,
1438 prevEndX
: null, // pixel coordinates
1439 prevEndY
: null, // pixel coordinates
1440 prevDragDirection
: null,
1441 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1443 // The value on the left side of the graph when a pan operation starts.
1444 initialLeftmostDate
: null,
1446 // The number of units each pixel spans. (This won't be valid for log
1448 xUnitsPerPixel
: null,
1450 // TODO(danvk): update this comment
1451 // The range in second/value units that the viewport encompasses during a
1452 // panning operation.
1455 // Top-left corner of the canvas, in DOM coords
1456 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1460 // Values for use with panEdgeFraction, which limit how far outside the
1461 // graph's data boundaries it can be panned.
1462 boundedDates
: null, // [minDate, maxDate]
1463 boundedValues
: null, // [[minValue, maxValue] ...]
1465 // We cover iframes during mouse interactions. See comments in
1466 // dygraph-utils.js for more info on why this is a good idea.
1467 tarp
: new Dygraph
.IFrameTarp(),
1469 // contextB is the same thing as this context object but renamed.
1470 initializeMouseDown
: function(event
, g
, contextB
) {
1471 // prevents mouse drags from selecting page text.
1472 if (event
.preventDefault
) {
1473 event
.preventDefault(); // Firefox, Chrome, etc.
1475 event
.returnValue
= false; // IE
1476 event
.cancelBubble
= true;
1479 var canvasPos
= Dygraph
.findPos(g
.canvas_
);
1480 contextB
.px
= canvasPos
.x
;
1481 contextB
.py
= canvasPos
.y
;
1482 contextB
.dragStartX
= Dygraph
.dragGetX_(event
, contextB
);
1483 contextB
.dragStartY
= Dygraph
.dragGetY_(event
, contextB
);
1484 contextB
.cancelNextDblclick
= false;
1485 contextB
.tarp
.cover();
1489 var interactionModel
= this.getOption("interactionModel");
1491 // Self is the graph.
1494 // Function that binds the graph and context to the handler.
1495 var bindHandler
= function(handler
) {
1496 return function(event
) {
1497 handler(event
, self
, context
);
1501 for (var eventName
in interactionModel
) {
1502 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1503 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1504 bindHandler(interactionModel
[eventName
]));
1507 // If the user releases the mouse button during a drag, but not over the
1508 // canvas, then it doesn't count as a zooming action.
1509 var mouseUpHandler
= function(event
) {
1510 if (context
.isZooming
|| context
.isPanning
) {
1511 context
.isZooming
= false;
1512 context
.dragStartX
= null;
1513 context
.dragStartY
= null;
1516 if (context
.isPanning
) {
1517 context
.isPanning
= false;
1518 context
.draggingDate
= null;
1519 context
.dateRange
= null;
1520 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1521 delete self
.axes_
[i
].draggingValue
;
1522 delete self
.axes_
[i
].dragValueRange
;
1526 context
.tarp
.uncover();
1529 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1533 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1534 * up any previous zoom rectangles that were drawn. This could be optimized to
1535 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1538 * @param {number} direction the direction of the zoom rectangle. Acceptable
1539 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1540 * @param {number} startX The X position where the drag started, in canvas
1542 * @param {number} endX The current X position of the drag, in canvas coords.
1543 * @param {number} startY The Y position where the drag started, in canvas
1545 * @param {number} endY The current Y position of the drag, in canvas coords.
1546 * @param {number} prevDirection the value of direction on the previous call to
1547 * this function. Used to avoid excess redrawing
1548 * @param {number} prevEndX The value of endX on the previous call to this
1549 * function. Used to avoid excess redrawing
1550 * @param {number} prevEndY The value of endY on the previous call to this
1551 * function. Used to avoid excess redrawing
1554 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1555 endY
, prevDirection
, prevEndX
,
1557 var ctx
= this.canvas_ctx_
;
1559 // Clean up from the previous rect if necessary
1560 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1561 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1562 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1563 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1564 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1565 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1568 // Draw a light-grey rectangle to show the new viewing area
1569 if (direction
== Dygraph
.HORIZONTAL
) {
1570 if (endX
&& startX
) {
1571 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1572 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1573 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1575 } else if (direction
== Dygraph
.VERTICAL
) {
1576 if (endY
&& startY
) {
1577 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1578 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1579 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1583 if (this.isUsingExcanvas_
) {
1584 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1589 * Clear the zoom rectangle (and perform no zoom).
1592 Dygraph
.prototype.clearZoomRect_
= function() {
1593 this.currentZoomRectArgs_
= null;
1594 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1598 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1599 * the canvas. The exact zoom window may be slightly larger if there are no data
1600 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1601 * which accepts dates that match the raw data. This function redraws the graph.
1603 * @param {number} lowX The leftmost pixel value that should be visible.
1604 * @param {number} highX The rightmost pixel value that should be visible.
1607 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1608 this.currentZoomRectArgs_
= null;
1609 // Find the earliest and latest dates contained in this canvasx range.
1610 // Convert the call to date ranges of the raw data.
1611 var minDate
= this.toDataXCoord(lowX
);
1612 var maxDate
= this.toDataXCoord(highX
);
1613 this.doZoomXDates_(minDate
, maxDate
);
1617 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1618 * method with doZoomX which accepts pixel coordinates. This function redraws
1621 * @param {number} minDate The minimum date that should be visible.
1622 * @param {number} maxDate The maximum date that should be visible.
1625 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1626 // TODO(danvk): when xAxisRange is null (i.e. "fit to data", the animation
1627 // can produce strange effects. Rather than the x-axis transitioning slowly
1628 // between values, it can jerk around.)
1629 var old_window
= this.xAxisRange();
1630 var new_window
= [minDate
, maxDate
];
1631 this.zoomed_x_
= true;
1633 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1634 if (that
.getFunctionOption("zoomCallback")) {
1635 that
.getFunctionOption("zoomCallback").call(that
,
1636 minDate
, maxDate
, that
.yAxisRanges());
1642 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1643 * the canvas. This function redraws the graph.
1645 * @param {number} lowY The topmost pixel value that should be visible.
1646 * @param {number} highY The lowest pixel value that should be visible.
1649 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1650 this.currentZoomRectArgs_
= null;
1651 // Find the highest and lowest values in pixel range for each axis.
1652 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1653 // This is because pixels increase as you go down on the screen, whereas data
1654 // coordinates increase as you go up the screen.
1655 var oldValueRanges
= this.yAxisRanges();
1656 var newValueRanges
= [];
1657 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1658 var hi
= this.toDataYCoord(lowY
, i
);
1659 var low
= this.toDataYCoord(highY
, i
);
1660 newValueRanges
.push([low
, hi
]);
1663 this.zoomed_y_
= true;
1665 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1666 if (that
.getFunctionOption("zoomCallback")) {
1667 var xRange
= that
.xAxisRange();
1668 that
.getFunctionOption("zoomCallback").call(that
,
1669 xRange
[0], xRange
[1], that
.yAxisRanges());
1675 * Transition function to use in animations. Returns values between 0.0
1676 * (totally old values) and 1.0 (totally new values) for each frame.
1679 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1681 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1685 * Reset the zoom to the original view coordinates. This is the same as
1686 * double-clicking on the graph.
1688 Dygraph
.prototype.resetZoom
= function() {
1689 var dirty
= false, dirtyX
= false, dirtyY
= false;
1690 if (this.dateWindow_
!== null) {
1695 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1696 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1702 // Clear any selection, since it's likely to be drawn in the wrong place.
1703 this.clearSelection();
1706 this.zoomed_x_
= false;
1707 this.zoomed_y_
= false;
1709 var minDate
= this.rawData_
[0][0];
1710 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1712 // With only one frame, don't bother calculating extreme ranges.
1713 // TODO(danvk): merge this block w/ the code below
.
1714 if (!this.getBooleanOption("animatedZooms")) {
1715 this.dateWindow_
= null;
1716 for (i
= 0; i
< this.axes_
.length
; i
++) {
1717 if (this.axes_
[i
].valueWindow
!== null) {
1718 delete this.axes_
[i
].valueWindow
;
1722 if (this.getFunctionOption("zoomCallback")) {
1723 this.getFunctionOption("zoomCallback").call(this,
1724 minDate
, maxDate
, this.yAxisRanges());
1729 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1731 oldWindow
= this.xAxisRange();
1732 newWindow
= [minDate
, maxDate
];
1736 oldValueRanges
= this.yAxisRanges();
1737 // TODO(danvk): this is pretty inefficient
1738 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1739 var extremes
= packed
.extremes
;
1741 // this has the side-effect of modifying this.axes_.
1742 // this doesn't make much sense in this context, but it's convenient (we
1743 // need this.axes_[*].extremeValues) and not harmful since we'll be
1744 // calling drawGraph_ shortly, which clobbers these values.
1745 this.computeYAxisRanges_(extremes
);
1747 newValueRanges
= [];
1748 for (i
= 0; i
< this.axes_
.length
; i
++) {
1749 var axis
= this.axes_
[i
];
1750 newValueRanges
.push((axis
.valueRange
!== null &&
1751 axis
.valueRange
!== undefined
) ?
1752 axis
.valueRange
: axis
.extremeRange
);
1757 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1759 that
.dateWindow_
= null;
1760 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1761 if (that
.axes_
[i
].valueWindow
!== null) {
1762 delete that
.axes_
[i
].valueWindow
;
1765 if (that
.getFunctionOption("zoomCallback")) {
1766 that
.getFunctionOption("zoomCallback").call(that
,
1767 minDate
, maxDate
, that
.yAxisRanges());
1774 * Combined animation logic for all zoom functions.
1775 * either the x parameters or y parameters may be null.
1778 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1779 var steps
= this.getBooleanOption("animatedZooms") ?
1780 Dygraph
.ANIMATION_STEPS
: 1;
1783 var valueRanges
= [];
1786 if (oldXRange
!== null && newXRange
!== null) {
1787 for (step
= 1; step
<= steps
; step
++) {
1788 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1789 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1790 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1794 if (oldYRanges
!== null && newYRanges
!== null) {
1795 for (step
= 1; step
<= steps
; step
++) {
1796 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1798 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1799 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1800 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1802 valueRanges
[step
-1] = thisRange
;
1807 Dygraph
.repeatAndCleanup(function(step
) {
1808 if (valueRanges
.length
) {
1809 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1810 var w
= valueRanges
[step
][i
];
1811 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1814 if (windows
.length
) {
1815 that
.dateWindow_
= windows
[step
];
1818 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1822 * Get the current graph's area object.
1824 * Returns: {x, y, w, h}
1826 Dygraph
.prototype.getArea
= function() {
1827 return this.plotter_
.area
;
1831 * Convert a mouse event to DOM coordinates relative to the graph origin.
1833 * Returns a two-element array: [X, Y].
1835 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1836 if (event
.offsetX
&& event
.offsetY
) {
1837 return [ event
.offsetX
, event
.offsetY
];
1839 var eventElementPos
= Dygraph
.findPos(this.mouseEventElement_
);
1840 var canvasx
= Dygraph
.pageX(event
) - eventElementPos
.x
;
1841 var canvasy
= Dygraph
.pageY(event
) - eventElementPos
.y
;
1842 return [canvasx
, canvasy
];
1847 * Given a canvas X coordinate, find the closest row.
1848 * @param {number} domX graph-relative DOM X coordinate
1849 * Returns {number} row number.
1852 Dygraph
.prototype.findClosestRow
= function(domX
) {
1853 var minDistX
= Infinity
;
1854 var closestRow
= -1;
1855 var sets
= this.layout_
.points
;
1856 for (var i
= 0; i
< sets
.length
; i
++) {
1857 var points
= sets
[i
];
1858 var len
= points
.length
;
1859 for (var j
= 0; j
< len
; j
++) {
1860 var point
= points
[j
];
1861 if (!Dygraph
.isValidPoint(point
, true)) continue;
1862 var dist
= Math
.abs(point
.canvasx
- domX
);
1863 if (dist
< minDistX
) {
1865 closestRow
= point
.idx
;
1874 * Given canvas X,Y coordinates, find the closest point.
1876 * This finds the individual data point across all visible series
1877 * that's closest to the supplied DOM coordinates using the standard
1878 * Euclidean X,Y distance.
1880 * @param {number} domX graph-relative DOM X coordinate
1881 * @param {number} domY graph-relative DOM Y coordinate
1882 * Returns: {row, seriesName, point}
1885 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1886 var minDist
= Infinity
;
1887 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1888 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1889 var points
= this.layout_
.points
[setIdx
];
1890 for (var i
= 0; i
< points
.length
; ++i
) {
1892 if (!Dygraph
.isValidPoint(point
)) continue;
1893 dx
= point
.canvasx
- domX
;
1894 dy
= point
.canvasy
- domY
;
1895 dist
= dx
* dx
+ dy
* dy
;
1896 if (dist
< minDist
) {
1898 closestPoint
= point
;
1899 closestSeries
= setIdx
;
1900 closestRow
= point
.idx
;
1904 var name
= this.layout_
.setNames
[closestSeries
];
1913 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1915 * This first finds the X data point closest to the supplied DOM X coordinate,
1916 * then finds the series which puts the Y coordinate on top of its filled area,
1917 * using linear interpolation between adjacent point pairs.
1919 * @param {number} domX graph-relative DOM X coordinate
1920 * @param {number} domY graph-relative DOM Y coordinate
1921 * Returns: {row, seriesName, point}
1924 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1925 var row
= this.findClosestRow(domX
);
1926 var closestPoint
, closestSeries
;
1927 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1928 var boundary
= this.getLeftBoundary_(setIdx
);
1929 var rowIdx
= row
- boundary
;
1930 var points
= this.layout_
.points
[setIdx
];
1931 if (rowIdx
>= points
.length
) continue;
1932 var p1
= points
[rowIdx
];
1933 if (!Dygraph
.isValidPoint(p1
)) continue;
1934 var py
= p1
.canvasy
;
1935 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1936 // interpolate series Y value using next point
1937 var p2
= points
[rowIdx
+ 1];
1938 if (Dygraph
.isValidPoint(p2
)) {
1939 var dx
= p2
.canvasx
- p1
.canvasx
;
1941 var r
= (domX
- p1
.canvasx
) / dx
;
1942 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1945 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1946 // interpolate series Y value using previous point
1947 var p0
= points
[rowIdx
- 1];
1948 if (Dygraph
.isValidPoint(p0
)) {
1949 var dx
= p1
.canvasx
- p0
.canvasx
;
1951 var r
= (p1
.canvasx
- domX
) / dx
;
1952 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1956 // Stop if the point (domX, py) is above this series' upper edge
1957 if (setIdx
=== 0 || py
< domY
) {
1959 closestSeries
= setIdx
;
1962 var name
= this.layout_
.setNames
[closestSeries
];
1971 * When the mouse moves in the canvas, display information about a nearby data
1972 * point and draw dots over those points in the data series. This function
1973 * takes care of cleanup of previously-drawn dots.
1974 * @param {Object} event The mousemove event from the browser.
1977 Dygraph
.prototype.mouseMove_
= function(event
) {
1978 // This prevents JS errors when mousing over the canvas before data loads.
1979 var points
= this.layout_
.points
;
1980 if (points
=== undefined
|| points
=== null) return;
1982 var canvasCoords
= this.eventToDomCoords(event
);
1983 var canvasx
= canvasCoords
[0];
1984 var canvasy
= canvasCoords
[1];
1986 var highlightSeriesOpts
= this.getOption("highlightSeriesOpts");
1987 var selectionChanged
= false;
1988 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1990 if (this.getBooleanOption("stackedGraph")) {
1991 closest
= this.findStackedPoint(canvasx
, canvasy
);
1993 closest
= this.findClosestPoint(canvasx
, canvasy
);
1995 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1997 var idx
= this.findClosestRow(canvasx
);
1998 selectionChanged
= this.setSelection(idx
);
2001 var callback
= this.getFunctionOption("highlightCallback");
2002 if (callback
&& selectionChanged
) {
2003 callback
.call(this, event
,
2007 this.highlightSet_
);
2012 * Fetch left offset from the specified set index or if not passed, the
2013 * first defined boundaryIds record (see bug #236).
2016 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
2017 if (this.boundaryIds_
[setIdx
]) {
2018 return this.boundaryIds_
[setIdx
][0];
2020 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
2021 if (this.boundaryIds_
[i
] !== undefined
) {
2022 return this.boundaryIds_
[i
][0];
2029 Dygraph
.prototype.animateSelection_
= function(direction
) {
2030 var totalSteps
= 10;
2032 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
2033 if (this.animateId
=== undefined
) this.animateId
= 0;
2034 var start
= this.fadeLevel
;
2035 var steps
= direction
< 0 ? start
: totalSteps
- start
;
2037 if (this.fadeLevel
) {
2038 this.updateSelection_(1.0);
2043 var thisId
= ++this.animateId
;
2045 Dygraph
.repeatAndCleanup(
2047 // ignore simultaneous animations
2048 if (that
.animateId
!= thisId
) return;
2050 that
.fadeLevel
+= direction
;
2051 if (that
.fadeLevel
=== 0) {
2052 that
.clearSelection();
2054 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
2057 steps
, millis
, function() {});
2061 * Draw dots over the selectied points in the data series. This function
2062 * takes care of cleanup of previously-drawn dots.
2065 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
2066 /*var defaultPrevented = */
2067 this.cascadeEvents_('select', {
2068 selectedX
: this.lastx_
,
2069 selectedPoints
: this.selPoints_
2071 // TODO(danvk): use defaultPrevented here?
2073 // Clear the previously drawn vertical, if there is one
2075 var ctx
= this.canvas_ctx_
;
2076 if (this.getOption('highlightSeriesOpts')) {
2077 ctx
.clearRect(0, 0, this.width_
, this.height_
);
2078 var alpha
= 1.0 - this.getNumericOption('highlightSeriesBackgroundAlpha');
2080 // Activating background fade includes an animation effect for a gradual
2081 // fade. TODO(klausw): make this independently configurable if it causes
2082 // issues? Use a shared preference to control animations?
2083 var animateBackgroundFade
= true;
2084 if (animateBackgroundFade
) {
2085 if (opt_animFraction
=== undefined
) {
2086 // start a new animation
2087 this.animateSelection_(1);
2090 alpha
*= opt_animFraction
;
2092 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
2093 ctx
.fillRect(0, 0, this.width_
, this.height_
);
2096 // Redraw only the highlighted series in the interactive canvas (not the
2097 // static plot canvas, which is where series are usually drawn).
2098 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
2099 } else if (this.previousVerticalX_
>= 0) {
2100 // Determine the maximum highlight circle size.
2101 var maxCircleSize
= 0;
2102 var labels
= this.attr_('labels');
2103 for (i
= 1; i
< labels
.length
; i
++) {
2104 var r
= this.getNumericOption('highlightCircleSize', labels
[i
]);
2105 if (r
> maxCircleSize
) maxCircleSize
= r
;
2107 var px
= this.previousVerticalX_
;
2108 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
2109 2 * maxCircleSize
+ 2, this.height_
);
2112 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
2113 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
2116 if (this.selPoints_
.length
> 0) {
2117 // Draw colored circles over the center of each selected point
2118 var canvasx
= this.selPoints_
[0].canvasx
;
2120 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
2121 var pt
= this.selPoints_
[i
];
2122 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
2124 var circleSize
= this.getNumericOption('highlightCircleSize', pt
.name
);
2125 var callback
= this.getFunctionOption("drawHighlightPointCallback", pt
.name
);
2126 var color
= this.plotter_
.colors
[pt
.name
];
2128 callback
= Dygraph
.Circles
.DEFAULT
;
2130 ctx
.lineWidth
= this.getNumericOption('strokeWidth', pt
.name
);
2131 ctx
.strokeStyle
= color
;
2132 ctx
.fillStyle
= color
;
2133 callback
.call(this, this, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2134 color
, circleSize
, pt
.idx
);
2138 this.previousVerticalX_
= canvasx
;
2143 * Manually set the selected points and display information about them in the
2144 * legend. The selection can be cleared using clearSelection() and queried
2145 * using getSelection().
2146 * @param {number} row Row number that should be highlighted (i.e. appear with
2147 * hover dots on the chart). Set to false to clear any selection.
2148 * @param {seriesName} optional series name to highlight that series with the
2149 * the highlightSeriesOpts setting.
2150 * @param { locked } optional If true, keep seriesName selected when mousing
2151 * over the graph, disabling closest-series highlighting. Call clearSelection()
2154 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2155 // Extract the points we've selected
2156 this.selPoints_
= [];
2158 var changed
= false;
2159 if (row
!== false && row
>= 0) {
2160 if (row
!= this.lastRow_
) changed
= true;
2161 this.lastRow_
= row
;
2162 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2163 var points
= this.layout_
.points
[setIdx
];
2164 // Check if the point at the appropriate index is the point we're looking
2165 // for. If it is, just use it, otherwise search the array for a point
2166 // in the proper place.
2167 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2168 if (setRow
< points
.length
&& points
[setRow
].idx
== row
) {
2169 var point
= points
[setRow
];
2170 if (point
.yval
!== null) this.selPoints_
.push(point
);
2172 for (var pointIdx
= 0; pointIdx
< points
.length
; ++pointIdx
) {
2173 var point
= points
[pointIdx
];
2174 if (point
.idx
== row
) {
2175 if (point
.yval
!== null) {
2176 this.selPoints_
.push(point
);
2184 if (this.lastRow_
>= 0) changed
= true;
2188 if (this.selPoints_
.length
) {
2189 this.lastx_
= this.selPoints_
[0].xval
;
2194 if (opt_seriesName
!== undefined
) {
2195 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2196 this.highlightSet_
= opt_seriesName
;
2199 if (opt_locked
!== undefined
) {
2200 this.lockedSet_
= opt_locked
;
2204 this.updateSelection_(undefined
);
2210 * The mouse has left the canvas. Clear out whatever artifacts remain
2211 * @param {Object} event the mouseout event from the browser.
2214 Dygraph
.prototype.mouseOut_
= function(event
) {
2215 if (this.getFunctionOption("unhighlightCallback")) {
2216 this.getFunctionOption("unhighlightCallback").call(this, event
);
2219 if (this.getBooleanOption("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2220 this.clearSelection();
2225 * Clears the current selection (i.e. points that were highlighted by moving
2226 * the mouse over the chart).
2228 Dygraph
.prototype.clearSelection
= function() {
2229 this.cascadeEvents_('deselect', {});
2231 this.lockedSet_
= false;
2232 // Get rid of the overlay data
2233 if (this.fadeLevel
) {
2234 this.animateSelection_(-1);
2237 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2239 this.selPoints_
= [];
2242 this.highlightSet_
= null;
2246 * Returns the number of the currently selected row. To get data for this row,
2247 * you can use the getValue method.
2248 * @return {number} row number, or -1 if nothing is selected
2250 Dygraph
.prototype.getSelection
= function() {
2251 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2255 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2256 var points
= this.layout_
.points
[setIdx
];
2257 for (var row
= 0; row
< points
.length
; row
++) {
2258 if (points
[row
].x
== this.selPoints_
[0].x
) {
2259 return points
[row
].idx
;
2267 * Returns the name of the currently-highlighted series.
2268 * Only available when the highlightSeriesOpts option is in use.
2270 Dygraph
.prototype.getHighlightSeries
= function() {
2271 return this.highlightSet_
;
2275 * Returns true if the currently-highlighted series was locked
2276 * via setSelection(..., seriesName, true).
2278 Dygraph
.prototype.isSeriesLocked
= function() {
2279 return this.lockedSet_
;
2283 * Fires when there's data available to be graphed.
2284 * @param {string} data Raw CSV data to be plotted
2287 Dygraph
.prototype.loadedEvent_
= function(data
) {
2288 this.rawData_
= this.parseCSV_(data
);
2289 this.cascadeDataDidUpdateEvent_();
2294 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2297 Dygraph
.prototype.addXTicks_
= function() {
2298 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2300 if (this.dateWindow_
) {
2301 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2303 range
= this.xAxisExtremes();
2306 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2307 var xTicks
= xAxisOptionsView('ticker')(
2310 this.width_
, // TODO(danvk): should be area.width
2313 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2314 // console.log(msg);
2315 this.layout_
.setXTicks(xTicks
);
2319 * Returns the correct handler class for the currently set options.
2322 Dygraph
.prototype.getHandlerClass_
= function() {
2324 if (this.attr_('dataHandler')) {
2325 handlerClass
= this.attr_('dataHandler');
2326 } else if (this.fractions_
) {
2327 if (this.getBooleanOption('errorBars')) {
2328 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2330 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2332 } else if (this.getBooleanOption('customBars')) {
2333 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2334 } else if (this.getBooleanOption('errorBars')) {
2335 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2337 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2339 return handlerClass
;
2344 * This function is called once when the chart's data is changed or the options
2345 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2346 * idea is that values derived from the chart's data can be computed here,
2347 * rather than every time the chart is drawn. This includes things like the
2348 * number of axes, rolling averages, etc.
2350 Dygraph
.prototype.predraw_
= function() {
2351 var start
= new Date();
2353 // Create the correct dataHandler
2354 this.dataHandler_
= new (this.getHandlerClass_())();
2356 this.layout_
.computePlotArea();
2358 // TODO(danvk): move more computations out of drawGraph_ and into here.
2359 this.computeYAxes_();
2361 if (!this.is_initial_draw_
) {
2362 this.canvas_ctx_
.restore();
2363 this.hidden_ctx_
.restore();
2366 this.canvas_ctx_
.save();
2367 this.hidden_ctx_
.save();
2369 // Create a new plotter.
2370 this.plotter_
= new DygraphCanvasRenderer(this,
2375 // The roller sits in the bottom left corner of the chart. We don't know where
2376 // this will be until the options are available, so it's positioned here.
2377 this.createRollInterface_();
2379 this.cascadeEvents_('predraw');
2381 // Convert the raw data (a 2D array) into the internal format and compute
2382 // rolling averages.
2383 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2384 for (var i
= 1; i
< this.numColumns(); i
++) {
2385 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2386 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2387 if (this.rollPeriod_
> 1) {
2388 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2391 this.rolledSeries_
.push(series
);
2394 // If the data or options have changed, then we'd better redraw.
2397 // This is used to determine whether to do various animations.
2398 var end
= new Date();
2399 this.drawingTimeMs_
= (end
- start
);
2405 * xval_* and yval_* are the original unscaled data values,
2406 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2407 * yval_stacked is the cumulative Y value used for stacking graphs,
2408 * and bottom/top/minus/plus are used for error bar graphs.
2415 * y_bottom: ?number,
2417 * y_stacked: ?number,
2419 * yval_minus: ?number,
2421 * yval_plus: ?number,
2425 Dygraph
.PointType
= undefined
;
2428 * Calculates point stacking for stackedGraph=true.
2430 * For stacking purposes, interpolate or extend neighboring data across
2431 * NaN values based on stackedGraphNaNFill settings. This is for display
2432 * only, the underlying data value as shown in the legend remains NaN.
2434 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2435 * Updates each Point's yval_stacked property.
2436 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2437 * values for the series seen so far. Index is the row number. Updated
2438 * based on the current series's values.
2439 * @param {Array.<number>} seriesExtremes Min and max values, updated
2440 * to reflect the stacked values.
2441 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2445 Dygraph
.stackPoints_
= function(
2446 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2447 var lastXval
= null;
2448 var prevPoint
= null;
2449 var nextPoint
= null;
2450 var nextPointIdx
= -1;
2452 // Find the next stackable point starting from the given index.
2453 var updateNextPoint
= function(idx
) {
2454 // If we've previously found a non-NaN point and haven't gone past it yet,
2456 if (nextPointIdx
>= idx
) return;
2458 // We haven't found a non-NaN point yet or have moved past it,
2459 // look towards the right to find a non-NaN point.
2460 for (var j
= idx
; j
< points
.length
; ++j
) {
2461 // Clear out a previously-found point (if any) since it's no longer
2462 // valid, we shouldn't use it for interpolation anymore.
2464 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2466 nextPoint
= points
[j
];
2472 for (var i
= 0; i
< points
.length
; ++i
) {
2473 var point
= points
[i
];
2474 var xval
= point
.xval
;
2475 if (cumulativeYval
[xval
] === undefined
) {
2476 cumulativeYval
[xval
] = 0;
2479 var actualYval
= point
.yval
;
2480 if (isNaN(actualYval
) || actualYval
=== null) {
2481 if(fillMethod
== 'none') {
2484 // Interpolate/extend
for stacking purposes
if possible
.
2486 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2487 // Use linear interpolation between prevPoint and nextPoint.
2488 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2489 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2490 } else if (prevPoint
&& fillMethod
== 'all') {
2491 actualYval
= prevPoint
.yval
;
2492 } else if (nextPoint
&& fillMethod
== 'all') {
2493 actualYval
= nextPoint
.yval
;
2502 var stackedYval
= cumulativeYval
[xval
];
2503 if (lastXval
!= xval
) {
2504 // If an x-value is repeated, we ignore the duplicates.
2505 stackedYval
+= actualYval
;
2506 cumulativeYval
[xval
] = stackedYval
;
2510 point
.yval_stacked
= stackedYval
;
2512 if (stackedYval
> seriesExtremes
[1]) {
2513 seriesExtremes
[1] = stackedYval
;
2515 if (stackedYval
< seriesExtremes
[0]) {
2516 seriesExtremes
[0] = stackedYval
;
2523 * Loop over all fields and create datasets, calculating extreme y-values for
2524 * each series and extreme x-indices as we go.
2526 * dateWindow is passed in as an explicit parameter so that we can compute
2527 * extreme values "speculatively", i.e. without actually setting state on the
2530 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2531 * rolledSeries[seriesIndex][row] = raw point, where
2532 * seriesIndex is the column number starting with 1, and
2533 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2534 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2536 * points: Array.<Array.<Dygraph.PointType>>,
2537 * seriesExtremes: Array.<Array.<number>>,
2538 * boundaryIds: Array.<number>}}
2541 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2542 var boundaryIds
= [];
2544 var cumulativeYval
= []; // For stacked series.
2545 var extremes
= {}; // series name -> [low, high]
2546 var seriesIdx
, sampleIdx
;
2547 var firstIdx
, lastIdx
;
2550 // Loop over the fields (series). Go from the last to the first,
2551 // because if they're stacked that's how we accumulate the values.
2552 var num_series
= rolledSeries
.length
- 1;
2554 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2555 if (!this.visibility()[seriesIdx
- 1]) continue;
2557 // Prune down to the desired range, if necessary (for zooming)
2558 // Because there can be lines going to points outside of the visible area,
2559 // we actually prune to visible points, plus one on either side.
2561 series
= rolledSeries
[seriesIdx
];
2562 var low
= dateWindow
[0];
2563 var high
= dateWindow
[1];
2565 // TODO(danvk): do binary search instead of linear search.
2566 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2569 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2570 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2571 firstIdx
= sampleIdx
;
2573 if (series
[sampleIdx
][0] <= high
) {
2574 lastIdx
= sampleIdx
;
2578 if (firstIdx
=== null) firstIdx
= 0;
2579 var correctedFirstIdx
= firstIdx
;
2580 var isInvalidValue
= true;
2581 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2582 correctedFirstIdx
--;
2583 // check if the y value is null.
2584 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2587 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2588 var correctedLastIdx
= lastIdx
;
2589 isInvalidValue
= true;
2590 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2592 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2595 if (correctedFirstIdx
!==firstIdx
) {
2596 firstIdx
= correctedFirstIdx
;
2598 if (correctedLastIdx
!== lastIdx
) {
2599 lastIdx
= correctedLastIdx
;
2602 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2604 // .slice's end is exclusive, we want to include lastIdx.
2605 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2607 series
= rolledSeries
[seriesIdx
];
2608 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2611 var seriesName
= this.attr_("labels")[seriesIdx
];
2612 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2613 dateWindow
, this.getBooleanOption("stepPlot",seriesName
));
2615 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2616 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2618 if (this.getBooleanOption("stackedGraph")) {
2619 axisIdx
= this.attributes_
.axisForSeries(seriesName
);
2620 if (cumulativeYval
[axisIdx
] === undefined
) {
2621 cumulativeYval
[axisIdx
] = [];
2623 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
[axisIdx
], seriesExtremes
,
2624 this.getBooleanOption("stackedGraphNaNFill"));
2627 extremes
[seriesName
] = seriesExtremes
;
2628 points
[seriesIdx
] = seriesPoints
;
2631 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2635 * Update the graph with new data. This method is called when the viewing area
2636 * has changed. If the underlying data or options have changed, predraw_ will
2637 * be called before drawGraph_ is called.
2641 Dygraph
.prototype.drawGraph_
= function() {
2642 var start
= new Date();
2644 // This is used to set the second parameter to drawCallback, below.
2645 var is_initial_draw
= this.is_initial_draw_
;
2646 this.is_initial_draw_
= false;
2648 this.layout_
.removeAllDatasets();
2650 this.attrs_
.pointSize
= 0.5 * this.getNumericOption('highlightCircleSize');
2652 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2653 var points
= packed
.points
;
2654 var extremes
= packed
.extremes
;
2655 this.boundaryIds_
= packed
.boundaryIds
;
2657 this.setIndexByName_
= {};
2658 var labels
= this.attr_("labels");
2659 if (labels
.length
> 0) {
2660 this.setIndexByName_
[labels
[0]] = 0;
2663 for (var i
= 1; i
< points
.length
; i
++) {
2664 this.setIndexByName_
[labels
[i
]] = i
;
2665 if (!this.visibility()[i
- 1]) continue;
2666 this.layout_
.addDataset(labels
[i
], points
[i
]);
2667 this.datasetIndex_
[i
] = dataIdx
++;
2670 this.computeYAxisRanges_(extremes
);
2671 this.layout_
.setYAxes(this.axes_
);
2675 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2676 var tmp_zoomed_x
= this.zoomed_x_
;
2677 // Tell PlotKit to use this new data and render itself
2678 this.zoomed_x_
= tmp_zoomed_x
;
2679 this.layout_
.evaluate();
2680 this.renderGraph_(is_initial_draw
);
2682 if (this.getStringOption("timingName")) {
2683 var end
= new Date();
2684 console
.log(this.getStringOption("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2689 * This does the work of drawing the chart. It assumes that the layout and axis
2690 * scales have already been set (e.g. by predraw_).
2694 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2695 this.cascadeEvents_('clearChart');
2696 this.plotter_
.clear();
2698 if (this.getFunctionOption('underlayCallback')) {
2699 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2700 // users who expect a deprecated form of this callback.
2701 this.getFunctionOption('underlayCallback').call(this,
2702 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2706 canvas
: this.hidden_
,
2707 drawingContext
: this.hidden_ctx_
2709 this.cascadeEvents_('willDrawChart', e
);
2710 this.plotter_
.render();
2711 this.cascadeEvents_('didDrawChart', e
);
2712 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2714 // TODO(danvk): is this a performance bottleneck when panning?
2715 // The interaction canvas should already be empty in that situation.
2716 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2717 this.canvas_
.height
);
2719 if (this.getFunctionOption("drawCallback") !== null) {
2720 this.getFunctionOption("drawCallback")(this, is_initial_draw
);
2722 if (is_initial_draw
) {
2723 this.readyFired_
= true;
2724 while (this.readyFns_
.length
> 0) {
2725 var fn
= this.readyFns_
.pop();
2733 * Determine properties of the y-axes which are independent of the data
2734 * currently being displayed. This includes things like the number of axes and
2735 * the style of the axes. It does not include the range of each axis and its
2737 * This fills in this.axes_.
2738 * axes_ = [ { options } ]
2739 * indices are into the axes_ array.
2741 Dygraph
.prototype.computeYAxes_
= function() {
2742 // Preserve valueWindow settings if they exist, and if the user hasn't
2743 // specified a new valueRange.
2744 var valueWindows
, axis
, index
, opts
, v
;
2745 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2747 for (index
= 0; index
< this.axes_
.length
; index
++) {
2748 valueWindows
.push(this.axes_
[index
].valueWindow
);
2752 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2753 // data computation as well as options storage.
2754 // Go through once and add all the axes.
2757 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2758 // Add a new axis, making a copy of its per-axis options.
2759 opts
= { g
: this };
2760 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2761 this.axes_
[axis
] = opts
;
2765 // Copy global valueRange option over to the first axis.
2766 // NOTE(konigsberg): Are these two statements necessary?
2767 // I tried removing it. The automated tests pass, and manually
2768 // messing with tests/zoom
.html showed no trouble
.
2769 v
= this.attr_('valueRange');
2770 if (v
) this.axes_
[0].valueRange
= v
;
2772 if (valueWindows
!== undefined
) {
2773 // Restore valueWindow settings.
2775 // When going from two axes back to one, we only restore
2777 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2779 for (index
= 0; index
< idxCount
; index
++) {
2780 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2784 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2786 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2787 v
= opts("valueRange");
2788 if (v
) this.axes_
[axis
].valueRange
= v
;
2789 } else { // To keep old behavior
2790 var axes
= this.user_attrs_
.axes
;
2791 if (axes
&& axes
.y2
) {
2792 v
= axes
.y2
.valueRange
;
2793 if (v
) this.axes_
[axis
].valueRange
= v
;
2800 * Returns the number of y-axes on the chart.
2801 * @return {number} the number of axes.
2803 Dygraph
.prototype.numAxes
= function() {
2804 return this.attributes_
.numAxes();
2809 * Returns axis properties for the given series.
2810 * @param {string} setName The name of the series for which to get axis
2811 * properties, e.g. 'Y1'.
2812 * @return {Object} The axis properties.
2814 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2815 // TODO(danvk): handle errors.
2816 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2821 * Determine the value range and tick marks for each axis.
2822 * @param {Object} extremes A mapping from seriesName -> [low, high]
2823 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2825 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2826 var isNullUndefinedOrNaN
= function(num
) {
2827 return isNaN(parseFloat(num
));
2829 var numAxes
= this.attributes_
.numAxes();
2830 var ypadCompat
, span
, series
, ypad
;
2834 // Compute extreme values, a span and tick marks for each axis.
2835 for (var i
= 0; i
< numAxes
; i
++) {
2836 var axis
= this.axes_
[i
];
2837 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2838 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2839 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2840 series
= this.attributes_
.seriesForAxis(i
);
2842 // Add some padding. This supports two Y padding operation modes:
2844 // - backwards compatible (yRangePad not set):
2845 // 10% padding for automatic Y ranges, but not for user-supplied
2846 // ranges, and move a close-to-zero edge to zero except if
2847 // avoidMinZero is set, since drawing at the edge results in
2848 // invisible lines. Unfortunately lines drawn at the edge of a
2849 // user-supplied range will still be invisible. If logscale is
2850 // set, add a variable amount of padding at the top but
2851 // none at the bottom.
2853 // - new-style (yRangePad set by the user):
2854 // always add the specified Y padding.
2857 ypad
= 0.1; // add 10%
2858 if (this.getNumericOption('yRangePad') !== null) {
2860 // Convert pixel padding to ratio
2861 ypad
= this.getNumericOption('yRangePad') / this.plotter_
.area
.h
;
2864 if (series
.length
=== 0) {
2865 // If no series are defined or visible then use a reasonable default
2866 axis
.extremeRange
= [0, 1];
2868 // Calculate the extremes of extremes.
2869 var minY
= Infinity
; // extremes[series[0]][0];
2870 var maxY
= -Infinity
; // extremes[series[0]][1];
2871 var extremeMinY
, extremeMaxY
;
2873 for (var j
= 0; j
< series
.length
; j
++) {
2874 // this skips invisible series
2875 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2877 // Only use valid extremes to stop null data series' from corrupting the scale.
2878 extremeMinY
= extremes
[series
[j
]][0];
2879 if (extremeMinY
!== null) {
2880 minY
= Math
.min(extremeMinY
, minY
);
2882 extremeMaxY
= extremes
[series
[j
]][1];
2883 if (extremeMaxY
!== null) {
2884 maxY
= Math
.max(extremeMaxY
, maxY
);
2888 // Include zero if requested by the user.
2889 if (includeZero
&& !logscale
) {
2890 if (minY
> 0) minY
= 0;
2891 if (maxY
< 0) maxY
= 0;
2894 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2895 if (minY
== Infinity
) minY
= 0;
2896 if (maxY
== -Infinity
) maxY
= 1;
2899 // special case: if we have no sense of scale, center on the sole value.
2902 span
= Math
.abs(maxY
);
2904 // ... and if the sole value is zero, use range 0-1.
2910 var maxAxisY
, minAxisY
;
2913 maxAxisY
= maxY
+ ypad
* span
;
2916 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2917 maxAxisY
= maxY
* logpad
;
2918 minAxisY
= minY
/ logpad
;
2921 maxAxisY
= maxY
+ ypad
* span
;
2922 minAxisY
= minY
- ypad
* span
;
2924 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2925 // close to zero, but not if avoidMinZero is set.
2926 if (ypadCompat
&& !this.getBooleanOption("avoidMinZero")) {
2927 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2928 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2931 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2933 if (axis
.valueWindow
) {
2934 // This is only set if the user has zoomed on the y-axis. It is never set
2935 // by a user. It takes precedence over axis.valueRange because, if you set
2936 // valueRange, you'd still expect to be able to pan.
2937 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2938 } else if (axis
.valueRange
) {
2939 // This is a user-set value range for this axis.
2940 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2941 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2943 if (axis
.logscale
) {
2944 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2953 axis
.computedValueRange
= [y0
, y1
];
2955 axis
.computedValueRange
= axis
.extremeRange
;
2959 if (independentTicks
) {
2960 axis
.independentTicks
= independentTicks
;
2961 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2962 var ticker
= opts('ticker');
2963 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2964 axis
.computedValueRange
[1],
2965 this.height_
, // TODO(danvk): should be area.height
2968 // Define the first independent axis as primary axis.
2969 if (!p_axis
) p_axis
= axis
;
2972 if (p_axis
=== undefined
) {
2973 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2975 // Add ticks. By default, all axes inherit the tick positions of the
2976 // primary axis. However, if an axis is specifically marked as having
2977 // independent ticks, then that is permissible as well.
2978 for (var i
= 0; i
< numAxes
; i
++) {
2979 var axis
= this.axes_
[i
];
2981 if (!axis
.independentTicks
) {
2982 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2983 var ticker
= opts('ticker');
2984 var p_ticks
= p_axis
.ticks
;
2985 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2986 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2987 var tick_values
= [];
2988 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2989 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2990 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2991 tick_values
.push(y_val
);
2994 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2995 axis
.computedValueRange
[1],
2996 this.height_
, // TODO(danvk): should be area.height
3005 * Detects the type of the str (date or numeric) and sets the various
3006 * formatting attributes in this.attrs_ based on this type.
3007 * @param {string} str An x value.
3010 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
3012 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
3013 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
3014 str
.indexOf('/') >= 0 ||
3015 isNaN(parseFloat(str
))) {
3017 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
3018 // TODO(danvk): remove support for this format.
3022 this.setXAxisOptions_(isDate
);
3025 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
3027 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3028 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3029 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3030 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3032 /** @private (shut up, jsdoc!) */
3033 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3034 // TODO(danvk): use Dygraph.numberValueFormatter here?
3035 /** @private (shut up, jsdoc!) */
3036 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3037 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3038 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3044 * Parses a string in a special csv format. We expect a csv file where each
3045 * line is a date point, and the first field in each line is the date string.
3046 * We also expect that all remaining fields represent series.
3047 * if the errorBars attribute is set, then interpret the fields as:
3048 * date, series1, stddev1, series2, stddev2, ...
3049 * @param {[Object]} data See above.
3051 * @return [Object] An array with one entry for each row. These entries
3052 * are an array of cells in that row. The first entry is the parsed x-value for
3053 * the row. The second, third, etc. are the y-values. These can take on one of
3054 * three forms, depending on the CSV and constructor parameters:
3056 * 2. [ value, stddev ]
3057 * 3. [ low value, center value, high value ]
3059 Dygraph
.prototype.parseCSV_
= function(data
) {
3061 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3062 var lines
= data
.split(line_delimiter
|| "\n");
3065 // Use the default delimiter or fall back to a tab if that makes sense.
3066 var delim
= this.getStringOption('delimiter');
3067 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
3072 if (!('labels' in this.user_attrs_
)) {
3073 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
3075 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
3076 this.attributes_
.reparseSeries();
3081 var defaultParserSet
= false; // attempt to auto-detect x value type
3082 var expectedCols
= this.attr_("labels").length
;
3083 var outOfOrder
= false;
3084 for (var i
= start
; i
< lines
.length
; i
++) {
3085 var line
= lines
[i
];
3087 if (line
.length
=== 0) continue; // skip blank lines
3088 if (line
[0] == '#') continue; // skip comment lines
3089 var inFields
= line
.split(delim
);
3090 if (inFields
.length
< 2) continue;
3093 if (!defaultParserSet
) {
3094 this.detectTypeFromString_(inFields
[0]);
3095 xParser
= this.getFunctionOption("xValueParser");
3096 defaultParserSet
= true;
3098 fields
[0] = xParser(inFields
[0], this);
3100 // If fractions are expected, parse the numbers as "A/B
"
3101 if (this.fractions_) {
3102 for (j = 1; j < inFields.length; j++) {
3103 // TODO(danvk): figure out an appropriate way to flag parse errors.
3104 vals = inFields[j].split("/");
3105 if (vals.length != 2) {
3106 console.error('Expected fractional "num
/den
" values in CSV data ' +
3107 "but found a value
'" + inFields[j] + "' on line
" +
3108 (1 + i) + " ('" + line + "') which is not of
this form
.");
3111 fields[j] = [Dygraph.parseFloat_(vals[0], i, line),
3112 Dygraph.parseFloat_(vals[1], i, line)];
3115 } else if (this.getBooleanOption("errorBars
")) {
3116 // If there are error bars, values are (value, stddev) pairs
3117 if (inFields.length % 2 != 1) {
3118 console.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3119 'but line ' + (1 + i) + ' has an odd number of values (' +
3120 (inFields.length - 1) + "): '" + line + "'");
3122 for (j = 1; j < inFields.length; j += 2) {
3123 fields[(j + 1) / 2] = [Dygraph.parseFloat_(inFields[j], i, line),
3124 Dygraph.parseFloat_(inFields[j + 1], i, line)];
3126 } else if (this.getBooleanOption("customBars
")) {
3127 // Bars are a low;center;high tuple
3128 for (j = 1; j < inFields.length; j++) {
3129 var val = inFields[j];
3130 if (/^ *$/.test(val)) {
3131 fields[j] = [null, null, null];
3133 vals = val.split(";");
3134 if (vals.length == 3) {
3135 fields[j] = [ Dygraph.parseFloat_(vals[0], i, line),
3136 Dygraph.parseFloat_(vals[1], i, line),
3137 Dygraph.parseFloat_(vals[2], i, line) ];
3139 console.warn('When using customBars, values must be either blank ' +
3140 'or "low
;center
;high
" tuples (got "' + val +
3141 '" on line ' + (1+i));
3146 // Values are just numbers
3147 for (j = 1; j < inFields.length; j++) {
3148 fields[j] = Dygraph.parseFloat_(inFields[j], i, line);
3151 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3155 if (fields.length != expectedCols) {
3156 console.error("Number of columns
in line
" + i + " (" + fields.length +
3157 ") does not agree
with number of
labels (" + expectedCols +
3161 // If the user specified the 'labels' option and none of the cells of the
3162 // first row parsed correctly, then they probably double-specified the
3163 // labels. We go with the values set in the option, discard this row and
3164 // log a warning to the JS console.
3165 if (i === 0 && this.attr_('labels')) {
3166 var all_null = true;
3167 for (j = 0; all_null && j < fields.length; j++) {
3168 if (fields[j]) all_null = false;
3171 console.warn("The dygraphs
'labels' option is set
, but the first row
" +
3172 "of CSV
data ('" + line + "') appears to also contain
" +
3173 "labels
. Will drop the CSV labels and
use the option
" +
3182 console.warn("CSV is out of order
; order it correctly to speed loading
.");
3183 ret.sort(function(a,b) { return a[0] - b[0]; });
3190 * The user has provided their data as a pre-packaged JS array. If the x values
3191 * are numeric, this is the same as dygraphs' internal format. If the x values
3192 * are dates, we need to convert them from Date objects to ms since epoch.
3193 * @param {!Array} data
3194 * @return {Object} data with numeric x values.
3197 Dygraph.prototype.parseArray_ = function(data) {
3198 // Peek at the first x value to see if it's numeric.
3199 if (data.length === 0) {
3200 console.error("Can
't plot empty data set");
3203 if (data[0].length === 0) {
3204 console.error("Data set cannot contain an empty row");
3209 if (this.attr_("labels") === null) {
3210 console.warn("Using default labels. Set labels explicitly via 'labels
' " +
3211 "in the options parameter");
3212 this.attrs_.labels = [ "X" ];
3213 for (i = 1; i < data[0].length; i++) {
3214 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3216 this.attributes_.reparseSeries();
3218 var num_labels = this.attr_("labels");
3219 if (num_labels.length != data[0].length) {
3220 console.error("Mismatch between number of labels (" + num_labels + ")" +
3221 " and number of columns in array (" + data[0].length + ")");
3226 if (Dygraph.isDateLike(data[0][0])) {
3227 // Some intelligent defaults for a date x-axis.
3228 this.attrs_.axes.x.valueFormatter = Dygraph.dateValueFormatter;
3229 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3230 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisLabelFormatter;
3232 // Assume they're all dates
.
3233 var parsedData
= Dygraph
.clone(data
);
3234 for (i
= 0; i
< data
.length
; i
++) {
3235 if (parsedData
[i
].length
=== 0) {
3236 console
.error("Row " + (1 + i
) + " of data is empty");
3239 if (parsedData
[i
][0] === null ||
3240 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3241 isNaN(parsedData
[i
][0].getTime())) {
3242 console
.error("x value in row " + (1 + i
) + " is not a Date");
3245 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3249 // Some intelligent defaults for a numeric x-axis.
3250 /** @private (shut up, jsdoc!) */
3251 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3252 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3253 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3259 * Parses a DataTable object from gviz.
3260 * The data is expected to have a first column that is either a date or a
3261 * number. All subsequent columns must be numbers. If there is a clear mismatch
3262 * between this.xValueParser_ and the type of the first column, it will be
3263 * fixed. Fills out rawData_.
3264 * @param {!google.visualization.DataTable} data See above.
3267 Dygraph
.prototype.parseDataTable_
= function(data
) {
3268 var shortTextForAnnotationNum
= function(num
) {
3269 // converts [0-9]+ [A-Z][a-z]*
3270 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3271 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3272 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3273 num
= Math
.floor(num
/ 26);
3275 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3276 num
= Math
.floor((num
- 1) / 26);
3281 var cols
= data
.getNumberOfColumns();
3282 var rows
= data
.getNumberOfRows();
3284 var indepType
= data
.getColumnType(0);
3285 if (indepType
== 'date' || indepType
== 'datetime') {
3286 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3287 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateValueFormatter
;
3288 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3289 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisLabelFormatter
;
3290 } else if (indepType
== 'number') {
3291 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3292 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3293 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericTicks
;
3294 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3296 console
.error("only 'date', 'datetime' and 'number' types are supported " +
3297 "for column 1 of DataTable input (Got '" + indepType
+ "')");
3301 // Array of the column indices which contain data (and not annotations).
3303 var annotationCols
= {}; // data index -> [annotation cols]
3304 var hasAnnotations
= false;
3306 for (i
= 1; i
< cols
; i
++) {
3307 var type
= data
.getColumnType(i
);
3308 if (type
== 'number') {
3310 } else if (type
== 'string' && this.getBooleanOption('displayAnnotations')) {
3311 // This is OK -- it's an annotation column.
3312 var dataIdx
= colIdx
[colIdx
.length
- 1];
3313 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3314 annotationCols
[dataIdx
] = [i
];
3316 annotationCols
[dataIdx
].push(i
);
3318 hasAnnotations
= true;
3320 console
.error("Only 'number' is supported as a dependent type with Gviz." +
3321 " 'string' is only supported if displayAnnotations is true");
3325 // Read column labels
3326 // TODO(danvk): add support back for errorBars
3327 var labels
= [data
.getColumnLabel(0)];
3328 for (i
= 0; i
< colIdx
.length
; i
++) {
3329 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3330 if (this.getBooleanOption("errorBars")) i
+= 1;
3332 this.attrs_
.labels
= labels
;
3333 cols
= labels
.length
;
3336 var outOfOrder
= false;
3337 var annotations
= [];
3338 for (i
= 0; i
< rows
; i
++) {
3340 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3341 data
.getValue(i
, 0) === null) {
3342 console
.warn("Ignoring row " + i
+
3343 " of DataTable because of undefined or null first column.");
3347 if (indepType
== 'date' || indepType
== 'datetime') {
3348 row
.push(data
.getValue(i
, 0).getTime());
3350 row
.push(data
.getValue(i
, 0));
3352 if (!this.getBooleanOption("errorBars")) {
3353 for (j
= 0; j
< colIdx
.length
; j
++) {
3354 var col
= colIdx
[j
];
3355 row
.push(data
.getValue(i
, col
));
3356 if (hasAnnotations
&&
3357 annotationCols
.hasOwnProperty(col
) &&
3358 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3360 ann
.series
= data
.getColumnLabel(col
);
3362 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3364 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3365 if (k
) ann
.text
+= "\n";
3366 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3368 annotations
.push(ann
);
3372 // Strip out infinities, which give dygraphs problems later on.
3373 for (j
= 0; j
< row
.length
; j
++) {
3374 if (!isFinite(row
[j
])) row
[j
] = null;
3377 for (j
= 0; j
< cols
- 1; j
++) {
3378 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3381 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3388 console
.warn("DataTable is out of order; order it correctly to speed loading.");
3389 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3391 this.rawData_
= ret
;
3393 if (annotations
.length
> 0) {
3394 this.setAnnotations(annotations
, true);
3396 this.attributes_
.reparseSeries();
3400 * Signals to plugins that the chart data has updated.
3401 * This happens after the data has updated but before the chart has redrawn.
3403 Dygraph
.prototype.cascadeDataDidUpdateEvent_
= function() {
3404 // TODO(danvk): there are some issues checking xAxisRange() and using
3405 // toDomCoords from handlers of this event. The visible range should be set
3406 // when the chart is drawn, not derived from the data.
3407 this.cascadeEvents_('dataDidUpdate', {});
3411 * Get the CSV data. If it's in a function, call that function. If it's in a
3412 * file, do an XMLHttpRequest to get it.
3415 Dygraph
.prototype.start_
= function() {
3416 var data
= this.file_
;
3418 // Functions can return references of all other types.
3419 if (typeof data
== 'function') {
3423 if (Dygraph
.isArrayLike(data
)) {
3424 this.rawData_
= this.parseArray_(data
);
3425 this.cascadeDataDidUpdateEvent_();
3427 } else if (typeof data
== 'object' &&
3428 typeof data
.getColumnRange
== 'function') {
3429 // must be a DataTable from gviz.
3430 this.parseDataTable_(data
);
3431 this.cascadeDataDidUpdateEvent_();
3433 } else if (typeof data
== 'string') {
3434 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3435 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3436 if (line_delimiter
) {
3437 this.loadedEvent_(data
);
3441 if (window
.XMLHttpRequest
) {
3442 // Firefox, Opera, IE7, and other browsers will use the native object
3443 req
= new XMLHttpRequest();
3445 // IE 5 and 6 will use the ActiveX control
3446 req
= new ActiveXObject("Microsoft.XMLHTTP");
3450 req
.onreadystatechange
= function () {
3451 if (req
.readyState
== 4) {
3452 if (req
.status
=== 200 || // Normal http
3453 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3454 caller
.loadedEvent_(req
.responseText
);
3459 req
.open("GET", data
, true);
3463 console
.error("Unknown data format: " + (typeof data
));
3468 * Changes various properties of the graph. These can include:
3470 * <li>file: changes the source data for the graph</li>
3471 * <li>errorBars: changes whether the data contains stddev</li>
3474 * There's a huge variety of options that can be passed to this method. For a
3475 * full list, see http://dygraphs.com/options.html.
3477 * @param {Object} input_attrs The new properties and values
3478 * @param {boolean} block_redraw Usually the chart is redrawn after every
3479 * call to updateOptions(). If you know better, you can pass true to
3480 * explicitly block the redraw. This can be useful for chaining
3481 * updateOptions() calls, avoiding the occasional infinite loop and
3482 * preventing redraws when it's not necessary (e.g. when updating a
3485 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3486 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3488 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3489 var file
= input_attrs
.file
;
3490 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3492 // TODO(danvk): this is a mess. Move these options into attr_.
3493 if ('rollPeriod' in attrs
) {
3494 this.rollPeriod_
= attrs
.rollPeriod
;
3496 if ('dateWindow' in attrs
) {
3497 this.dateWindow_
= attrs
.dateWindow
;
3498 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3499 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3502 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3503 this.zoomed_y_
= (attrs
.valueRange
!== null);
3506 // TODO(danvk): validate per-series options.
3511 // highlightCircleSize
3513 // Check if this set options will require new points.
3514 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3516 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3518 this.attributes_
.reparseSeries();
3521 // This event indicates that the data is about to change, but hasn't yet.
3522 // TODO(danvk): support cancelation of the update via this event.
3523 this.cascadeEvents_('dataWillUpdate', {});
3526 if (!block_redraw
) this.start_();
3528 if (!block_redraw
) {
3529 if (requiresNewPoints
) {
3532 this.renderGraph_(false);
3539 * Returns a copy of the options with deprecated names converted into current
3540 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3541 * interested in that, they should save a copy before calling this.
3544 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3546 for (var k
in attrs
) {
3547 if (k
== 'file') continue;
3548 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3551 var set
= function(axis
, opt
, value
) {
3552 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3553 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3554 my_attrs
.axes
[axis
][opt
] = value
;
3556 var map
= function(opt
, axis
, new_opt
) {
3557 if (typeof(attrs
[opt
]) != 'undefined') {
3558 console
.warn("Option " + opt
+ " is deprecated. Use the " +
3559 new_opt
+ " option for the " + axis
+ " axis instead. " +
3560 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3561 "(see http://dygraphs.com/per-axis.html for more information.");
3562 set(axis
, new_opt
, attrs
[opt
]);
3563 delete my_attrs
[opt
];
3567 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3568 map('xValueFormatter', 'x', 'valueFormatter');
3569 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3570 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3571 map('xTicker', 'x', 'ticker');
3572 map('yValueFormatter', 'y', 'valueFormatter');
3573 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3574 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3575 map('yTicker', 'y', 'ticker');
3576 map('drawXGrid', 'x', 'drawGrid');
3577 map('drawXAxis', 'x', 'drawAxis');
3578 map('drawYGrid', 'y', 'drawGrid');
3579 map('drawYAxis', 'y', 'drawAxis');
3584 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3585 * containing div (which has presumably changed size since the dygraph was
3586 * instantiated. If the width/height are specified, the div will be resized.
3588 * This is far more efficient than destroying and re-instantiating a
3589 * Dygraph, since it doesn't have to reparse the underlying data.
3591 * @param {number} width Width (in pixels)
3592 * @param {number} height Height (in pixels)
3594 Dygraph
.prototype.resize
= function(width
, height
) {
3595 if (this.resize_lock
) {
3598 this.resize_lock
= true;
3600 if ((width
=== null) != (height
=== null)) {
3601 console
.warn("Dygraph.resize() should be called with zero parameters or " +
3602 "two non-NULL parameters. Pretending it was zero.");
3603 width
= height
= null;
3606 var old_width
= this.width_
;
3607 var old_height
= this.height_
;
3610 this.maindiv_
.style
.width
= width
+ "px";
3611 this.maindiv_
.style
.height
= height
+ "px";
3612 this.width_
= width
;
3613 this.height_
= height
;
3615 this.width_
= this.maindiv_
.clientWidth
;
3616 this.height_
= this.maindiv_
.clientHeight
;
3619 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3620 // Resizing a canvas erases it, even when the size doesn't change, so
3621 // any resize needs to be followed by a redraw.
3622 this.resizeElements_();
3626 this.resize_lock
= false;
3630 * Adjusts the number of points in the rolling average. Updates the graph to
3631 * reflect the new averaging period.
3632 * @param {number} length Number of points over which to average the data.
3634 Dygraph
.prototype.adjustRoll
= function(length
) {
3635 this.rollPeriod_
= length
;
3640 * Returns a boolean array of visibility statuses.
3642 Dygraph
.prototype.visibility
= function() {
3643 // Do lazy-initialization, so that this happens after we know the number of
3645 if (!this.getOption("visibility")) {
3646 this.attrs_
.visibility
= [];
3648 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3649 while (this.getOption("visibility").length
< this.numColumns() - 1) {
3650 this.attrs_
.visibility
.push(true);
3652 return this.getOption("visibility");
3656 * Changes the visiblity of a series.
3658 * @param {number} num the series index
3659 * @param {boolean} value true or false, identifying the visibility.
3661 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3662 var x
= this.visibility();
3663 if (num
< 0 || num
>= x
.length
) {
3664 console
.warn("invalid series number in setVisibility: " + num
);
3672 * How large of an area will the dygraph render itself in?
3673 * This is used for testing.
3674 * @return A {width: w, height: h} object.
3677 Dygraph
.prototype.size
= function() {
3678 return { width
: this.width_
, height
: this.height_
};
3682 * Update the list of annotations and redraw the chart.
3683 * See dygraphs.com/annotations.html for more info on how to use annotations.
3684 * @param ann {Array} An array of annotation objects.
3685 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3687 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3688 // Only add the annotation CSS rule once we know it will be used.
3689 Dygraph
.addAnnotationRule();
3690 this.annotations_
= ann
;
3691 if (!this.layout_
) {
3692 console
.warn("Tried to setAnnotations before dygraph was ready. " +
3693 "Try setting them in a ready() block. See " +
3694 "dygraphs.com/tests/annotation.html");
3698 this.layout_
.setAnnotations(this.annotations_
);
3699 if (!suppressDraw
) {
3705 * Return the list of annotations.
3707 Dygraph
.prototype.annotations
= function() {
3708 return this.annotations_
;
3712 * Get the list of label names for this graph. The first column is the
3713 * x-axis, so the data series names start at index 1.
3715 * Returns null when labels have not yet been defined.
3717 Dygraph
.prototype.getLabels
= function() {
3718 var labels
= this.attr_("labels");
3719 return labels
? labels
.slice() : null;
3723 * Get the index of a series (column) given its name. The first column is the
3724 * x-axis, so the data series start with index 1.
3726 Dygraph
.prototype.indexFromSetName
= function(name
) {
3727 return this.setIndexByName_
[name
];
3731 * Trigger a callback when the dygraph has drawn itself and is ready to be
3732 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3733 * data (i.e. a URL is passed as the data source) and the chart is drawn
3734 * asynchronously. If the chart has already drawn, the callback will fire
3737 * This is a good place to call setAnnotation().
3739 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3742 Dygraph
.prototype.ready
= function(callback
) {
3743 if (this.is_initial_draw_
) {
3744 this.readyFns_
.push(callback
);
3746 callback
.call(this, this);
3752 * Adds a default style for the annotation CSS classes to the document. This is
3753 * only executed when annotations are actually used. It is designed to only be
3754 * called once -- all calls after the first will return immediately.
3756 Dygraph
.addAnnotationRule
= function() {
3757 // TODO(danvk): move this function into plugins/annotations.js
?
3758 if (Dygraph
.addedAnnotationCSS
) return;
3760 var rule
= "border: 1px solid black; " +
3761 "background-color: white; " +
3762 "text-align: center;";
3764 var styleSheetElement
= document
.createElement("style");
3765 styleSheetElement
.type
= "text/css";
3766 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3768 // Find the first style sheet that we can access.
3769 // We may not add a rule to a style sheet from another domain for security
3770 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3771 // adds its own style sheets from google.com.
3772 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3773 if (document
.styleSheets
[i
].disabled
) continue;
3774 var mysheet
= document
.styleSheets
[i
];
3776 if (mysheet
.insertRule
) { // Firefox
3777 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3778 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3779 } else if (mysheet
.addRule
) { // IE
3780 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3782 Dygraph
.addedAnnotationCSS
= true;
3785 // Was likely a security exception.
3789 console
.warn("Unable to add default annotation CSS rule; display may be off.");