3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 // These have to go above the "Hack for IE" in __init__ since .ready() can be
66 // called as soon as the constructor returns. Once support for OldIE is
67 // dropped, this can go down with the rest of the initializers.
68 this.is_initial_draw_
= true;
71 if (opt_fourth_param
!== undefined
) {
72 // Old versions of dygraphs took in the series labels as a constructor
73 // parameter. This doesn't make sense anymore, but it's easy to continue
74 // to support this usage.
75 this.warn("Using deprecated four-argument dygraph constructor");
76 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
78 this.__init__(div
, data
, opts
);
82 Dygraph
.NAME
= "Dygraph";
83 Dygraph
.VERSION
= "1.0.1";
84 Dygraph
.__repr__
= function() {
85 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
89 * Returns information about the Dygraph class.
91 Dygraph
.toString
= function() {
92 return this.__repr__();
95 // Various default values
96 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
97 Dygraph
.DEFAULT_WIDTH
= 480;
98 Dygraph
.DEFAULT_HEIGHT
= 320;
100 // For max 60 Hz. animation:
101 Dygraph
.ANIMATION_STEPS
= 12;
102 Dygraph
.ANIMATION_DURATION
= 200;
104 // Label constants for the labelsKMB and labelsKMG2 options.
105 // (i.e. '100000' -> '100K')
106 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
107 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
108 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
110 // These are defined before DEFAULT_ATTRS so that it can refer to them.
113 * Return a string version of a number. This respects the digitsAfterDecimal
114 * and maxNumberWidth options.
115 * @param {Number} x The number to be formatted
116 * @param {Dygraph} opts An options view
117 * @param {String} name The name of the point's data series
118 * @param {Dygraph} g The dygraph object
120 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
121 var sigFigs
= opts('sigFigs');
123 if (sigFigs
!== null) {
124 // User has opted for a fixed number of significant figures.
125 return Dygraph
.floatFormat(x
, sigFigs
);
128 var digits
= opts('digitsAfterDecimal');
129 var maxNumberWidth
= opts('maxNumberWidth');
131 var kmb
= opts('labelsKMB');
132 var kmg2
= opts('labelsKMG2');
136 // switch to scientific notation if we underflow or overflow fixed display.
138 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
139 Math
.abs(x
) < Math
.pow(10, -digits
))) {
140 label
= x
.toExponential(digits
);
142 label
= '' + Dygraph
.round_(x
, digits
);
151 k_labels
= Dygraph
.KMB_LABELS
;
154 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
156 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
157 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
160 var absx
= Math
.abs(x
);
161 var n
= Dygraph
.pow(k
, k_labels
.length
);
162 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
164 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
169 // TODO(danvk): clean up this logic. Why so different than kmb?
170 var x_parts
= String(x
.toExponential()).split('e-');
171 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
172 if (x_parts
[1] % 3 > 0) {
173 label
= Dygraph
.round_(x_parts
[0] /
174 Dygraph
.pow(10, (x_parts
[1] % 3)),
177 label
= Number(x_parts
[0]).toFixed(2);
179 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
188 * variant for use as an axisLabelFormatter.
191 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
192 return Dygraph
.numberValueFormatter(x
, opts
, g
);
196 * Convert a JS date (millis since epoch) to YYYY/MM/DD
197 * @param {Number} date The JavaScript date (ms since epoch)
198 * @return {String} A date of the form "YYYY/MM/DD"
201 Dygraph
.dateString_
= function(date
) {
202 var zeropad
= Dygraph
.zeropad
;
203 var d
= new Date(date
);
206 var year
= "" + d
.getFullYear();
207 // Get a 0 padded month string
208 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
209 // Get a 0 padded day string
210 var day
= zeropad(d
.getDate());
213 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
214 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
216 return year
+ "/" + month + "/" + day
+ ret
;
220 * Convert a JS date to a string appropriate to display on an axis that
221 * is displaying values at the stated granularity.
222 * @param {Date} date The date to format
223 * @param {Number} granularity One of the Dygraph granularity constants
224 * @return {String} The formatted date
227 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
228 if (granularity
>= Dygraph
.DECADAL
) {
229 return date
.strftime('%Y');
230 } else if (granularity
>= Dygraph
.MONTHLY
) {
231 return date
.strftime('%b %y');
233 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
234 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
235 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
237 return Dygraph
.hmsString_(date
.getTime());
243 * Standard plotters. These may be used by clients.
244 * Available plotters are:
245 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
246 * - Dygraph.Plotters.errorPlotter: draws error bars
247 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
249 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
250 * This causes all the lines to be drawn over all the fills/error bars.
252 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
255 // Default attribute values.
256 Dygraph
.DEFAULT_ATTRS
= {
257 highlightCircleSize
: 3,
258 highlightSeriesOpts
: null,
259 highlightSeriesBackgroundAlpha
: 0.5,
263 // TODO(danvk): move defaults from createStatusMessage_ here.
265 labelsSeparateLines
: false,
266 labelsShowZeroValues
: true,
269 showLabelsOnHighlight
: true,
271 digitsAfterDecimal
: 2,
276 strokeBorderWidth
: 0,
277 strokeBorderColor
: "white",
280 axisLabelFontSize
: 14,
286 xValueParser
: Dygraph
.dateParser
,
293 wilsonInterval
: true, // only relevant if fractions is true
297 connectSeparatedPoints
: false,
300 stackedGraphNaNFill
: 'all',
301 hideOverlayOnMouseOut
: true,
303 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
304 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
310 drawAxesAtZero
: false,
312 // Sizes of the various chart labels.
319 axisLineColor
: "black",
322 axisLabelColor
: "black",
323 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
327 gridLineColor
: "rgb(128,128,128)",
329 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
330 animatedZooms
: false, // (for now)
332 // Range selector options
333 showRangeSelector
: false,
334 rangeSelectorHeight
: 40,
335 rangeSelectorPlotStrokeColor
: "#808FAB",
336 rangeSelectorPlotFillColor
: "#A7B1C4",
338 // The ordering here ensures that central lines always appear above any
339 // fill bars/error bars
.
341 Dygraph
.Plotters
.fillPlotter
,
342 Dygraph
.Plotters
.errorPlotter
,
343 Dygraph
.Plotters
.linePlotter
352 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
353 valueFormatter
: Dygraph
.dateString_
,
356 independentTicks
: true,
357 ticker
: null // will be set in dygraph-tickers.js
361 valueFormatter
: Dygraph
.numberValueFormatter
,
362 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
365 independentTicks
: true,
366 ticker
: null // will be set in dygraph-tickers.js
370 valueFormatter
: Dygraph
.numberValueFormatter
,
371 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
374 independentTicks
: false,
375 ticker
: null // will be set in dygraph-tickers.js
380 // Directions for panning and zooming. Use bit operations when combined
381 // values are possible.
382 Dygraph
.HORIZONTAL
= 1;
383 Dygraph
.VERTICAL
= 2;
385 // Installed plugins, in order of precedence (most-general to most-specific).
386 // Plugins are installed after they are defined, in plugins/install.js
.
390 // Used for initializing annotation CSS rules only once.
391 Dygraph
.addedAnnotationCSS
= false;
393 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
394 // Labels is no longer a constructor parameter, since it's typically set
395 // directly from the data source. It also conains a name for the x-axis,
396 // which the previous constructor form did not.
397 if (labels
!== null) {
398 var new_labels
= ["Date"];
399 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
400 Dygraph
.update(attrs
, { 'labels': new_labels
});
402 this.__init__(div
, file
, attrs
);
406 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
407 * and context <canvas> inside of it. See the constructor for details.
409 * @param {Element} div the Element to render the graph into.
410 * @param {String | Function} file Source data
411 * @param {Object} attrs Miscellaneous other options
414 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
415 // Hack for IE: if we're using excanvas and the document hasn't finished
416 // loading yet (and hence may not have initialized whatever it needs to
417 // initialize), then keep calling this routine periodically until it has.
418 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
419 typeof(G_vmlCanvasManager
) != 'undefined' &&
420 document
.readyState
!= 'complete') {
422 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
426 // Support two-argument constructor
427 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
429 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
431 if (typeof(div
) == 'string') {
432 div
= document
.getElementById(div
);
436 Dygraph
.error("Constructing dygraph with a non-existent div!");
440 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
442 // Copy the important bits into the object
443 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
446 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
447 this.previousVerticalX_
= -1;
448 this.fractions_
= attrs
.fractions
|| false;
449 this.dateWindow_
= attrs
.dateWindow
|| null;
451 this.annotations_
= [];
453 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
454 this.zoomed_x_
= false;
455 this.zoomed_y_
= false;
457 // Clear the div. This ensure that, if multiple dygraphs are passed the same
458 // div, then only one will be drawn.
461 // For historical reasons, the 'width' and 'height' options trump all CSS
462 // rules _except_ for an explicit 'width' or 'height' on the div.
463 // As an added convenience, if the div has zero height (like <div></div> does
464 // without any styles), then we use a default height/width
.
465 if (div
.style
.width
=== '' && attrs
.width
) {
466 div
.style
.width
= attrs
.width
+ "px";
468 if (div
.style
.height
=== '' && attrs
.height
) {
469 div
.style
.height
= attrs
.height
+ "px";
471 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
472 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
473 if (div
.style
.width
=== '') {
474 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
477 // These will be zero if the dygraph's div is hidden. In that case,
478 // use the user-specified attributes if present. If not, use zero
479 // and assume the user will call resize to fix things later.
480 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
481 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
483 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
484 if (attrs
.stackedGraph
) {
485 attrs
.fillGraph
= true;
486 // TODO(nikhilk): Add any other stackedGraph checks here.
489 // DEPRECATION WARNING: All option processing should be moved from
490 // attrs_ and user_attrs_ to options_, which holds all this information.
492 // Dygraphs has many options, some of which interact with one another.
493 // To keep track of everything, we maintain two sets of options:
495 // this.user_attrs_ only options explicitly set by the user.
496 // this.attrs_ defaults, options derived from user_attrs_, data.
498 // Options are then accessed this.attr_('attr'), which first looks at
499 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
500 // defaults without overriding behavior that the user specifically asks for.
501 this.user_attrs_
= {};
502 Dygraph
.update(this.user_attrs_
, attrs
);
504 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
506 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
508 this.boundaryIds_
= [];
509 this.setIndexByName_
= {};
510 this.datasetIndex_
= [];
512 this.registeredEvents_
= [];
513 this.eventListeners_
= {};
515 this.attributes_
= new DygraphOptions(this);
517 // Create the containing DIV and other interactive elements
518 this.createInterface_();
522 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
523 for (var i
= 0; i
< plugins
.length
; i
++) {
524 var Plugin
= plugins
[i
];
525 var pluginInstance
= new Plugin();
527 plugin
: pluginInstance
,
533 var handlers
= pluginInstance
.activate(this);
534 for (var eventName
in handlers
) {
535 // TODO(danvk): validate eventName.
536 pluginDict
.events
[eventName
] = handlers
[eventName
];
539 this.plugins_
.push(pluginDict
);
542 // At this point, plugins can no longer register event handlers.
543 // Construct a map from event -> ordered list of [callback, plugin].
544 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
545 var plugin_dict
= this.plugins_
[i
];
546 for (var eventName
in plugin_dict
.events
) {
547 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
548 var callback
= plugin_dict
.events
[eventName
];
550 var pair
= [plugin_dict
.plugin
, callback
];
551 if (!(eventName
in this.eventListeners_
)) {
552 this.eventListeners_
[eventName
] = [pair
];
554 this.eventListeners_
[eventName
].push(pair
);
559 this.createDragInterface_();
565 * Triggers a cascade of events to the various plugins which are interested in them.
566 * Returns true if the "default behavior" should be performed, i.e. if none of
567 * the event listeners called event.preventDefault().
570 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
571 if (!(name
in this.eventListeners_
)) return true;
573 // QUESTION: can we use objects & prototypes to speed this up?
577 defaultPrevented
: false,
578 preventDefault
: function() {
579 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
580 e
.defaultPrevented
= true;
582 propagationStopped
: false,
583 stopPropagation
: function() {
584 e
.propagationStopped
= true;
587 Dygraph
.update(e
, extra_props
);
589 var callback_plugin_pairs
= this.eventListeners_
[name
];
590 if (callback_plugin_pairs
) {
591 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
592 var plugin
= callback_plugin_pairs
[i
][0];
593 var callback
= callback_plugin_pairs
[i
][1];
594 callback
.call(plugin
, e
);
595 if (e
.propagationStopped
) break;
598 return e
.defaultPrevented
;
602 * Returns the zoomed status of the chart for one or both axes.
604 * Axis is an optional parameter. Can be set to 'x' or 'y'.
606 * The zoomed status for an axis is set whenever a user zooms using the mouse
607 * or when the dateWindow or valueRange are updated (unless the
608 * isZoomedIgnoreProgrammaticZoom option is also specified).
610 Dygraph
.prototype.isZoomed
= function(axis
) {
611 if (axis
=== null || axis
=== undefined
) {
612 return this.zoomed_x_
|| this.zoomed_y_
;
614 if (axis
=== 'x') return this.zoomed_x_
;
615 if (axis
=== 'y') return this.zoomed_y_
;
616 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
620 * Returns information about the Dygraph object, including its containing ID.
622 Dygraph
.prototype.toString
= function() {
623 var maindiv
= this.maindiv_
;
624 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
625 return "[Dygraph " + id
+ "]";
630 * Returns the value of an option. This may be set by the user (either in the
631 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
633 * @param { String } name The name of the option, e.g. 'rollPeriod'.
634 * @param { String } [seriesName] The name of the series to which the option
635 * will be applied. If no per-series value of this option is available, then
636 * the global value is returned. This is optional.
637 * @return { ... } The value of the option.
639 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
640 // <REMOVE_FOR_COMBINED>
641 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
642 this.error('Must include options reference JS for testing');
643 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
644 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
645 'in the Dygraphs.OPTIONS_REFERENCE listing.');
646 // Only log this error once.
647 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
649 // </REMOVE_FOR_COMBINED
>
650 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
654 * Returns the current value for an option, as set in the constructor or via
655 * updateOptions. You may pass in an (optional) series name to get per-series
656 * values for the option.
658 * All values returned by this method should be considered immutable. If you
659 * modify them, there is no guarantee that the changes will be honored or that
660 * dygraphs will remain in a consistent state. If you want to modify an option,
661 * use updateOptions() instead.
663 * @param { String } name The name of the option (e.g. 'strokeWidth')
664 * @param { String } [opt_seriesName] Series name to get per-series values.
665 * @return { ... } The value of the option.
667 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
668 return this.attr_(name
, opt_seriesName
);
671 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
672 return this.attributes_
.getForAxis(name
, axis
);
677 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
678 * @return { ... } A function mapping string -> option value
680 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
682 return function(opt
) {
683 var axis_opts
= self
.user_attrs_
.axes
;
684 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
685 return axis_opts
[axis
][opt
];
687 // user-specified attributes always trump defaults, even if they're less
689 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
690 return self
.user_attrs_
[opt
];
693 axis_opts
= self
.attrs_
.axes
;
694 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
695 return axis_opts
[axis
][opt
];
697 // check old-style axis options
698 // TODO(danvk): add a deprecation warning if either of these match.
699 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
700 return self
.axes_
[0][opt
];
701 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
702 return self
.axes_
[1][opt
];
704 return self
.attr_(opt
);
709 * Returns the current rolling period, as set by the user or an option.
710 * @return {Number} The number of points in the rolling window
712 Dygraph
.prototype.rollPeriod
= function() {
713 return this.rollPeriod_
;
717 * Returns the currently-visible x-range. This can be affected by zooming,
718 * panning or a call to updateOptions.
719 * Returns a two-element array: [left, right].
720 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
722 Dygraph
.prototype.xAxisRange
= function() {
723 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
727 * Returns the lower- and upper-bound x-axis values of the
730 Dygraph
.prototype.xAxisExtremes
= function() {
731 var pad
= this.attr_('xRangePad') / this.plotter_
.area
.w
;
732 if (this.numRows() === 0) {
733 return [0 - pad
, 1 + pad
];
735 var left
= this.rawData_
[0][0];
736 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
738 // Must keep this in sync with dygraph-layout _evaluateLimits()
739 var range
= right
- left
;
741 right
+= range
* pad
;
743 return [left
, right
];
747 * Returns the currently-visible y-range for an axis. This can be affected by
748 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
749 * called with no arguments, returns the range of the first axis.
750 * Returns a two-element array: [bottom, top].
752 Dygraph
.prototype.yAxisRange
= function(idx
) {
753 if (typeof(idx
) == "undefined") idx
= 0;
754 if (idx
< 0 || idx
>= this.axes_
.length
) {
757 var axis
= this.axes_
[idx
];
758 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
762 * Returns the currently-visible y-ranges for each axis. This can be affected by
763 * zooming, panning, calls to updateOptions, etc.
764 * Returns an array of [bottom, top] pairs, one for each y-axis.
766 Dygraph
.prototype.yAxisRanges
= function() {
768 for (var i
= 0; i
< this.axes_
.length
; i
++) {
769 ret
.push(this.yAxisRange(i
));
774 // TODO(danvk): use these functions throughout dygraphs.
776 * Convert from data coordinates to canvas/div X/Y coordinates.
777 * If specified, do this conversion for the coordinate system of a particular
778 * axis. Uses the first axis by default.
779 * Returns a two-element array: [X, Y]
781 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
782 * instead of toDomCoords(null, y, axis).
784 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
785 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
789 * Convert from data x coordinates to canvas/div X coordinate.
790 * If specified, do this conversion for the coordinate system of a particular
792 * Returns a single value or null if x is null.
794 Dygraph
.prototype.toDomXCoord
= function(x
) {
799 var area
= this.plotter_
.area
;
800 var xRange
= this.xAxisRange();
801 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
805 * Convert from data x coordinates to canvas/div Y coordinate and optional
806 * axis. Uses the first axis by default.
808 * returns a single value or null if y is null.
810 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
811 var pct
= this.toPercentYCoord(y
, axis
);
816 var area
= this.plotter_
.area
;
817 return area
.y
+ pct
* area
.h
;
821 * Convert from canvas/div coords to data coordinates.
822 * If specified, do this conversion for the coordinate system of a particular
823 * axis. Uses the first axis by default.
824 * Returns a two-element array: [X, Y].
826 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
827 * instead of toDataCoords(null, y, axis).
829 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
830 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
834 * Convert from canvas/div x coordinate to data coordinate.
836 * If x is null, this returns null.
838 Dygraph
.prototype.toDataXCoord
= function(x
) {
843 var area
= this.plotter_
.area
;
844 var xRange
= this.xAxisRange();
845 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
849 * Convert from canvas/div y coord to value.
851 * If y is null, this returns null.
852 * if axis is null, this uses the first axis.
854 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
859 var area
= this.plotter_
.area
;
860 var yRange
= this.yAxisRange(axis
);
862 if (typeof(axis
) == "undefined") axis
= 0;
863 if (!this.attributes_
.getForAxis("logscale", axis
)) {
864 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
866 // Computing the inverse of toDomCoord.
867 var pct
= (y
- area
.y
) / area
.h
;
869 // Computing the inverse of toPercentYCoord. The function was arrived at with
870 // the following steps:
872 // Original calcuation:
873 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
875 // Move denominator to both sides:
876 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
878 // subtract logr1, and take the negative value.
879 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
881 // Swap both sides of the equation, and we can compute the log of the
882 // return value. Which means we just need to use that as the exponent in
884 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
886 var logr1
= Dygraph
.log10(yRange
[1]);
887 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
888 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
894 * Converts a y for an axis to a percentage from the top to the
895 * bottom of the drawing area.
897 * If the coordinate represents a value visible on the canvas, then
898 * the value will be between 0 and 1, where 0 is the top of the canvas.
899 * However, this method will return values outside the range, as
900 * values can fall outside the canvas.
902 * If y is null, this returns null.
903 * if axis is null, this uses the first axis.
905 * @param { Number } y The data y-coordinate.
906 * @param { Number } [axis] The axis number on which the data coordinate lives.
907 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
909 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
913 if (typeof(axis
) == "undefined") axis
= 0;
915 var yRange
= this.yAxisRange(axis
);
918 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
920 // yRange[1] - y is unit distance from the bottom.
921 // yRange[1] - yRange[0] is the scale of the range.
922 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
923 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
925 var logr1
= Dygraph
.log10(yRange
[1]);
926 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
932 * Converts an x value to a percentage from the left to the right of
935 * If the coordinate represents a value visible on the canvas, then
936 * the value will be between 0 and 1, where 0 is the left of the canvas.
937 * However, this method will return values outside the range, as
938 * values can fall outside the canvas.
940 * If x is null, this returns null.
941 * @param { Number } x The data x-coordinate.
942 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
944 Dygraph
.prototype.toPercentXCoord
= function(x
) {
949 var xRange
= this.xAxisRange();
950 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
954 * Returns the number of columns (including the independent variable).
955 * @return { Integer } The number of columns.
957 Dygraph
.prototype.numColumns
= function() {
958 if (!this.rawData_
) return 0;
959 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
963 * Returns the number of rows (excluding any header/label row).
964 * @return { Integer } The number of rows, less any header.
966 Dygraph
.prototype.numRows
= function() {
967 if (!this.rawData_
) return 0;
968 return this.rawData_
.length
;
972 * Returns the value in the given row and column. If the row and column exceed
973 * the bounds on the data, returns null. Also returns null if the value is
975 * @param { Number} row The row number of the data (0-based). Row 0 is the
976 * first row of data, not a header row.
977 * @param { Number} col The column number of the data (0-based)
978 * @return { Number } The value in the specified cell or null if the row/col
981 Dygraph
.prototype.getValue
= function(row
, col
) {
982 if (row
< 0 || row
> this.rawData_
.length
) return null;
983 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
985 return this.rawData_
[row
][col
];
989 * Generates interface elements for the Dygraph: a containing div, a div to
990 * display the current point, and a textbox to adjust the rolling average
991 * period. Also creates the Renderer/Layout elements.
994 Dygraph
.prototype.createInterface_
= function() {
995 // Create the all-enclosing graph div
996 var enclosing
= this.maindiv_
;
998 this.graphDiv
= document
.createElement("div");
1000 // TODO(danvk): any other styles that are useful to set here?
1001 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
1002 enclosing
.appendChild(this.graphDiv
);
1004 // Create the canvas for interactive parts of the chart.
1005 this.canvas_
= Dygraph
.createCanvas();
1006 this.canvas_
.style
.position
= "absolute";
1008 // ... and for static parts of the chart.
1009 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1011 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1012 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1014 this.resizeElements_();
1016 // The interactive parts of the graph are drawn on top of the chart.
1017 this.graphDiv
.appendChild(this.hidden_
);
1018 this.graphDiv
.appendChild(this.canvas_
);
1019 this.mouseEventElement_
= this.createMouseEventElement_();
1021 // Create the grapher
1022 this.layout_
= new DygraphLayout(this);
1026 this.mouseMoveHandler_
= function(e
) {
1027 dygraph
.mouseMove_(e
);
1030 this.mouseOutHandler_
= function(e
) {
1031 // The mouse has left the chart if:
1032 // 1. e.target is inside the chart
1033 // 2. e.relatedTarget is outside the chart
1034 var target
= e
.target
|| e
.fromElement
;
1035 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1036 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1037 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1038 dygraph
.mouseOut_(e
);
1042 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1043 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1045 // Don't recreate and register the resize handler on subsequent calls.
1046 // This happens when the graph is resized.
1047 if (!this.resizeHandler_
) {
1048 this.resizeHandler_
= function(e
) {
1052 // Update when the window is resized.
1053 // TODO(danvk): drop frames depending on complexity of the chart.
1054 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1058 Dygraph
.prototype.resizeElements_
= function() {
1059 this.graphDiv
.style
.width
= this.width_
+ "px";
1060 this.graphDiv
.style
.height
= this.height_
+ "px";
1062 var canvasScale
= Dygraph
.getContextPixelRatio(this.canvas_ctx_
);
1063 this.canvas_
.width
= this.width_
* canvasScale
;
1064 this.canvas_
.height
= this.height_
* canvasScale
;
1065 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1066 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1067 if (canvasScale
!== 1) {
1068 this.canvas_ctx_
.scale(canvasScale
, canvasScale
);
1071 var hiddenScale
= Dygraph
.getContextPixelRatio(this.hidden_ctx_
);
1072 this.hidden_
.width
= this.width_
* hiddenScale
;
1073 this.hidden_
.height
= this.height_
* hiddenScale
;
1074 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1075 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1076 if (hiddenScale
!== 1) {
1077 this.hidden_ctx_
.scale(hiddenScale
, hiddenScale
);
1082 * Detach DOM elements in the dygraph and null out all data references.
1083 * Calling this when you're done with a dygraph can dramatically reduce memory
1084 * usage. See, e.g., the tests/perf.html example.
1086 Dygraph
.prototype.destroy
= function() {
1087 this.canvas_ctx_
.restore();
1088 this.hidden_ctx_
.restore();
1090 var removeRecursive
= function(node
) {
1091 while (node
.hasChildNodes()) {
1092 removeRecursive(node
.firstChild
);
1093 node
.removeChild(node
.firstChild
);
1097 this.removeTrackedEvents_();
1099 // remove mouse event handlers (This may not be necessary anymore)
1100 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1101 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1103 // remove window handlers
1104 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1105 this.resizeHandler_
= null;
1107 removeRecursive(this.maindiv_
);
1109 var nullOut
= function(obj
) {
1110 for (var n
in obj
) {
1111 if (typeof(obj
[n
]) === 'object') {
1116 // These may not all be necessary, but it can't hurt...
1117 nullOut(this.layout_
);
1118 nullOut(this.plotter_
);
1123 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1124 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1125 * or the zoom rectangles) is done on this.canvas_.
1126 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1127 * @return {Object} The newly-created canvas
1130 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1131 var h
= Dygraph
.createCanvas();
1132 h
.style
.position
= "absolute";
1133 // TODO(danvk): h should be offset from canvas. canvas needs to include
1134 // some extra area to make it easier to zoom in on the far left and far
1135 // right. h needs to be precisely the plot area, so that clipping occurs.
1136 h
.style
.top
= canvas
.style
.top
;
1137 h
.style
.left
= canvas
.style
.left
;
1138 h
.width
= this.width_
;
1139 h
.height
= this.height_
;
1140 h
.style
.width
= this.width_
+ "px"; // for IE
1141 h
.style
.height
= this.height_
+ "px"; // for IE
1146 * Creates an overlay element used to handle mouse events.
1147 * @return {Object} The mouse event element.
1150 Dygraph
.prototype.createMouseEventElement_
= function() {
1151 if (this.isUsingExcanvas_
) {
1152 var elem
= document
.createElement("div");
1153 elem
.style
.position
= 'absolute';
1154 elem
.style
.backgroundColor
= 'white';
1155 elem
.style
.filter
= 'alpha(opacity=0)';
1156 elem
.style
.width
= this.width_
+ "px";
1157 elem
.style
.height
= this.height_
+ "px";
1158 this.graphDiv
.appendChild(elem
);
1161 return this.canvas_
;
1166 * Generate a set of distinct colors for the data series. This is done with a
1167 * color wheel. Saturation/Value are customizable, and the hue is
1168 * equally-spaced around the color wheel. If a custom set of colors is
1169 * specified, that is used instead.
1172 Dygraph
.prototype.setColors_
= function() {
1173 var labels
= this.getLabels();
1174 var num
= labels
.length
- 1;
1176 this.colorsMap_
= {};
1178 // These are used for when no custom colors are specified.
1179 var sat
= this.attr_('colorSaturation') || 1.0;
1180 var val
= this.attr_('colorValue') || 0.5;
1181 var half
= Math
.ceil(num
/ 2);
1183 var colors
= this.attr_('colors');
1184 var visibility
= this.visibility();
1185 for (var i
= 0; i
< num
; i
++) {
1186 if (!visibility
[i
]) {
1189 var label
= labels
[i
+ 1];
1190 var colorStr
= this.attributes_
.getForSeries('color', label
);
1193 colorStr
= colors
[i
% colors
.length
];
1195 // alternate colors for high contrast.
1196 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1197 var hue
= (1.0 * idx
/ (1 + num
));
1198 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1201 this.colors_
.push(colorStr
);
1202 this.colorsMap_
[label
] = colorStr
;
1207 * Return the list of colors. This is either the list of colors passed in the
1208 * attributes or the autogenerated list of rgb(r,g,b) strings.
1209 * This does not return colors for invisible series.
1210 * @return {Array<string>} The list of colors.
1212 Dygraph
.prototype.getColors
= function() {
1213 return this.colors_
;
1217 * Returns a few attributes of a series, i.e. its color, its visibility, which
1218 * axis it's assigned to, and its column in the original data.
1219 * Returns null if the series does not exist.
1220 * Otherwise, returns an object with column, visibility, color and axis properties.
1221 * The "axis" property will be set to 1 for y1 and 2 for y2.
1222 * The "column" property can be fed back into getValue(row, column) to get
1223 * values for this series.
1225 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1227 var labels
= this.getLabels();
1228 for (var i
= 1; i
< labels
.length
; i
++) {
1229 if (labels
[i
] == series_name
) {
1234 if (idx
== -1) return null;
1239 visible
: this.visibility()[idx
- 1],
1240 color
: this.colorsMap_
[series_name
],
1241 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1246 * Create the text box to adjust the averaging period
1249 Dygraph
.prototype.createRollInterface_
= function() {
1250 // Create a roller if one doesn't exist already.
1251 if (!this.roller_
) {
1252 this.roller_
= document
.createElement("input");
1253 this.roller_
.type
= "text";
1254 this.roller_
.style
.display
= "none";
1255 this.graphDiv
.appendChild(this.roller_
);
1258 var display
= this.attr_('showRoller') ? 'block' : 'none';
1260 var area
= this.plotter_
.area
;
1261 var textAttr
= { "position": "absolute",
1263 "top": (area
.y
+ area
.h
- 25) + "px",
1264 "left": (area
.x
+ 1) + "px",
1267 this.roller_
.size
= "2";
1268 this.roller_
.value
= this.rollPeriod_
;
1269 for (var name
in textAttr
) {
1270 if (textAttr
.hasOwnProperty(name
)) {
1271 this.roller_
.style
[name
] = textAttr
[name
];
1276 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1281 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1282 * canvas (i.e. DOM Coords).
1284 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1285 return Dygraph
.pageX(e
) - context
.px
;
1290 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1291 * canvas (i.e. DOM Coords).
1293 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1294 return Dygraph
.pageY(e
) - context
.py
;
1298 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1302 Dygraph
.prototype.createDragInterface_
= function() {
1304 // Tracks whether the mouse is down right now
1306 isPanning
: false, // is this drag part of a pan?
1307 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1308 dragStartX
: null, // pixel coordinates
1309 dragStartY
: null, // pixel coordinates
1310 dragEndX
: null, // pixel coordinates
1311 dragEndY
: null, // pixel coordinates
1312 dragDirection
: null,
1313 prevEndX
: null, // pixel coordinates
1314 prevEndY
: null, // pixel coordinates
1315 prevDragDirection
: null,
1316 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1318 // The value on the left side of the graph when a pan operation starts.
1319 initialLeftmostDate
: null,
1321 // The number of units each pixel spans. (This won't be valid for log
1323 xUnitsPerPixel
: null,
1325 // TODO(danvk): update this comment
1326 // The range in second/value units that the viewport encompasses during a
1327 // panning operation.
1330 // Top-left corner of the canvas, in DOM coords
1331 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1335 // Values for use with panEdgeFraction, which limit how far outside the
1336 // graph's data boundaries it can be panned.
1337 boundedDates
: null, // [minDate, maxDate]
1338 boundedValues
: null, // [[minValue, maxValue] ...]
1340 // We cover iframes during mouse interactions. See comments in
1341 // dygraph-utils.js for more info on why this is a good idea.
1342 tarp
: new Dygraph
.IFrameTarp(),
1344 // contextB is the same thing as this context object but renamed.
1345 initializeMouseDown
: function(event
, g
, contextB
) {
1346 // prevents mouse drags from selecting page text.
1347 if (event
.preventDefault
) {
1348 event
.preventDefault(); // Firefox, Chrome, etc.
1350 event
.returnValue
= false; // IE
1351 event
.cancelBubble
= true;
1354 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1355 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1356 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1357 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1358 contextB
.cancelNextDblclick
= false;
1359 contextB
.tarp
.cover();
1363 var interactionModel
= this.attr_("interactionModel");
1365 // Self is the graph.
1368 // Function that binds the graph and context to the handler.
1369 var bindHandler
= function(handler
) {
1370 return function(event
) {
1371 handler(event
, self
, context
);
1375 for (var eventName
in interactionModel
) {
1376 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1377 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1378 bindHandler(interactionModel
[eventName
]));
1381 // If the user releases the mouse button during a drag, but not over the
1382 // canvas, then it doesn't count as a zooming action.
1383 var mouseUpHandler
= function(event
) {
1384 if (context
.isZooming
|| context
.isPanning
) {
1385 context
.isZooming
= false;
1386 context
.dragStartX
= null;
1387 context
.dragStartY
= null;
1390 if (context
.isPanning
) {
1391 context
.isPanning
= false;
1392 context
.draggingDate
= null;
1393 context
.dateRange
= null;
1394 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1395 delete self
.axes_
[i
].draggingValue
;
1396 delete self
.axes_
[i
].dragValueRange
;
1400 context
.tarp
.uncover();
1403 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1407 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1408 * up any previous zoom rectangles that were drawn. This could be optimized to
1409 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1412 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1413 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1414 * @param {Number} startX The X position where the drag started, in canvas
1416 * @param {Number} endX The current X position of the drag, in canvas coords.
1417 * @param {Number} startY The Y position where the drag started, in canvas
1419 * @param {Number} endY The current Y position of the drag, in canvas coords.
1420 * @param {Number} prevDirection the value of direction on the previous call to
1421 * this function. Used to avoid excess redrawing
1422 * @param {Number} prevEndX The value of endX on the previous call to this
1423 * function. Used to avoid excess redrawing
1424 * @param {Number} prevEndY The value of endY on the previous call to this
1425 * function. Used to avoid excess redrawing
1428 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1429 endY
, prevDirection
, prevEndX
,
1431 var ctx
= this.canvas_ctx_
;
1433 // Clean up from the previous rect if necessary
1434 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1435 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1436 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1437 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1438 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1439 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1442 // Draw a light-grey rectangle to show the new viewing area
1443 if (direction
== Dygraph
.HORIZONTAL
) {
1444 if (endX
&& startX
) {
1445 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1446 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1447 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1449 } else if (direction
== Dygraph
.VERTICAL
) {
1450 if (endY
&& startY
) {
1451 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1452 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1453 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1457 if (this.isUsingExcanvas_
) {
1458 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1463 * Clear the zoom rectangle (and perform no zoom).
1466 Dygraph
.prototype.clearZoomRect_
= function() {
1467 this.currentZoomRectArgs_
= null;
1468 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1472 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1473 * the canvas. The exact zoom window may be slightly larger if there are no data
1474 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1475 * which accepts dates that match the raw data. This function redraws the graph.
1477 * @param {Number} lowX The leftmost pixel value that should be visible.
1478 * @param {Number} highX The rightmost pixel value that should be visible.
1481 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1482 this.currentZoomRectArgs_
= null;
1483 // Find the earliest and latest dates contained in this canvasx range.
1484 // Convert the call to date ranges of the raw data.
1485 var minDate
= this.toDataXCoord(lowX
);
1486 var maxDate
= this.toDataXCoord(highX
);
1487 this.doZoomXDates_(minDate
, maxDate
);
1491 * Transition function to use in animations. Returns values between 0.0
1492 * (totally old values) and 1.0 (totally new values) for each frame.
1495 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1497 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1501 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1502 * method with doZoomX which accepts pixel coordinates. This function redraws
1505 * @param {Number} minDate The minimum date that should be visible.
1506 * @param {Number} maxDate The maximum date that should be visible.
1509 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1510 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1511 // can produce strange effects. Rather than the y-axis transitioning slowly
1512 // between values, it can jerk around.)
1513 var old_window
= this.xAxisRange();
1514 var new_window
= [minDate
, maxDate
];
1515 this.zoomed_x_
= true;
1517 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1518 if (that
.attr_("zoomCallback")) {
1519 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1525 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1526 * the canvas. This function redraws the graph.
1528 * @param {Number} lowY The topmost pixel value that should be visible.
1529 * @param {Number} highY The lowest pixel value that should be visible.
1532 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1533 this.currentZoomRectArgs_
= null;
1534 // Find the highest and lowest values in pixel range for each axis.
1535 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1536 // This is because pixels increase as you go down on the screen, whereas data
1537 // coordinates increase as you go up the screen.
1538 var oldValueRanges
= this.yAxisRanges();
1539 var newValueRanges
= [];
1540 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1541 var hi
= this.toDataYCoord(lowY
, i
);
1542 var low
= this.toDataYCoord(highY
, i
);
1543 newValueRanges
.push([low
, hi
]);
1546 this.zoomed_y_
= true;
1548 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1549 if (that
.attr_("zoomCallback")) {
1550 var xRange
= that
.xAxisRange();
1551 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1557 * Reset the zoom to the original view coordinates. This is the same as
1558 * double-clicking on the graph.
1560 Dygraph
.prototype.resetZoom
= function() {
1561 var dirty
= false, dirtyX
= false, dirtyY
= false;
1562 if (this.dateWindow_
!== null) {
1567 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1568 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1574 // Clear any selection, since it's likely to be drawn in the wrong place.
1575 this.clearSelection();
1578 this.zoomed_x_
= false;
1579 this.zoomed_y_
= false;
1581 var minDate
= this.rawData_
[0][0];
1582 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1584 // With only one frame, don't bother calculating extreme ranges.
1585 // TODO(danvk): merge this block w/ the code below
.
1586 if (!this.attr_("animatedZooms")) {
1587 this.dateWindow_
= null;
1588 for (i
= 0; i
< this.axes_
.length
; i
++) {
1589 if (this.axes_
[i
].valueWindow
!== null) {
1590 delete this.axes_
[i
].valueWindow
;
1594 if (this.attr_("zoomCallback")) {
1595 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1600 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1602 oldWindow
= this.xAxisRange();
1603 newWindow
= [minDate
, maxDate
];
1607 oldValueRanges
= this.yAxisRanges();
1608 // TODO(danvk): this is pretty inefficient
1609 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1610 var extremes
= packed
.extremes
;
1612 // this has the side-effect of modifying this.axes_.
1613 // this doesn't make much sense in this context, but it's convenient (we
1614 // need this.axes_[*].extremeValues) and not harmful since we'll be
1615 // calling drawGraph_ shortly, which clobbers these values.
1616 this.computeYAxisRanges_(extremes
);
1618 newValueRanges
= [];
1619 for (i
= 0; i
< this.axes_
.length
; i
++) {
1620 var axis
= this.axes_
[i
];
1621 newValueRanges
.push((axis
.valueRange
!== null &&
1622 axis
.valueRange
!== undefined
) ?
1623 axis
.valueRange
: axis
.extremeRange
);
1628 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1630 that
.dateWindow_
= null;
1631 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1632 if (that
.axes_
[i
].valueWindow
!== null) {
1633 delete that
.axes_
[i
].valueWindow
;
1636 if (that
.attr_("zoomCallback")) {
1637 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1644 * Combined animation logic for all zoom functions.
1645 * either the x parameters or y parameters may be null.
1648 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1649 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1652 var valueRanges
= [];
1655 if (oldXRange
!== null && newXRange
!== null) {
1656 for (step
= 1; step
<= steps
; step
++) {
1657 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1658 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1659 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1663 if (oldYRanges
!== null && newYRanges
!== null) {
1664 for (step
= 1; step
<= steps
; step
++) {
1665 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1667 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1668 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1669 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1671 valueRanges
[step
-1] = thisRange
;
1676 Dygraph
.repeatAndCleanup(function(step
) {
1677 if (valueRanges
.length
) {
1678 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1679 var w
= valueRanges
[step
][i
];
1680 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1683 if (windows
.length
) {
1684 that
.dateWindow_
= windows
[step
];
1687 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1691 * Get the current graph's area object.
1693 * Returns: {x, y, w, h}
1695 Dygraph
.prototype.getArea
= function() {
1696 return this.plotter_
.area
;
1700 * Convert a mouse event to DOM coordinates relative to the graph origin.
1702 * Returns a two-element array: [X, Y].
1704 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1705 if (event
.offsetX
&& event
.offsetY
) {
1706 return [ event
.offsetX
, event
.offsetY
];
1708 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1709 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1710 return [canvasx
, canvasy
];
1715 * Given a canvas X coordinate, find the closest row.
1716 * @param {Number} domX graph-relative DOM X coordinate
1717 * Returns: row number, integer
1720 Dygraph
.prototype.findClosestRow
= function(domX
) {
1721 var minDistX
= Infinity
;
1722 var closestRow
= -1;
1723 var sets
= this.layout_
.points
;
1724 for (var i
= 0; i
< sets
.length
; i
++) {
1725 var points
= sets
[i
];
1726 var len
= points
.length
;
1727 for (var j
= 0; j
< len
; j
++) {
1728 var point
= points
[j
];
1729 if (!Dygraph
.isValidPoint(point
, true)) continue;
1730 var dist
= Math
.abs(point
.canvasx
- domX
);
1731 if (dist
< minDistX
) {
1733 closestRow
= point
.idx
;
1742 * Given canvas X,Y coordinates, find the closest point.
1744 * This finds the individual data point across all visible series
1745 * that's closest to the supplied DOM coordinates using the standard
1746 * Euclidean X,Y distance.
1748 * @param {Number} domX graph-relative DOM X coordinate
1749 * @param {Number} domY graph-relative DOM Y coordinate
1750 * Returns: {row, seriesName, point}
1753 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1754 var minDist
= Infinity
;
1755 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1756 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1757 var points
= this.layout_
.points
[setIdx
];
1758 for (var i
= 0; i
< points
.length
; ++i
) {
1760 if (!Dygraph
.isValidPoint(point
)) continue;
1761 dx
= point
.canvasx
- domX
;
1762 dy
= point
.canvasy
- domY
;
1763 dist
= dx
* dx
+ dy
* dy
;
1764 if (dist
< minDist
) {
1766 closestPoint
= point
;
1767 closestSeries
= setIdx
;
1768 closestRow
= point
.idx
;
1772 var name
= this.layout_
.setNames
[closestSeries
];
1781 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1783 * This first finds the X data point closest to the supplied DOM X coordinate,
1784 * then finds the series which puts the Y coordinate on top of its filled area,
1785 * using linear interpolation between adjacent point pairs.
1787 * @param {Number} domX graph-relative DOM X coordinate
1788 * @param {Number} domY graph-relative DOM Y coordinate
1789 * Returns: {row, seriesName, point}
1792 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1793 var row
= this.findClosestRow(domX
);
1794 var closestPoint
, closestSeries
;
1795 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1796 var boundary
= this.getLeftBoundary_(setIdx
);
1797 var rowIdx
= row
- boundary
;
1798 var points
= this.layout_
.points
[setIdx
];
1799 if (rowIdx
>= points
.length
) continue;
1800 var p1
= points
[rowIdx
];
1801 if (!Dygraph
.isValidPoint(p1
)) continue;
1802 var py
= p1
.canvasy
;
1803 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1804 // interpolate series Y value using next point
1805 var p2
= points
[rowIdx
+ 1];
1806 if (Dygraph
.isValidPoint(p2
)) {
1807 var dx
= p2
.canvasx
- p1
.canvasx
;
1809 var r
= (domX
- p1
.canvasx
) / dx
;
1810 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1813 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1814 // interpolate series Y value using previous point
1815 var p0
= points
[rowIdx
- 1];
1816 if (Dygraph
.isValidPoint(p0
)) {
1817 var dx
= p1
.canvasx
- p0
.canvasx
;
1819 var r
= (p1
.canvasx
- domX
) / dx
;
1820 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1824 // Stop if the point (domX, py) is above this series' upper edge
1825 if (setIdx
=== 0 || py
< domY
) {
1827 closestSeries
= setIdx
;
1830 var name
= this.layout_
.setNames
[closestSeries
];
1839 * When the mouse moves in the canvas, display information about a nearby data
1840 * point and draw dots over those points in the data series. This function
1841 * takes care of cleanup of previously-drawn dots.
1842 * @param {Object} event The mousemove event from the browser.
1845 Dygraph
.prototype.mouseMove_
= function(event
) {
1846 // This prevents JS errors when mousing over the canvas before data loads.
1847 var points
= this.layout_
.points
;
1848 if (points
=== undefined
|| points
=== null) return;
1850 var canvasCoords
= this.eventToDomCoords(event
);
1851 var canvasx
= canvasCoords
[0];
1852 var canvasy
= canvasCoords
[1];
1854 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1855 var selectionChanged
= false;
1856 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1858 if (this.attr_("stackedGraph")) {
1859 closest
= this.findStackedPoint(canvasx
, canvasy
);
1861 closest
= this.findClosestPoint(canvasx
, canvasy
);
1863 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1865 var idx
= this.findClosestRow(canvasx
);
1866 selectionChanged
= this.setSelection(idx
);
1869 var callback
= this.attr_("highlightCallback");
1870 if (callback
&& selectionChanged
) {
1875 this.highlightSet_
);
1880 * Fetch left offset from the specified set index or if not passed, the
1881 * first defined boundaryIds record (see bug #236).
1884 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1885 if (this.boundaryIds_
[setIdx
]) {
1886 return this.boundaryIds_
[setIdx
][0];
1888 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1889 if (this.boundaryIds_
[i
] !== undefined
) {
1890 return this.boundaryIds_
[i
][0];
1897 Dygraph
.prototype.animateSelection_
= function(direction
) {
1898 var totalSteps
= 10;
1900 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1901 if (this.animateId
=== undefined
) this.animateId
= 0;
1902 var start
= this.fadeLevel
;
1903 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1905 if (this.fadeLevel
) {
1906 this.updateSelection_(1.0);
1911 var thisId
= ++this.animateId
;
1913 Dygraph
.repeatAndCleanup(
1915 // ignore simultaneous animations
1916 if (that
.animateId
!= thisId
) return;
1918 that
.fadeLevel
+= direction
;
1919 if (that
.fadeLevel
=== 0) {
1920 that
.clearSelection();
1922 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1925 steps
, millis
, function() {});
1929 * Draw dots over the selectied points in the data series. This function
1930 * takes care of cleanup of previously-drawn dots.
1933 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1934 /*var defaultPrevented = */
1935 this.cascadeEvents_('select', {
1936 selectedX
: this.lastx_
,
1937 selectedPoints
: this.selPoints_
1939 // TODO(danvk): use defaultPrevented here?
1941 // Clear the previously drawn vertical, if there is one
1943 var ctx
= this.canvas_ctx_
;
1944 if (this.attr_('highlightSeriesOpts')) {
1945 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1946 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1948 // Activating background fade includes an animation effect for a gradual
1949 // fade. TODO(klausw): make this independently configurable if it causes
1950 // issues? Use a shared preference to control animations?
1951 var animateBackgroundFade
= true;
1952 if (animateBackgroundFade
) {
1953 if (opt_animFraction
=== undefined
) {
1954 // start a new animation
1955 this.animateSelection_(1);
1958 alpha
*= opt_animFraction
;
1960 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1961 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1964 // Redraw only the highlighted series in the interactive canvas (not the
1965 // static plot canvas, which is where series are usually drawn).
1966 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1967 } else if (this.previousVerticalX_
>= 0) {
1968 // Determine the maximum highlight circle size.
1969 var maxCircleSize
= 0;
1970 var labels
= this.attr_('labels');
1971 for (i
= 1; i
< labels
.length
; i
++) {
1972 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1973 if (r
> maxCircleSize
) maxCircleSize
= r
;
1975 var px
= this.previousVerticalX_
;
1976 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1977 2 * maxCircleSize
+ 2, this.height_
);
1980 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1981 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1984 if (this.selPoints_
.length
> 0) {
1985 // Draw colored circles over the center of each selected point
1986 var canvasx
= this.selPoints_
[0].canvasx
;
1988 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1989 var pt
= this.selPoints_
[i
];
1990 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1992 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1993 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1994 var color
= this.plotter_
.colors
[pt
.name
];
1996 callback
= Dygraph
.Circles
.DEFAULT
;
1998 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1999 ctx
.strokeStyle
= color
;
2000 ctx
.fillStyle
= color
;
2001 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
2002 color
, circleSize
, pt
.idx
);
2006 this.previousVerticalX_
= canvasx
;
2011 * Manually set the selected points and display information about them in the
2012 * legend. The selection can be cleared using clearSelection() and queried
2013 * using getSelection().
2014 * @param { Integer } row number that should be highlighted (i.e. appear with
2015 * hover dots on the chart). Set to false to clear any selection.
2016 * @param { seriesName } optional series name to highlight that series with the
2017 * the highlightSeriesOpts setting.
2018 * @param { locked } optional If true, keep seriesName selected when mousing
2019 * over the graph, disabling closest-series highlighting. Call clearSelection()
2022 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2023 // Extract the points we've selected
2024 this.selPoints_
= [];
2026 var changed
= false;
2027 if (row
!== false && row
>= 0) {
2028 if (row
!= this.lastRow_
) changed
= true;
2029 this.lastRow_
= row
;
2030 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2031 var points
= this.layout_
.points
[setIdx
];
2032 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2033 if (setRow
< points
.length
) {
2034 var point
= points
[setRow
];
2035 if (point
.yval
!== null) this.selPoints_
.push(point
);
2039 if (this.lastRow_
>= 0) changed
= true;
2043 if (this.selPoints_
.length
) {
2044 this.lastx_
= this.selPoints_
[0].xval
;
2049 if (opt_seriesName
!== undefined
) {
2050 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2051 this.highlightSet_
= opt_seriesName
;
2054 if (opt_locked
!== undefined
) {
2055 this.lockedSet_
= opt_locked
;
2059 this.updateSelection_(undefined
);
2065 * The mouse has left the canvas. Clear out whatever artifacts remain
2066 * @param {Object} event the mouseout event from the browser.
2069 Dygraph
.prototype.mouseOut_
= function(event
) {
2070 if (this.attr_("unhighlightCallback")) {
2071 this.attr_("unhighlightCallback")(event
);
2074 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2075 this.clearSelection();
2080 * Clears the current selection (i.e. points that were highlighted by moving
2081 * the mouse over the chart).
2083 Dygraph
.prototype.clearSelection
= function() {
2084 this.cascadeEvents_('deselect', {});
2086 this.lockedSet_
= false;
2087 // Get rid of the overlay data
2088 if (this.fadeLevel
) {
2089 this.animateSelection_(-1);
2092 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2094 this.selPoints_
= [];
2097 this.highlightSet_
= null;
2101 * Returns the number of the currently selected row. To get data for this row,
2102 * you can use the getValue method.
2103 * @return { Integer } row number, or -1 if nothing is selected
2105 Dygraph
.prototype.getSelection
= function() {
2106 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2110 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2111 var points
= this.layout_
.points
[setIdx
];
2112 for (var row
= 0; row
< points
.length
; row
++) {
2113 if (points
[row
].x
== this.selPoints_
[0].x
) {
2114 return points
[row
].idx
;
2122 * Returns the name of the currently-highlighted series.
2123 * Only available when the highlightSeriesOpts option is in use.
2125 Dygraph
.prototype.getHighlightSeries
= function() {
2126 return this.highlightSet_
;
2130 * Returns true if the currently-highlighted series was locked
2131 * via setSelection(..., seriesName, true).
2133 Dygraph
.prototype.isSeriesLocked
= function() {
2134 return this.lockedSet_
;
2138 * Fires when there's data available to be graphed.
2139 * @param {String} data Raw CSV data to be plotted
2142 Dygraph
.prototype.loadedEvent_
= function(data
) {
2143 this.rawData_
= this.parseCSV_(data
);
2148 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2151 Dygraph
.prototype.addXTicks_
= function() {
2152 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2154 if (this.dateWindow_
) {
2155 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2157 range
= this.xAxisExtremes();
2160 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2161 var xTicks
= xAxisOptionsView('ticker')(
2164 this.width_
, // TODO(danvk): should be area.width
2167 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2168 // console.log(msg);
2169 this.layout_
.setXTicks(xTicks
);
2173 * Returns the correct handler class for the currently set options.
2176 Dygraph
.prototype.getHandlerClass_
= function() {
2178 if (this.attr_('dataHandler')) {
2179 handlerClass
= this.attr_('dataHandler');
2180 } else if (this.fractions_
) {
2181 if (this.attr_('errorBars')) {
2182 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2184 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2186 } else if (this.attr_('customBars')) {
2187 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2188 } else if (this.attr_('errorBars')) {
2189 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2191 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2193 return handlerClass
;
2198 * This function is called once when the chart's data is changed or the options
2199 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2200 * idea is that values derived from the chart's data can be computed here,
2201 * rather than every time the chart is drawn. This includes things like the
2202 * number of axes, rolling averages, etc.
2204 Dygraph
.prototype.predraw_
= function() {
2205 var start
= new Date();
2207 // Create the correct dataHandler
2208 this.dataHandler_
= new (this.getHandlerClass_())();
2210 this.layout_
.computePlotArea();
2212 // TODO(danvk): move more computations out of drawGraph_ and into here.
2213 this.computeYAxes_();
2215 // Create a new plotter.
2216 if (this.plotter_
) {
2217 this.cascadeEvents_('clearChart');
2218 this.plotter_
.clear();
2221 if (!this.is_initial_draw_
) {
2222 this.canvas_ctx_
.restore();
2223 this.hidden_ctx_
.restore();
2226 this.canvas_ctx_
.save();
2227 this.hidden_ctx_
.save();
2229 this.plotter_
= new DygraphCanvasRenderer(this,
2234 // The roller sits in the bottom left corner of the chart. We don't know where
2235 // this will be until the options are available, so it's positioned here.
2236 this.createRollInterface_();
2238 this.cascadeEvents_('predraw');
2240 // Convert the raw data (a 2D array) into the internal format and compute
2241 // rolling averages.
2242 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2243 for (var i
= 1; i
< this.numColumns(); i
++) {
2244 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2245 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2246 if (this.rollPeriod_
> 1) {
2247 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2250 this.rolledSeries_
.push(series
);
2253 // If the data or options have changed, then we'd better redraw.
2256 // This is used to determine whether to do various animations.
2257 var end
= new Date();
2258 this.drawingTimeMs_
= (end
- start
);
2264 * xval_* and yval_* are the original unscaled data values,
2265 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2266 * yval_stacked is the cumulative Y value used for stacking graphs,
2267 * and bottom/top/minus/plus are used for error bar graphs.
2274 * y_bottom: ?number,
2276 * y_stacked: ?number,
2278 * yval_minus: ?number,
2280 * yval_plus: ?number,
2284 Dygraph
.PointType
= undefined
;
2287 * Calculates point stacking for stackedGraph=true.
2289 * For stacking purposes, interpolate or extend neighboring data across
2290 * NaN values based on stackedGraphNaNFill settings. This is for display
2291 * only, the underlying data value as shown in the legend remains NaN.
2293 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2294 * Updates each Point's yval_stacked property.
2295 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2296 * values for the series seen so far. Index is the row number. Updated
2297 * based on the current series's values.
2298 * @param {Array.<number>} seriesExtremes Min and max values, updated
2299 * to reflect the stacked values.
2300 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2304 Dygraph
.stackPoints_
= function(
2305 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2306 var lastXval
= null;
2307 var prevPoint
= null;
2308 var nextPoint
= null;
2309 var nextPointIdx
= -1;
2311 // Find the next stackable point starting from the given index.
2312 var updateNextPoint
= function(idx
) {
2313 // If we've previously found a non-NaN point and haven't gone past it yet,
2315 if (nextPointIdx
>= idx
) return;
2317 // We haven't found a non-NaN point yet or have moved past it,
2318 // look towards the right to find a non-NaN point.
2319 for (var j
= idx
; j
< points
.length
; ++j
) {
2320 // Clear out a previously-found point (if any) since it's no longer
2321 // valid, we shouldn't use it for interpolation anymore.
2323 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2325 nextPoint
= points
[j
];
2331 for (var i
= 0; i
< points
.length
; ++i
) {
2332 var point
= points
[i
];
2333 var xval
= point
.xval
;
2334 if (cumulativeYval
[xval
] === undefined
) {
2335 cumulativeYval
[xval
] = 0;
2338 var actualYval
= point
.yval
;
2339 if (isNaN(actualYval
) || actualYval
=== null) {
2340 // Interpolate/extend
for stacking purposes
if possible
.
2342 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2343 // Use linear interpolation between prevPoint and nextPoint.
2344 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2345 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2346 } else if (prevPoint
&& fillMethod
== 'all') {
2347 actualYval
= prevPoint
.yval
;
2348 } else if (nextPoint
&& fillMethod
== 'all') {
2349 actualYval
= nextPoint
.yval
;
2357 var stackedYval
= cumulativeYval
[xval
];
2358 if (lastXval
!= xval
) {
2359 // If an x-value is repeated, we ignore the duplicates.
2360 stackedYval
+= actualYval
;
2361 cumulativeYval
[xval
] = stackedYval
;
2365 point
.yval_stacked
= stackedYval
;
2367 if (stackedYval
> seriesExtremes
[1]) {
2368 seriesExtremes
[1] = stackedYval
;
2370 if (stackedYval
< seriesExtremes
[0]) {
2371 seriesExtremes
[0] = stackedYval
;
2378 * Loop over all fields and create datasets, calculating extreme y-values for
2379 * each series and extreme x-indices as we go.
2381 * dateWindow is passed in as an explicit parameter so that we can compute
2382 * extreme values "speculatively", i.e. without actually setting state on the
2385 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2386 * rolledSeries[seriesIndex][row] = raw point, where
2387 * seriesIndex is the column number starting with 1, and
2388 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2389 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2391 * points: Array.<Array.<Dygraph.PointType>>,
2392 * seriesExtremes: Array.<Array.<number>>,
2393 * boundaryIds: Array.<number>}}
2396 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2397 var boundaryIds
= [];
2399 var cumulativeYval
= []; // For stacked series.
2400 var extremes
= {}; // series name -> [low, high]
2401 var seriesIdx
, sampleIdx
;
2402 var firstIdx
, lastIdx
;
2404 // Loop over the fields (series). Go from the last to the first,
2405 // because if they're stacked that's how we accumulate the values.
2406 var num_series
= rolledSeries
.length
- 1;
2408 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2409 if (!this.visibility()[seriesIdx
- 1]) continue;
2411 // Prune down to the desired range, if necessary (for zooming)
2412 // Because there can be lines going to points outside of the visible area,
2413 // we actually prune to visible points, plus one on either side.
2415 series
= rolledSeries
[seriesIdx
];
2416 var low
= dateWindow
[0];
2417 var high
= dateWindow
[1];
2419 // TODO(danvk): do binary search instead of linear search.
2420 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2423 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2424 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2425 firstIdx
= sampleIdx
;
2427 if (series
[sampleIdx
][0] <= high
) {
2428 lastIdx
= sampleIdx
;
2432 if (firstIdx
=== null) firstIdx
= 0;
2433 var correctedFirstIdx
= firstIdx
;
2434 var isInvalidValue
= true;
2435 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2436 correctedFirstIdx
--;
2437 // check if the y value is null.
2438 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2441 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2442 var correctedLastIdx
= lastIdx
;
2443 isInvalidValue
= true;
2444 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2446 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2449 if (correctedFirstIdx
!==firstIdx
) {
2450 firstIdx
= correctedFirstIdx
;
2452 if (correctedLastIdx
!== lastIdx
) {
2453 lastIdx
= correctedLastIdx
;
2456 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2458 // .slice's end is exclusive, we want to include lastIdx.
2459 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2461 series
= rolledSeries
[seriesIdx
];
2462 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2465 var seriesName
= this.attr_("labels")[seriesIdx
];
2466 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2467 dateWindow
, this.attr_("stepPlot",seriesName
));
2469 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2470 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2472 if (this.attr_("stackedGraph")) {
2473 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2474 this.attr_("stackedGraphNaNFill"));
2477 extremes
[seriesName
] = seriesExtremes
;
2478 points
[seriesIdx
] = seriesPoints
;
2481 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2485 * Update the graph with new data. This method is called when the viewing area
2486 * has changed. If the underlying data or options have changed, predraw_ will
2487 * be called before drawGraph_ is called.
2491 Dygraph
.prototype.drawGraph_
= function() {
2492 var start
= new Date();
2494 // This is used to set the second parameter to drawCallback, below.
2495 var is_initial_draw
= this.is_initial_draw_
;
2496 this.is_initial_draw_
= false;
2498 this.layout_
.removeAllDatasets();
2500 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2502 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2503 var points
= packed
.points
;
2504 var extremes
= packed
.extremes
;
2505 this.boundaryIds_
= packed
.boundaryIds
;
2507 this.setIndexByName_
= {};
2508 var labels
= this.attr_("labels");
2509 if (labels
.length
> 0) {
2510 this.setIndexByName_
[labels
[0]] = 0;
2513 for (var i
= 1; i
< points
.length
; i
++) {
2514 this.setIndexByName_
[labels
[i
]] = i
;
2515 if (!this.visibility()[i
- 1]) continue;
2516 this.layout_
.addDataset(labels
[i
], points
[i
]);
2517 this.datasetIndex_
[i
] = dataIdx
++;
2520 this.computeYAxisRanges_(extremes
);
2521 this.layout_
.setYAxes(this.axes_
);
2525 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2526 var tmp_zoomed_x
= this.zoomed_x_
;
2527 // Tell PlotKit to use this new data and render itself
2528 this.zoomed_x_
= tmp_zoomed_x
;
2529 this.layout_
.evaluate();
2530 this.renderGraph_(is_initial_draw
);
2532 if (this.attr_("timingName")) {
2533 var end
= new Date();
2534 Dygraph
.info(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2539 * This does the work of drawing the chart. It assumes that the layout and axis
2540 * scales have already been set (e.g. by predraw_).
2544 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2545 this.cascadeEvents_('clearChart');
2546 this.plotter_
.clear();
2548 if (this.attr_('underlayCallback')) {
2549 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2550 // users who expect a deprecated form of this callback.
2551 this.attr_('underlayCallback')(
2552 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2556 canvas
: this.hidden_
,
2557 drawingContext
: this.hidden_ctx_
2559 this.cascadeEvents_('willDrawChart', e
);
2560 this.plotter_
.render();
2561 this.cascadeEvents_('didDrawChart', e
);
2562 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2564 // TODO(danvk): is this a performance bottleneck when panning?
2565 // The interaction canvas should already be empty in that situation.
2566 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2567 this.canvas_
.height
);
2569 if (this.attr_("drawCallback") !== null) {
2570 this.attr_("drawCallback")(this, is_initial_draw
);
2572 if (is_initial_draw
) {
2573 this.readyFired_
= true;
2574 while (this.readyFns_
.length
> 0) {
2575 var fn
= this.readyFns_
.pop();
2583 * Determine properties of the y-axes which are independent of the data
2584 * currently being displayed. This includes things like the number of axes and
2585 * the style of the axes. It does not include the range of each axis and its
2587 * This fills in this.axes_.
2588 * axes_ = [ { options } ]
2589 * indices are into the axes_ array.
2591 Dygraph
.prototype.computeYAxes_
= function() {
2592 // Preserve valueWindow settings if they exist, and if the user hasn't
2593 // specified a new valueRange.
2594 var valueWindows
, axis
, index
, opts
, v
;
2595 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2597 for (index
= 0; index
< this.axes_
.length
; index
++) {
2598 valueWindows
.push(this.axes_
[index
].valueWindow
);
2602 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2603 // data computation as well as options storage.
2604 // Go through once and add all the axes.
2607 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2608 // Add a new axis, making a copy of its per-axis options.
2609 opts
= { g
: this };
2610 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2611 this.axes_
[axis
] = opts
;
2615 // Copy global valueRange option over to the first axis.
2616 // NOTE(konigsberg): Are these two statements necessary?
2617 // I tried removing it. The automated tests pass, and manually
2618 // messing with tests/zoom
.html showed no trouble
.
2619 v
= this.attr_('valueRange');
2620 if (v
) this.axes_
[0].valueRange
= v
;
2622 if (valueWindows
!== undefined
) {
2623 // Restore valueWindow settings.
2625 // When going from two axes back to one, we only restore
2627 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2629 for (index
= 0; index
< idxCount
; index
++) {
2630 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2634 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2636 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2637 v
= opts("valueRange");
2638 if (v
) this.axes_
[axis
].valueRange
= v
;
2639 } else { // To keep old behavior
2640 var axes
= this.user_attrs_
.axes
;
2641 if (axes
&& axes
.y2
) {
2642 v
= axes
.y2
.valueRange
;
2643 if (v
) this.axes_
[axis
].valueRange
= v
;
2650 * Returns the number of y-axes on the chart.
2651 * @return {Number} the number of axes.
2653 Dygraph
.prototype.numAxes
= function() {
2654 return this.attributes_
.numAxes();
2659 * Returns axis properties for the given series.
2660 * @param { String } setName The name of the series for which to get axis
2661 * properties, e.g. 'Y1'.
2662 * @return { Object } The axis properties.
2664 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2665 // TODO(danvk): handle errors.
2666 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2671 * Determine the value range and tick marks for each axis.
2672 * @param {Object} extremes A mapping from seriesName -> [low, high]
2673 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2675 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2676 var isNullUndefinedOrNaN
= function(num
) {
2677 return isNaN(parseFloat(num
));
2679 var numAxes
= this.attributes_
.numAxes();
2680 var ypadCompat
, span
, series
, ypad
;
2684 // Compute extreme values, a span and tick marks for each axis.
2685 for (var i
= 0; i
< numAxes
; i
++) {
2686 var axis
= this.axes_
[i
];
2687 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2688 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2689 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2690 series
= this.attributes_
.seriesForAxis(i
);
2692 // Add some padding. This supports two Y padding operation modes:
2694 // - backwards compatible (yRangePad not set):
2695 // 10% padding for automatic Y ranges, but not for user-supplied
2696 // ranges, and move a close-to-zero edge to zero except if
2697 // avoidMinZero is set, since drawing at the edge results in
2698 // invisible lines. Unfortunately lines drawn at the edge of a
2699 // user-supplied range will still be invisible. If logscale is
2700 // set, add a variable amount of padding at the top but
2701 // none at the bottom.
2703 // - new-style (yRangePad set by the user):
2704 // always add the specified Y padding.
2707 ypad
= 0.1; // add 10%
2708 if (this.attr_('yRangePad') !== null) {
2710 // Convert pixel padding to ratio
2711 ypad
= this.attr_('yRangePad') / this.plotter_
.area
.h
;
2714 if (series
.length
=== 0) {
2715 // If no series are defined or visible then use a reasonable default
2716 axis
.extremeRange
= [0, 1];
2718 // Calculate the extremes of extremes.
2719 var minY
= Infinity
; // extremes[series[0]][0];
2720 var maxY
= -Infinity
; // extremes[series[0]][1];
2721 var extremeMinY
, extremeMaxY
;
2723 for (var j
= 0; j
< series
.length
; j
++) {
2724 // this skips invisible series
2725 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2727 // Only use valid extremes to stop null data series' from corrupting the scale.
2728 extremeMinY
= extremes
[series
[j
]][0];
2729 if (extremeMinY
!== null) {
2730 minY
= Math
.min(extremeMinY
, minY
);
2732 extremeMaxY
= extremes
[series
[j
]][1];
2733 if (extremeMaxY
!== null) {
2734 maxY
= Math
.max(extremeMaxY
, maxY
);
2738 // Include zero if requested by the user.
2739 if (includeZero
&& !logscale
) {
2740 if (minY
> 0) minY
= 0;
2741 if (maxY
< 0) maxY
= 0;
2744 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2745 if (minY
== Infinity
) minY
= 0;
2746 if (maxY
== -Infinity
) maxY
= 1;
2749 // special case: if we have no sense of scale, center on the sole value.
2752 span
= Math
.abs(maxY
);
2754 // ... and if the sole value is zero, use range 0-1.
2760 var maxAxisY
, minAxisY
;
2763 maxAxisY
= maxY
+ ypad
* span
;
2766 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2767 maxAxisY
= maxY
* logpad
;
2768 minAxisY
= minY
/ logpad
;
2771 maxAxisY
= maxY
+ ypad
* span
;
2772 minAxisY
= minY
- ypad
* span
;
2774 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2775 // close to zero, but not if avoidMinZero is set.
2776 if (ypadCompat
&& !this.attr_("avoidMinZero")) {
2777 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2778 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2781 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2783 if (axis
.valueWindow
) {
2784 // This is only set if the user has zoomed on the y-axis. It is never set
2785 // by a user. It takes precedence over axis.valueRange because, if you set
2786 // valueRange, you'd still expect to be able to pan.
2787 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2788 } else if (axis
.valueRange
) {
2789 // This is a user-set value range for this axis.
2790 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2791 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2793 if (axis
.logscale
) {
2794 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2803 axis
.computedValueRange
= [y0
, y1
];
2805 axis
.computedValueRange
= axis
.extremeRange
;
2809 if (independentTicks
) {
2810 axis
.independentTicks
= independentTicks
;
2811 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2812 var ticker
= opts('ticker');
2813 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2814 axis
.computedValueRange
[1],
2815 this.height_
, // TODO(danvk): should be area.height
2818 // Define the first independent axis as primary axis.
2819 if (!p_axis
) p_axis
= axis
;
2822 if (p_axis
=== undefined
) {
2823 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2825 // Add ticks. By default, all axes inherit the tick positions of the
2826 // primary axis. However, if an axis is specifically marked as having
2827 // independent ticks, then that is permissible as well.
2828 for (var i
= 0; i
< numAxes
; i
++) {
2829 var axis
= this.axes_
[i
];
2831 if (!axis
.independentTicks
) {
2832 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2833 var ticker
= opts('ticker');
2834 var p_ticks
= p_axis
.ticks
;
2835 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2836 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2837 var tick_values
= [];
2838 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2839 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2840 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2841 tick_values
.push(y_val
);
2844 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2845 axis
.computedValueRange
[1],
2846 this.height_
, // TODO(danvk): should be area.height
2855 * Detects the type of the str (date or numeric) and sets the various
2856 * formatting attributes in this.attrs_ based on this type.
2857 * @param {String} str An x value.
2860 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2862 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2863 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2864 str
.indexOf('/') >= 0 ||
2865 isNaN(parseFloat(str
))) {
2867 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2868 // TODO(danvk): remove support for this format.
2872 this.setXAxisOptions_(isDate
);
2875 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2877 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2878 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2879 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2880 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2882 /** @private (shut up, jsdoc!) */
2883 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2884 // TODO(danvk): use Dygraph.numberValueFormatter here?
2885 /** @private (shut up, jsdoc!) */
2886 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2887 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2888 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2893 * Parses the value as a floating point number. This is like the parseFloat()
2894 * built-in, but with a few differences:
2895 * - the empty string is parsed as null, rather than NaN.
2896 * - if the string cannot be parsed at all, an error is logged.
2897 * If the string can't be parsed, this method returns null.
2898 * @param {String} x The string to be parsed
2899 * @param {Number} opt_line_no The line number from which the string comes.
2900 * @param {String} opt_line The text of the line from which the string comes.
2904 // Parse the x as a float or return null if it's not a number.
2905 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2906 var val
= parseFloat(x
);
2907 if (!isNaN(val
)) return val
;
2909 // Try to figure out what happeend.
2910 // If the value is the empty string, parse it as null.
2911 if (/^ *$/.test(x
)) return null;
2913 // If it was actually "NaN", return it as NaN.
2914 if (/^ *nan *$/i.test(x
)) return NaN
;
2916 // Looks like a parsing error.
2917 var msg
= "Unable to parse '" + x
+ "' as a number";
2918 if (opt_line
!== null && opt_line_no
!== null) {
2919 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2928 * Parses a string in a special csv format. We expect a csv file where each
2929 * line is a date point, and the first field in each line is the date string.
2930 * We also expect that all remaining fields represent series.
2931 * if the errorBars attribute is set, then interpret the fields as:
2932 * date, series1, stddev1, series2, stddev2, ...
2933 * @param {[Object]} data See above.
2935 * @return [Object] An array with one entry for each row. These entries
2936 * are an array of cells in that row. The first entry is the parsed x-value for
2937 * the row. The second, third, etc. are the y-values. These can take on one of
2938 * three forms, depending on the CSV and constructor parameters:
2940 * 2. [ value, stddev ]
2941 * 3. [ low value, center value, high value ]
2943 Dygraph
.prototype.parseCSV_
= function(data
) {
2945 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2946 var lines
= data
.split(line_delimiter
|| "\n");
2949 // Use the default delimiter or fall back to a tab if that makes sense.
2950 var delim
= this.attr_('delimiter');
2951 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2956 if (!('labels' in this.user_attrs_
)) {
2957 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2959 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2960 this.attributes_
.reparseSeries();
2965 var defaultParserSet
= false; // attempt to auto-detect x value type
2966 var expectedCols
= this.attr_("labels").length
;
2967 var outOfOrder
= false;
2968 for (var i
= start
; i
< lines
.length
; i
++) {
2969 var line
= lines
[i
];
2971 if (line
.length
=== 0) continue; // skip blank lines
2972 if (line
[0] == '#') continue; // skip comment lines
2973 var inFields
= line
.split(delim
);
2974 if (inFields
.length
< 2) continue;
2977 if (!defaultParserSet
) {
2978 this.detectTypeFromString_(inFields
[0]);
2979 xParser
= this.attr_("xValueParser");
2980 defaultParserSet
= true;
2982 fields
[0] = xParser(inFields
[0], this);
2984 // If fractions are expected, parse the numbers as "A/B
"
2985 if (this.fractions_) {
2986 for (j = 1; j < inFields.length; j++) {
2987 // TODO(danvk): figure out an appropriate way to flag parse errors.
2988 vals = inFields[j].split("/");
2989 if (vals.length != 2) {
2990 this.error('Expected fractional "num
/den
" values in CSV data ' +
2991 "but found a value
'" + inFields[j] + "' on line
" +
2992 (1 + i) + " ('" + line + "') which is not of
this form
.");
2995 fields[j] = [this.parseFloat_(vals[0], i, line),
2996 this.parseFloat_(vals[1], i, line)];
2999 } else if (this.attr_("errorBars
")) {
3000 // If there are error bars, values are (value, stddev) pairs
3001 if (inFields.length % 2 != 1) {
3002 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
3003 'but line ' + (1 + i) + ' has an odd number of values (' +
3004 (inFields.length - 1) + "): '" + line + "'");
3006 for (j = 1; j < inFields.length; j += 2) {
3007 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
3008 this.parseFloat_(inFields[j + 1], i, line)];
3010 } else if (this.attr_("customBars
")) {
3011 // Bars are a low;center;high tuple
3012 for (j = 1; j < inFields.length; j++) {
3013 var val = inFields[j];
3014 if (/^ *$/.test(val)) {
3015 fields[j] = [null, null, null];
3017 vals = val.split(";");
3018 if (vals.length == 3) {
3019 fields[j] = [ this.parseFloat_(vals[0], i, line),
3020 this.parseFloat_(vals[1], i, line),
3021 this.parseFloat_(vals[2], i, line) ];
3023 this.warn('When using customBars, values must be either blank ' +
3024 'or "low
;center
;high
" tuples (got "' + val +
3025 '" on line ' + (1+i));
3030 // Values are just numbers
3031 for (j = 1; j < inFields.length; j++) {
3032 fields[j] = this.parseFloat_(inFields[j], i, line);
3035 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3039 if (fields.length != expectedCols) {
3040 this.error("Number of columns
in line
" + i + " (" + fields.length +
3041 ") does not agree
with number of
labels (" + expectedCols +
3045 // If the user specified the 'labels' option and none of the cells of the
3046 // first row parsed correctly, then they probably double-specified the
3047 // labels. We go with the values set in the option, discard this row and
3048 // log a warning to the JS console.
3049 if (i === 0 && this.attr_('labels')) {
3050 var all_null = true;
3051 for (j = 0; all_null && j < fields.length; j++) {
3052 if (fields[j]) all_null = false;
3055 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3056 "CSV
data ('" + line + "') appears to also contain labels
. " +
3057 "Will drop the CSV labels and
use the option labels
.");
3065 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3066 ret.sort(function(a,b) { return a[0] - b[0]; });
3074 * The user has provided their data as a pre-packaged JS array. If the x values
3075 * are numeric, this is the same as dygraphs' internal format. If the x values
3076 * are dates, we need to convert them from Date objects to ms since epoch.
3077 * @param {[Object]} data
3078 * @return {[Object]} data with numeric x values.
3080 Dygraph.prototype.parseArray_ = function(data) {
3081 // Peek at the first x value to see if it's numeric.
3082 if (data.length === 0) {
3083 this.error("Can
't plot empty data set");
3086 if (data[0].length === 0) {
3087 this.error("Data set cannot contain an empty row");
3092 if (this.attr_("labels") === null) {
3093 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3094 "in the options parameter");
3095 this.attrs_.labels = [ "X" ];
3096 for (i = 1; i < data[0].length; i++) {
3097 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3099 this.attributes_.reparseSeries();
3101 var num_labels = this.attr_("labels");
3102 if (num_labels.length != data[0].length) {
3103 this.error("Mismatch between number of labels (" + num_labels +
3104 ") and number of columns in array (" + data[0].length + ")");
3109 if (Dygraph.isDateLike(data[0][0])) {
3110 // Some intelligent defaults for a date x-axis.
3111 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3112 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3113 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3115 // Assume they're all dates
.
3116 var parsedData
= Dygraph
.clone(data
);
3117 for (i
= 0; i
< data
.length
; i
++) {
3118 if (parsedData
[i
].length
=== 0) {
3119 this.error("Row " + (1 + i
) + " of data is empty");
3122 if (parsedData
[i
][0] === null ||
3123 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3124 isNaN(parsedData
[i
][0].getTime())) {
3125 this.error("x value in row " + (1 + i
) + " is not a Date");
3128 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3132 // Some intelligent defaults for a numeric x-axis.
3133 /** @private (shut up, jsdoc!) */
3134 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3135 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3136 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3142 * Parses a DataTable object from gviz.
3143 * The data is expected to have a first column that is either a date or a
3144 * number. All subsequent columns must be numbers. If there is a clear mismatch
3145 * between this.xValueParser_ and the type of the first column, it will be
3146 * fixed. Fills out rawData_.
3147 * @param {[Object]} data See above.
3150 Dygraph
.prototype.parseDataTable_
= function(data
) {
3151 var shortTextForAnnotationNum
= function(num
) {
3152 // converts [0-9]+ [A-Z][a-z]*
3153 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3154 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3155 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3156 num
= Math
.floor(num
/ 26);
3158 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3159 num
= Math
.floor((num
- 1) / 26);
3164 var cols
= data
.getNumberOfColumns();
3165 var rows
= data
.getNumberOfRows();
3167 var indepType
= data
.getColumnType(0);
3168 if (indepType
== 'date' || indepType
== 'datetime') {
3169 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3170 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3171 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3172 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3173 } else if (indepType
== 'number') {
3174 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3175 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3176 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3177 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3179 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3180 "column 1 of DataTable input (Got '" + indepType
+ "')");
3184 // Array of the column indices which contain data (and not annotations).
3186 var annotationCols
= {}; // data index -> [annotation cols]
3187 var hasAnnotations
= false;
3189 for (i
= 1; i
< cols
; i
++) {
3190 var type
= data
.getColumnType(i
);
3191 if (type
== 'number') {
3193 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3194 // This is OK -- it's an annotation column.
3195 var dataIdx
= colIdx
[colIdx
.length
- 1];
3196 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3197 annotationCols
[dataIdx
] = [i
];
3199 annotationCols
[dataIdx
].push(i
);
3201 hasAnnotations
= true;
3203 this.error("Only 'number' is supported as a dependent type with Gviz." +
3204 " 'string' is only supported if displayAnnotations is true");
3208 // Read column labels
3209 // TODO(danvk): add support back for errorBars
3210 var labels
= [data
.getColumnLabel(0)];
3211 for (i
= 0; i
< colIdx
.length
; i
++) {
3212 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3213 if (this.attr_("errorBars")) i
+= 1;
3215 this.attrs_
.labels
= labels
;
3216 cols
= labels
.length
;
3219 var outOfOrder
= false;
3220 var annotations
= [];
3221 for (i
= 0; i
< rows
; i
++) {
3223 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3224 data
.getValue(i
, 0) === null) {
3225 this.warn("Ignoring row " + i
+
3226 " of DataTable because of undefined or null first column.");
3230 if (indepType
== 'date' || indepType
== 'datetime') {
3231 row
.push(data
.getValue(i
, 0).getTime());
3233 row
.push(data
.getValue(i
, 0));
3235 if (!this.attr_("errorBars")) {
3236 for (j
= 0; j
< colIdx
.length
; j
++) {
3237 var col
= colIdx
[j
];
3238 row
.push(data
.getValue(i
, col
));
3239 if (hasAnnotations
&&
3240 annotationCols
.hasOwnProperty(col
) &&
3241 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3243 ann
.series
= data
.getColumnLabel(col
);
3245 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3247 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3248 if (k
) ann
.text
+= "\n";
3249 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3251 annotations
.push(ann
);
3255 // Strip out infinities, which give dygraphs problems later on.
3256 for (j
= 0; j
< row
.length
; j
++) {
3257 if (!isFinite(row
[j
])) row
[j
] = null;
3260 for (j
= 0; j
< cols
- 1; j
++) {
3261 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3264 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3271 this.warn("DataTable is out of order; order it correctly to speed loading.");
3272 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3274 this.rawData_
= ret
;
3276 if (annotations
.length
> 0) {
3277 this.setAnnotations(annotations
, true);
3279 this.attributes_
.reparseSeries();
3283 * Get the CSV data. If it's in a function, call that function. If it's in a
3284 * file, do an XMLHttpRequest to get it.
3287 Dygraph
.prototype.start_
= function() {
3288 var data
= this.file_
;
3290 // Functions can return references of all other types.
3291 if (typeof data
== 'function') {
3295 if (Dygraph
.isArrayLike(data
)) {
3296 this.rawData_
= this.parseArray_(data
);
3298 } else if (typeof data
== 'object' &&
3299 typeof data
.getColumnRange
== 'function') {
3300 // must be a DataTable from gviz.
3301 this.parseDataTable_(data
);
3303 } else if (typeof data
== 'string') {
3304 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3305 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3306 if (line_delimiter
) {
3307 this.loadedEvent_(data
);
3311 if (window
.XMLHttpRequest
) {
3312 // Firefox, Opera, IE7, and other browsers will use the native object
3313 req
= new XMLHttpRequest();
3315 // IE 5 and 6 will use the ActiveX control
3316 req
= new ActiveXObject("Microsoft.XMLHTTP");
3320 req
.onreadystatechange
= function () {
3321 if (req
.readyState
== 4) {
3322 if (req
.status
=== 200 || // Normal http
3323 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3324 caller
.loadedEvent_(req
.responseText
);
3329 req
.open("GET", data
, true);
3333 this.error("Unknown data format: " + (typeof data
));
3338 * Changes various properties of the graph. These can include:
3340 * <li>file: changes the source data for the graph</li>
3341 * <li>errorBars: changes whether the data contains stddev</li>
3344 * There's a huge variety of options that can be passed to this method. For a
3345 * full list, see http://dygraphs.com/options.html.
3347 * @param {Object} attrs The new properties and values
3348 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3349 * call to updateOptions(). If you know better, you can pass true to explicitly
3350 * block the redraw. This can be useful for chaining updateOptions() calls,
3351 * avoiding the occasional infinite loop and preventing redraws when it's not
3352 * necessary (e.g. when updating a callback).
3354 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3355 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3357 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3358 var file
= input_attrs
.file
;
3359 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3361 // TODO(danvk): this is a mess. Move these options into attr_.
3362 if ('rollPeriod' in attrs
) {
3363 this.rollPeriod_
= attrs
.rollPeriod
;
3365 if ('dateWindow' in attrs
) {
3366 this.dateWindow_
= attrs
.dateWindow
;
3367 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3368 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3371 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3372 this.zoomed_y_
= (attrs
.valueRange
!== null);
3375 // TODO(danvk): validate per-series options.
3380 // highlightCircleSize
3382 // Check if this set options will require new points.
3383 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3385 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3387 this.attributes_
.reparseSeries();
3391 if (!block_redraw
) this.start_();
3393 if (!block_redraw
) {
3394 if (requiresNewPoints
) {
3397 this.renderGraph_(false);
3404 * Returns a copy of the options with deprecated names converted into current
3405 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3406 * interested in that, they should save a copy before calling this.
3409 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3411 for (var k
in attrs
) {
3412 if (k
== 'file') continue;
3413 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3416 var set
= function(axis
, opt
, value
) {
3417 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3418 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3419 my_attrs
.axes
[axis
][opt
] = value
;
3421 var map
= function(opt
, axis
, new_opt
) {
3422 if (typeof(attrs
[opt
]) != 'undefined') {
3423 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3424 new_opt
+ " option for the " + axis
+ " axis instead. " +
3425 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3426 "(see http://dygraphs.com/per-axis.html for more information.");
3427 set(axis
, new_opt
, attrs
[opt
]);
3428 delete my_attrs
[opt
];
3432 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3433 map('xValueFormatter', 'x', 'valueFormatter');
3434 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3435 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3436 map('xTicker', 'x', 'ticker');
3437 map('yValueFormatter', 'y', 'valueFormatter');
3438 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3439 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3440 map('yTicker', 'y', 'ticker');
3441 map('drawXGrid', 'x', 'drawGrid');
3442 map('drawXAxis', 'x', 'drawAxis');
3443 map('drawYGrid', 'y', 'drawGrid');
3444 map('drawYAxis', 'y', 'drawAxis');
3449 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3450 * containing div (which has presumably changed size since the dygraph was
3451 * instantiated. If the width/height are specified, the div will be resized.
3453 * This is far more efficient than destroying and re-instantiating a
3454 * Dygraph, since it doesn't have to reparse the underlying data.
3456 * @param {Number} [width] Width (in pixels)
3457 * @param {Number} [height] Height (in pixels)
3459 Dygraph
.prototype.resize
= function(width
, height
) {
3460 if (this.resize_lock
) {
3463 this.resize_lock
= true;
3465 if ((width
=== null) != (height
=== null)) {
3466 this.warn("Dygraph.resize() should be called with zero parameters or " +
3467 "two non-NULL parameters. Pretending it was zero.");
3468 width
= height
= null;
3471 var old_width
= this.width_
;
3472 var old_height
= this.height_
;
3475 this.maindiv_
.style
.width
= width
+ "px";
3476 this.maindiv_
.style
.height
= height
+ "px";
3477 this.width_
= width
;
3478 this.height_
= height
;
3480 this.width_
= this.maindiv_
.clientWidth
;
3481 this.height_
= this.maindiv_
.clientHeight
;
3484 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3485 // Resizing a canvas erases it, even when the size doesn't change, so
3486 // any resize needs to be followed by a redraw.
3487 this.resizeElements_();
3491 this.resize_lock
= false;
3495 * Adjusts the number of points in the rolling average. Updates the graph to
3496 * reflect the new averaging period.
3497 * @param {Number} length Number of points over which to average the data.
3499 Dygraph
.prototype.adjustRoll
= function(length
) {
3500 this.rollPeriod_
= length
;
3505 * Returns a boolean array of visibility statuses.
3507 Dygraph
.prototype.visibility
= function() {
3508 // Do lazy-initialization, so that this happens after we know the number of
3510 if (!this.attr_("visibility")) {
3511 this.attrs_
.visibility
= [];
3513 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3514 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3515 this.attrs_
.visibility
.push(true);
3517 return this.attr_("visibility");
3521 * Changes the visiblity of a series.
3523 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3524 var x
= this.visibility();
3525 if (num
< 0 || num
>= x
.length
) {
3526 this.warn("invalid series number in setVisibility: " + num
);
3534 * How large of an area will the dygraph render itself in?
3535 * This is used for testing.
3536 * @return A {width: w, height: h} object.
3539 Dygraph
.prototype.size
= function() {
3540 return { width
: this.width_
, height
: this.height_
};
3544 * Update the list of annotations and redraw the chart.
3545 * See dygraphs.com/annotations.html for more info on how to use annotations.
3546 * @param ann {Array} An array of annotation objects.
3547 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3549 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3550 // Only add the annotation CSS rule once we know it will be used.
3551 Dygraph
.addAnnotationRule();
3552 this.annotations_
= ann
;
3553 if (!this.layout_
) {
3554 this.warn("Tried to setAnnotations before dygraph was ready. " +
3555 "Try setting them in a ready() block. See " +
3556 "dygraphs.com/tests/annotation.html");
3560 this.layout_
.setAnnotations(this.annotations_
);
3561 if (!suppressDraw
) {
3567 * Return the list of annotations.
3569 Dygraph
.prototype.annotations
= function() {
3570 return this.annotations_
;
3574 * Get the list of label names for this graph. The first column is the
3575 * x-axis, so the data series names start at index 1.
3577 * Returns null when labels have not yet been defined.
3579 Dygraph
.prototype.getLabels
= function() {
3580 var labels
= this.attr_("labels");
3581 return labels
? labels
.slice() : null;
3585 * Get the index of a series (column) given its name. The first column is the
3586 * x-axis, so the data series start with index 1.
3588 Dygraph
.prototype.indexFromSetName
= function(name
) {
3589 return this.setIndexByName_
[name
];
3593 * Trigger a callback when the dygraph has drawn itself and is ready to be
3594 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3595 * data (i.e. a URL is passed as the data source) and the chart is drawn
3596 * asynchronously. If the chart has already drawn, the callback will fire
3599 * This is a good place to call setAnnotation().
3601 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3604 Dygraph
.prototype.ready
= function(callback
) {
3605 if (this.is_initial_draw_
) {
3606 this.readyFns_
.push(callback
);
3614 * Adds a default style for the annotation CSS classes to the document. This is
3615 * only executed when annotations are actually used. It is designed to only be
3616 * called once -- all calls after the first will return immediately.
3618 Dygraph
.addAnnotationRule
= function() {
3619 // TODO(danvk): move this function into plugins/annotations.js
?
3620 if (Dygraph
.addedAnnotationCSS
) return;
3622 var rule
= "border: 1px solid black; " +
3623 "background-color: white; " +
3624 "text-align: center;";
3626 var styleSheetElement
= document
.createElement("style");
3627 styleSheetElement
.type
= "text/css";
3628 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3630 // Find the first style sheet that we can access.
3631 // We may not add a rule to a style sheet from another domain for security
3632 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3633 // adds its own style sheets from google.com.
3634 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3635 if (document
.styleSheets
[i
].disabled
) continue;
3636 var mysheet
= document
.styleSheets
[i
];
3638 if (mysheet
.insertRule
) { // Firefox
3639 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3640 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3641 } else if (mysheet
.addRule
) { // IE
3642 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3644 Dygraph
.addedAnnotationCSS
= true;
3647 // Was likely a security exception.
3651 this.warn("Unable to add default annotation CSS rule; display may be off.");