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.0";
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_
,
355 independentTicks
: true,
356 ticker
: null // will be set in dygraph-tickers.js
360 valueFormatter
: Dygraph
.numberValueFormatter
,
361 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
363 independentTicks
: true,
364 ticker
: null // will be set in dygraph-tickers.js
368 valueFormatter
: Dygraph
.numberValueFormatter
,
369 axisLabelFormatter
: Dygraph
.numberAxisLabelFormatter
,
371 independentTicks
: false,
372 ticker
: null // will be set in dygraph-tickers.js
377 // Directions for panning and zooming. Use bit operations when combined
378 // values are possible.
379 Dygraph
.HORIZONTAL
= 1;
380 Dygraph
.VERTICAL
= 2;
382 // Installed plugins, in order of precedence (most-general to most-specific).
383 // Plugins are installed after they are defined, in plugins/install.js
.
387 // Used for initializing annotation CSS rules only once.
388 Dygraph
.addedAnnotationCSS
= false;
390 Dygraph
.prototype.__old_init__
= function(div
, file
, labels
, attrs
) {
391 // Labels is no longer a constructor parameter, since it's typically set
392 // directly from the data source. It also conains a name for the x-axis,
393 // which the previous constructor form did not.
394 if (labels
!== null) {
395 var new_labels
= ["Date"];
396 for (var i
= 0; i
< labels
.length
; i
++) new_labels
.push(labels
[i
]);
397 Dygraph
.update(attrs
, { 'labels': new_labels
});
399 this.__init__(div
, file
, attrs
);
403 * Initializes the Dygraph. This creates a new DIV and constructs the PlotKit
404 * and context <canvas> inside of it. See the constructor for details.
406 * @param {Element} div the Element to render the graph into.
407 * @param {String | Function} file Source data
408 * @param {Object} attrs Miscellaneous other options
411 Dygraph
.prototype.__init__
= function(div
, file
, attrs
) {
412 // Hack for IE: if we're using excanvas and the document hasn't finished
413 // loading yet (and hence may not have initialized whatever it needs to
414 // initialize), then keep calling this routine periodically until it has.
415 if (/MSIE/.test(navigator
.userAgent
) && !window
.opera
&&
416 typeof(G_vmlCanvasManager
) != 'undefined' &&
417 document
.readyState
!= 'complete') {
419 setTimeout(function() { self
.__init__(div
, file
, attrs
); }, 100);
423 // Support two-argument constructor
424 if (attrs
=== null || attrs
=== undefined
) { attrs
= {}; }
426 attrs
= Dygraph
.mapLegacyOptions_(attrs
);
428 if (typeof(div
) == 'string') {
429 div
= document
.getElementById(div
);
433 Dygraph
.error("Constructing dygraph with a non-existent div!");
437 this.isUsingExcanvas_
= typeof(G_vmlCanvasManager
) != 'undefined';
439 // Copy the important bits into the object
440 // TODO(danvk): most of these should just stay in the attrs_ dictionary.
443 this.rollPeriod_
= attrs
.rollPeriod
|| Dygraph
.DEFAULT_ROLL_PERIOD
;
444 this.previousVerticalX_
= -1;
445 this.fractions_
= attrs
.fractions
|| false;
446 this.dateWindow_
= attrs
.dateWindow
|| null;
448 this.annotations_
= [];
450 // Zoomed indicators - These indicate when the graph has been zoomed and on what axis.
451 this.zoomed_x_
= false;
452 this.zoomed_y_
= false;
454 // Clear the div. This ensure that, if multiple dygraphs are passed the same
455 // div, then only one will be drawn.
458 // For historical reasons, the 'width' and 'height' options trump all CSS
459 // rules _except_ for an explicit 'width' or 'height' on the div.
460 // As an added convenience, if the div has zero height (like <div></div> does
461 // without any styles), then we use a default height/width
.
462 if (div
.style
.width
=== '' && attrs
.width
) {
463 div
.style
.width
= attrs
.width
+ "px";
465 if (div
.style
.height
=== '' && attrs
.height
) {
466 div
.style
.height
= attrs
.height
+ "px";
468 if (div
.style
.height
=== '' && div
.clientHeight
=== 0) {
469 div
.style
.height
= Dygraph
.DEFAULT_HEIGHT
+ "px";
470 if (div
.style
.width
=== '') {
471 div
.style
.width
= Dygraph
.DEFAULT_WIDTH
+ "px";
474 // These will be zero if the dygraph's div is hidden. In that case,
475 // use the user-specified attributes if present. If not, use zero
476 // and assume the user will call resize to fix things later.
477 this.width_
= div
.clientWidth
|| attrs
.width
|| 0;
478 this.height_
= div
.clientHeight
|| attrs
.height
|| 0;
480 // TODO(danvk): set fillGraph to be part of attrs_ here, not user_attrs_.
481 if (attrs
.stackedGraph
) {
482 attrs
.fillGraph
= true;
483 // TODO(nikhilk): Add any other stackedGraph checks here.
486 // DEPRECATION WARNING: All option processing should be moved from
487 // attrs_ and user_attrs_ to options_, which holds all this information.
489 // Dygraphs has many options, some of which interact with one another.
490 // To keep track of everything, we maintain two sets of options:
492 // this.user_attrs_ only options explicitly set by the user.
493 // this.attrs_ defaults, options derived from user_attrs_, data.
495 // Options are then accessed this.attr_('attr'), which first looks at
496 // user_attrs_ and then computed attrs_. This way Dygraphs can set intelligent
497 // defaults without overriding behavior that the user specifically asks for.
498 this.user_attrs_
= {};
499 Dygraph
.update(this.user_attrs_
, attrs
);
501 // This sequence ensures that Dygraph.DEFAULT_ATTRS is never modified.
503 Dygraph
.updateDeep(this.attrs_
, Dygraph
.DEFAULT_ATTRS
);
505 this.boundaryIds_
= [];
506 this.setIndexByName_
= {};
507 this.datasetIndex_
= [];
509 this.registeredEvents_
= [];
510 this.eventListeners_
= {};
512 this.attributes_
= new DygraphOptions(this);
514 // Create the containing DIV and other interactive elements
515 this.createInterface_();
519 var plugins
= Dygraph
.PLUGINS
.concat(this.getOption('plugins'));
520 for (var i
= 0; i
< plugins
.length
; i
++) {
521 var Plugin
= plugins
[i
];
522 var pluginInstance
= new Plugin();
524 plugin
: pluginInstance
,
530 var handlers
= pluginInstance
.activate(this);
531 for (var eventName
in handlers
) {
532 // TODO(danvk): validate eventName.
533 pluginDict
.events
[eventName
] = handlers
[eventName
];
536 this.plugins_
.push(pluginDict
);
539 // At this point, plugins can no longer register event handlers.
540 // Construct a map from event -> ordered list of [callback, plugin].
541 for (var i
= 0; i
< this.plugins_
.length
; i
++) {
542 var plugin_dict
= this.plugins_
[i
];
543 for (var eventName
in plugin_dict
.events
) {
544 if (!plugin_dict
.events
.hasOwnProperty(eventName
)) continue;
545 var callback
= plugin_dict
.events
[eventName
];
547 var pair
= [plugin_dict
.plugin
, callback
];
548 if (!(eventName
in this.eventListeners_
)) {
549 this.eventListeners_
[eventName
] = [pair
];
551 this.eventListeners_
[eventName
].push(pair
);
556 this.createDragInterface_();
562 * Triggers a cascade of events to the various plugins which are interested in them.
563 * Returns true if the "default behavior" should be performed, i.e. if none of
564 * the event listeners called event.preventDefault().
567 Dygraph
.prototype.cascadeEvents_
= function(name
, extra_props
) {
568 if (!(name
in this.eventListeners_
)) return true;
570 // QUESTION: can we use objects & prototypes to speed this up?
574 defaultPrevented
: false,
575 preventDefault
: function() {
576 if (!e
.cancelable
) throw "Cannot call preventDefault on non-cancelable event.";
577 e
.defaultPrevented
= true;
579 propagationStopped
: false,
580 stopPropagation
: function() {
581 e
.propagationStopped
= true;
584 Dygraph
.update(e
, extra_props
);
586 var callback_plugin_pairs
= this.eventListeners_
[name
];
587 if (callback_plugin_pairs
) {
588 for (var i
= callback_plugin_pairs
.length
- 1; i
>= 0; i
--) {
589 var plugin
= callback_plugin_pairs
[i
][0];
590 var callback
= callback_plugin_pairs
[i
][1];
591 callback
.call(plugin
, e
);
592 if (e
.propagationStopped
) break;
595 return e
.defaultPrevented
;
599 * Returns the zoomed status of the chart for one or both axes.
601 * Axis is an optional parameter. Can be set to 'x' or 'y'.
603 * The zoomed status for an axis is set whenever a user zooms using the mouse
604 * or when the dateWindow or valueRange are updated (unless the
605 * isZoomedIgnoreProgrammaticZoom option is also specified).
607 Dygraph
.prototype.isZoomed
= function(axis
) {
608 if (axis
=== null || axis
=== undefined
) {
609 return this.zoomed_x_
|| this.zoomed_y_
;
611 if (axis
=== 'x') return this.zoomed_x_
;
612 if (axis
=== 'y') return this.zoomed_y_
;
613 throw "axis parameter is [" + axis
+ "] must be null, 'x' or 'y'.";
617 * Returns information about the Dygraph object, including its containing ID.
619 Dygraph
.prototype.toString
= function() {
620 var maindiv
= this.maindiv_
;
621 var id
= (maindiv
&& maindiv
.id
) ? maindiv
.id
: maindiv
;
622 return "[Dygraph " + id
+ "]";
627 * Returns the value of an option. This may be set by the user (either in the
628 * constructor or by calling updateOptions) or by dygraphs, and may be set to a
630 * @param { String } name The name of the option, e.g. 'rollPeriod'.
631 * @param { String } [seriesName] The name of the series to which the option
632 * will be applied. If no per-series value of this option is available, then
633 * the global value is returned. This is optional.
634 * @return { ... } The value of the option.
636 Dygraph
.prototype.attr_
= function(name
, seriesName
) {
637 // <REMOVE_FOR_COMBINED>
638 if (typeof(Dygraph
.OPTIONS_REFERENCE
) === 'undefined') {
639 this.error('Must include options reference JS for testing');
640 } else if (!Dygraph
.OPTIONS_REFERENCE
.hasOwnProperty(name
)) {
641 this.error('Dygraphs is using property ' + name
+ ', which has no entry ' +
642 'in the Dygraphs.OPTIONS_REFERENCE listing.');
643 // Only log this error once.
644 Dygraph
.OPTIONS_REFERENCE
[name
] = true;
646 // </REMOVE_FOR_COMBINED
>
647 return seriesName
? this.attributes_
.getForSeries(name
, seriesName
) : this.attributes_
.get(name
);
651 * Returns the current value for an option, as set in the constructor or via
652 * updateOptions. You may pass in an (optional) series name to get per-series
653 * values for the option.
655 * All values returned by this method should be considered immutable. If you
656 * modify them, there is no guarantee that the changes will be honored or that
657 * dygraphs will remain in a consistent state. If you want to modify an option,
658 * use updateOptions() instead.
660 * @param { String } name The name of the option (e.g. 'strokeWidth')
661 * @param { String } [opt_seriesName] Series name to get per-series values.
662 * @return { ... } The value of the option.
664 Dygraph
.prototype.getOption
= function(name
, opt_seriesName
) {
665 return this.attr_(name
, opt_seriesName
);
668 Dygraph
.prototype.getOptionForAxis
= function(name
, axis
) {
669 return this.attributes_
.getForAxis(name
, axis
);
674 * @param String} axis The name of the axis (i.e. 'x', 'y' or 'y2')
675 * @return { ... } A function mapping string -> option value
677 Dygraph
.prototype.optionsViewForAxis_
= function(axis
) {
679 return function(opt
) {
680 var axis_opts
= self
.user_attrs_
.axes
;
681 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
682 return axis_opts
[axis
][opt
];
684 // user-specified attributes always trump defaults, even if they're less
686 if (typeof(self
.user_attrs_
[opt
]) != 'undefined') {
687 return self
.user_attrs_
[opt
];
690 axis_opts
= self
.attrs_
.axes
;
691 if (axis_opts
&& axis_opts
[axis
] && axis_opts
[axis
].hasOwnProperty(opt
)) {
692 return axis_opts
[axis
][opt
];
694 // check old-style axis options
695 // TODO(danvk): add a deprecation warning if either of these match.
696 if (axis
== 'y' && self
.axes_
[0].hasOwnProperty(opt
)) {
697 return self
.axes_
[0][opt
];
698 } else if (axis
== 'y2' && self
.axes_
[1].hasOwnProperty(opt
)) {
699 return self
.axes_
[1][opt
];
701 return self
.attr_(opt
);
706 * Returns the current rolling period, as set by the user or an option.
707 * @return {Number} The number of points in the rolling window
709 Dygraph
.prototype.rollPeriod
= function() {
710 return this.rollPeriod_
;
714 * Returns the currently-visible x-range. This can be affected by zooming,
715 * panning or a call to updateOptions.
716 * Returns a two-element array: [left, right].
717 * If the Dygraph has dates on the x-axis, these will be millis since epoch.
719 Dygraph
.prototype.xAxisRange
= function() {
720 return this.dateWindow_
? this.dateWindow_
: this.xAxisExtremes();
724 * Returns the lower- and upper-bound x-axis values of the
727 Dygraph
.prototype.xAxisExtremes
= function() {
728 var pad
= this.attr_('xRangePad') / this.plotter_
.area
.w
;
729 if (this.numRows() === 0) {
730 return [0 - pad
, 1 + pad
];
732 var left
= this.rawData_
[0][0];
733 var right
= this.rawData_
[this.rawData_
.length
- 1][0];
735 // Must keep this in sync with dygraph-layout _evaluateLimits()
736 var range
= right
- left
;
738 right
+= range
* pad
;
740 return [left
, right
];
744 * Returns the currently-visible y-range for an axis. This can be affected by
745 * zooming, panning or a call to updateOptions. Axis indices are zero-based. If
746 * called with no arguments, returns the range of the first axis.
747 * Returns a two-element array: [bottom, top].
749 Dygraph
.prototype.yAxisRange
= function(idx
) {
750 if (typeof(idx
) == "undefined") idx
= 0;
751 if (idx
< 0 || idx
>= this.axes_
.length
) {
754 var axis
= this.axes_
[idx
];
755 return [ axis
.computedValueRange
[0], axis
.computedValueRange
[1] ];
759 * Returns the currently-visible y-ranges for each axis. This can be affected by
760 * zooming, panning, calls to updateOptions, etc.
761 * Returns an array of [bottom, top] pairs, one for each y-axis.
763 Dygraph
.prototype.yAxisRanges
= function() {
765 for (var i
= 0; i
< this.axes_
.length
; i
++) {
766 ret
.push(this.yAxisRange(i
));
771 // TODO(danvk): use these functions throughout dygraphs.
773 * Convert from data coordinates to canvas/div X/Y coordinates.
774 * If specified, do this conversion for the coordinate system of a particular
775 * axis. Uses the first axis by default.
776 * Returns a two-element array: [X, Y]
778 * Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
779 * instead of toDomCoords(null, y, axis).
781 Dygraph
.prototype.toDomCoords
= function(x
, y
, axis
) {
782 return [ this.toDomXCoord(x
), this.toDomYCoord(y
, axis
) ];
786 * Convert from data x coordinates to canvas/div X coordinate.
787 * If specified, do this conversion for the coordinate system of a particular
789 * Returns a single value or null if x is null.
791 Dygraph
.prototype.toDomXCoord
= function(x
) {
796 var area
= this.plotter_
.area
;
797 var xRange
= this.xAxisRange();
798 return area
.x
+ (x
- xRange
[0]) / (xRange
[1] - xRange
[0]) * area
.w
;
802 * Convert from data x coordinates to canvas/div Y coordinate and optional
803 * axis. Uses the first axis by default.
805 * returns a single value or null if y is null.
807 Dygraph
.prototype.toDomYCoord
= function(y
, axis
) {
808 var pct
= this.toPercentYCoord(y
, axis
);
813 var area
= this.plotter_
.area
;
814 return area
.y
+ pct
* area
.h
;
818 * Convert from canvas/div coords to data coordinates.
819 * If specified, do this conversion for the coordinate system of a particular
820 * axis. Uses the first axis by default.
821 * Returns a two-element array: [X, Y].
823 * Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
824 * instead of toDataCoords(null, y, axis).
826 Dygraph
.prototype.toDataCoords
= function(x
, y
, axis
) {
827 return [ this.toDataXCoord(x
), this.toDataYCoord(y
, axis
) ];
831 * Convert from canvas/div x coordinate to data coordinate.
833 * If x is null, this returns null.
835 Dygraph
.prototype.toDataXCoord
= function(x
) {
840 var area
= this.plotter_
.area
;
841 var xRange
= this.xAxisRange();
842 return xRange
[0] + (x
- area
.x
) / area
.w
* (xRange
[1] - xRange
[0]);
846 * Convert from canvas/div y coord to value.
848 * If y is null, this returns null.
849 * if axis is null, this uses the first axis.
851 Dygraph
.prototype.toDataYCoord
= function(y
, axis
) {
856 var area
= this.plotter_
.area
;
857 var yRange
= this.yAxisRange(axis
);
859 if (typeof(axis
) == "undefined") axis
= 0;
860 if (!this.axes_
[axis
].logscale
) {
861 return yRange
[0] + (area
.y
+ area
.h
- y
) / area
.h
* (yRange
[1] - yRange
[0]);
863 // Computing the inverse of toDomCoord.
864 var pct
= (y
- area
.y
) / area
.h
;
866 // Computing the inverse of toPercentYCoord. The function was arrived at with
867 // the following steps:
869 // Original calcuation:
870 // pct = (logr1 - Dygraph.log10(y)) / (logr1
- Dygraph
.log10(yRange
[0]));
872 // Move denominator to both sides:
873 // pct * (logr1 - Dygraph.log10(yRange[0])) = logr1 - Dygraph.log10(y);
875 // subtract logr1, and take the negative value.
876 // logr1 - (pct * (logr1 - Dygraph.log10(yRange[0]))) = Dygraph.log10(y);
878 // Swap both sides of the equation, and we can compute the log of the
879 // return value. Which means we just need to use that as the exponent in
881 // Dygraph.log10(y) = logr1 - (pct * (logr1 - Dygraph.log10(yRange[0])));
883 var logr1
= Dygraph
.log10(yRange
[1]);
884 var exponent
= logr1
- (pct
* (logr1
- Dygraph
.log10(yRange
[0])));
885 var value
= Math
.pow(Dygraph
.LOG_SCALE
, exponent
);
891 * Converts a y for an axis to a percentage from the top to the
892 * bottom of the drawing area.
894 * If the coordinate represents a value visible on the canvas, then
895 * the value will be between 0 and 1, where 0 is the top of the canvas.
896 * However, this method will return values outside the range, as
897 * values can fall outside the canvas.
899 * If y is null, this returns null.
900 * if axis is null, this uses the first axis.
902 * @param { Number } y The data y-coordinate.
903 * @param { Number } [axis] The axis number on which the data coordinate lives.
904 * @return { Number } A fraction in [0, 1] where 0 = the top edge.
906 Dygraph
.prototype.toPercentYCoord
= function(y
, axis
) {
910 if (typeof(axis
) == "undefined") axis
= 0;
912 var yRange
= this.yAxisRange(axis
);
915 var logscale
= this.attributes_
.getForAxis("logscale", axis
);
917 // yRange[1] - y is unit distance from the bottom.
918 // yRange[1] - yRange[0] is the scale of the range.
919 // (yRange[1] - y) / (yRange
[1] - yRange
[0]) is the
% from the bottom
.
920 pct
= (yRange
[1] - y
) / (yRange
[1] - yRange
[0]);
922 var logr1
= Dygraph
.log10(yRange
[1]);
923 pct
= (logr1
- Dygraph
.log10(y
)) / (logr1
- Dygraph
.log10(yRange
[0]));
929 * Converts an x value to a percentage from the left to the right of
932 * If the coordinate represents a value visible on the canvas, then
933 * the value will be between 0 and 1, where 0 is the left of the canvas.
934 * However, this method will return values outside the range, as
935 * values can fall outside the canvas.
937 * If x is null, this returns null.
938 * @param { Number } x The data x-coordinate.
939 * @return { Number } A fraction in [0, 1] where 0 = the left edge.
941 Dygraph
.prototype.toPercentXCoord
= function(x
) {
946 var xRange
= this.xAxisRange();
947 return (x
- xRange
[0]) / (xRange
[1] - xRange
[0]);
951 * Returns the number of columns (including the independent variable).
952 * @return { Integer } The number of columns.
954 Dygraph
.prototype.numColumns
= function() {
955 if (!this.rawData_
) return 0;
956 return this.rawData_
[0] ? this.rawData_
[0].length
: this.attr_("labels").length
;
960 * Returns the number of rows (excluding any header/label row).
961 * @return { Integer } The number of rows, less any header.
963 Dygraph
.prototype.numRows
= function() {
964 if (!this.rawData_
) return 0;
965 return this.rawData_
.length
;
969 * Returns the value in the given row and column. If the row and column exceed
970 * the bounds on the data, returns null. Also returns null if the value is
972 * @param { Number} row The row number of the data (0-based). Row 0 is the
973 * first row of data, not a header row.
974 * @param { Number} col The column number of the data (0-based)
975 * @return { Number } The value in the specified cell or null if the row/col
978 Dygraph
.prototype.getValue
= function(row
, col
) {
979 if (row
< 0 || row
> this.rawData_
.length
) return null;
980 if (col
< 0 || col
> this.rawData_
[row
].length
) return null;
982 return this.rawData_
[row
][col
];
986 * Generates interface elements for the Dygraph: a containing div, a div to
987 * display the current point, and a textbox to adjust the rolling average
988 * period. Also creates the Renderer/Layout elements.
991 Dygraph
.prototype.createInterface_
= function() {
992 // Create the all-enclosing graph div
993 var enclosing
= this.maindiv_
;
995 this.graphDiv
= document
.createElement("div");
997 // TODO(danvk): any other styles that are useful to set here?
998 this.graphDiv
.style
.textAlign
= 'left'; // This is a CSS "reset"
999 enclosing
.appendChild(this.graphDiv
);
1001 // Create the canvas for interactive parts of the chart.
1002 this.canvas_
= Dygraph
.createCanvas();
1003 this.canvas_
.style
.position
= "absolute";
1005 // ... and for static parts of the chart.
1006 this.hidden_
= this.createPlotKitCanvas_(this.canvas_
);
1008 this.resizeElements_();
1010 this.canvas_ctx_
= Dygraph
.getContext(this.canvas_
);
1011 this.hidden_ctx_
= Dygraph
.getContext(this.hidden_
);
1013 // The interactive parts of the graph are drawn on top of the chart.
1014 this.graphDiv
.appendChild(this.hidden_
);
1015 this.graphDiv
.appendChild(this.canvas_
);
1016 this.mouseEventElement_
= this.createMouseEventElement_();
1018 // Create the grapher
1019 this.layout_
= new DygraphLayout(this);
1023 this.mouseMoveHandler_
= function(e
) {
1024 dygraph
.mouseMove_(e
);
1027 this.mouseOutHandler_
= function(e
) {
1028 // The mouse has left the chart if:
1029 // 1. e.target is inside the chart
1030 // 2. e.relatedTarget is outside the chart
1031 var target
= e
.target
|| e
.fromElement
;
1032 var relatedTarget
= e
.relatedTarget
|| e
.toElement
;
1033 if (Dygraph
.isNodeContainedBy(target
, dygraph
.graphDiv
) &&
1034 !Dygraph
.isNodeContainedBy(relatedTarget
, dygraph
.graphDiv
)) {
1035 dygraph
.mouseOut_(e
);
1039 this.addAndTrackEvent(window
, 'mouseout', this.mouseOutHandler_
);
1040 this.addAndTrackEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1042 // Don't recreate and register the resize handler on subsequent calls.
1043 // This happens when the graph is resized.
1044 if (!this.resizeHandler_
) {
1045 this.resizeHandler_
= function(e
) {
1049 // Update when the window is resized.
1050 // TODO(danvk): drop frames depending on complexity of the chart.
1051 this.addAndTrackEvent(window
, 'resize', this.resizeHandler_
);
1055 Dygraph
.prototype.resizeElements_
= function() {
1056 this.graphDiv
.style
.width
= this.width_
+ "px";
1057 this.graphDiv
.style
.height
= this.height_
+ "px";
1058 this.canvas_
.width
= this.width_
;
1059 this.canvas_
.height
= this.height_
;
1060 this.canvas_
.style
.width
= this.width_
+ "px"; // for IE
1061 this.canvas_
.style
.height
= this.height_
+ "px"; // for IE
1062 this.hidden_
.width
= this.width_
;
1063 this.hidden_
.height
= this.height_
;
1064 this.hidden_
.style
.width
= this.width_
+ "px"; // for IE
1065 this.hidden_
.style
.height
= this.height_
+ "px"; // for IE
1069 * Detach DOM elements in the dygraph and null out all data references.
1070 * Calling this when you're done with a dygraph can dramatically reduce memory
1071 * usage. See, e.g., the tests/perf.html example.
1073 Dygraph
.prototype.destroy
= function() {
1074 this.canvas_ctx_
.restore();
1075 this.hidden_ctx_
.restore();
1077 var removeRecursive
= function(node
) {
1078 while (node
.hasChildNodes()) {
1079 removeRecursive(node
.firstChild
);
1080 node
.removeChild(node
.firstChild
);
1084 this.removeTrackedEvents_();
1086 // remove mouse event handlers (This may not be necessary anymore)
1087 Dygraph
.removeEvent(window
, 'mouseout', this.mouseOutHandler_
);
1088 Dygraph
.removeEvent(this.mouseEventElement_
, 'mousemove', this.mouseMoveHandler_
);
1090 // remove window handlers
1091 Dygraph
.removeEvent(window
,'resize',this.resizeHandler_
);
1092 this.resizeHandler_
= null;
1094 removeRecursive(this.maindiv_
);
1096 var nullOut
= function(obj
) {
1097 for (var n
in obj
) {
1098 if (typeof(obj
[n
]) === 'object') {
1103 // These may not all be necessary, but it can't hurt...
1104 nullOut(this.layout_
);
1105 nullOut(this.plotter_
);
1110 * Creates the canvas on which the chart will be drawn. Only the Renderer ever
1111 * draws on this particular canvas. All Dygraph work (i.e. drawing hover dots
1112 * or the zoom rectangles) is done on this.canvas_.
1113 * @param {Object} canvas The Dygraph canvas over which to overlay the plot
1114 * @return {Object} The newly-created canvas
1117 Dygraph
.prototype.createPlotKitCanvas_
= function(canvas
) {
1118 var h
= Dygraph
.createCanvas();
1119 h
.style
.position
= "absolute";
1120 // TODO(danvk): h should be offset from canvas. canvas needs to include
1121 // some extra area to make it easier to zoom in on the far left and far
1122 // right. h needs to be precisely the plot area, so that clipping occurs.
1123 h
.style
.top
= canvas
.style
.top
;
1124 h
.style
.left
= canvas
.style
.left
;
1125 h
.width
= this.width_
;
1126 h
.height
= this.height_
;
1127 h
.style
.width
= this.width_
+ "px"; // for IE
1128 h
.style
.height
= this.height_
+ "px"; // for IE
1133 * Creates an overlay element used to handle mouse events.
1134 * @return {Object} The mouse event element.
1137 Dygraph
.prototype.createMouseEventElement_
= function() {
1138 if (this.isUsingExcanvas_
) {
1139 var elem
= document
.createElement("div");
1140 elem
.style
.position
= 'absolute';
1141 elem
.style
.backgroundColor
= 'white';
1142 elem
.style
.filter
= 'alpha(opacity=0)';
1143 elem
.style
.width
= this.width_
+ "px";
1144 elem
.style
.height
= this.height_
+ "px";
1145 this.graphDiv
.appendChild(elem
);
1148 return this.canvas_
;
1153 * Generate a set of distinct colors for the data series. This is done with a
1154 * color wheel. Saturation/Value are customizable, and the hue is
1155 * equally-spaced around the color wheel. If a custom set of colors is
1156 * specified, that is used instead.
1159 Dygraph
.prototype.setColors_
= function() {
1160 var labels
= this.getLabels();
1161 var num
= labels
.length
- 1;
1163 this.colorsMap_
= {};
1164 var colors
= this.attr_('colors');
1167 var sat
= this.attr_('colorSaturation') || 1.0;
1168 var val
= this.attr_('colorValue') || 0.5;
1169 var half
= Math
.ceil(num
/ 2);
1170 for (i
= 1; i
<= num
; i
++) {
1171 if (!this.visibility()[i
-1]) continue;
1172 // alternate colors for high contrast.
1173 var idx
= i
% 2 ? Math
.ceil(i
/ 2) : (half + i / 2);
1174 var hue
= (1.0 * idx
/ (1 + num
));
1175 var colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1176 this.colors_
.push(colorStr
);
1177 this.colorsMap_
[labels
[i
]] = colorStr
;
1180 for (i
= 0; i
< num
; i
++) {
1181 if (!this.visibility()[i
]) continue;
1182 var colorStr
= colors
[i
% colors
.length
];
1183 this.colors_
.push(colorStr
);
1184 this.colorsMap_
[labels
[1 + i
]] = colorStr
;
1190 * Return the list of colors. This is either the list of colors passed in the
1191 * attributes or the autogenerated list of rgb(r,g,b) strings.
1192 * This does not return colors for invisible series.
1193 * @return {Array<string>} The list of colors.
1195 Dygraph
.prototype.getColors
= function() {
1196 return this.colors_
;
1200 * Returns a few attributes of a series, i.e. its color, its visibility, which
1201 * axis it's assigned to, and its column in the original data.
1202 * Returns null if the series does not exist.
1203 * Otherwise, returns an object with column, visibility, color and axis properties.
1204 * The "axis" property will be set to 1 for y1 and 2 for y2.
1205 * The "column" property can be fed back into getValue(row, column) to get
1206 * values for this series.
1208 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1210 var labels
= this.getLabels();
1211 for (var i
= 1; i
< labels
.length
; i
++) {
1212 if (labels
[i
] == series_name
) {
1217 if (idx
== -1) return null;
1222 visible
: this.visibility()[idx
- 1],
1223 color
: this.colorsMap_
[series_name
],
1224 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1229 * Create the text box to adjust the averaging period
1232 Dygraph
.prototype.createRollInterface_
= function() {
1233 // Create a roller if one doesn't exist already.
1234 if (!this.roller_
) {
1235 this.roller_
= document
.createElement("input");
1236 this.roller_
.type
= "text";
1237 this.roller_
.style
.display
= "none";
1238 this.graphDiv
.appendChild(this.roller_
);
1241 var display
= this.attr_('showRoller') ? 'block' : 'none';
1243 var area
= this.plotter_
.area
;
1244 var textAttr
= { "position": "absolute",
1246 "top": (area
.y
+ area
.h
- 25) + "px",
1247 "left": (area
.x
+ 1) + "px",
1250 this.roller_
.size
= "2";
1251 this.roller_
.value
= this.rollPeriod_
;
1252 for (var name
in textAttr
) {
1253 if (textAttr
.hasOwnProperty(name
)) {
1254 this.roller_
.style
[name
] = textAttr
[name
];
1259 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1264 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1265 * canvas (i.e. DOM Coords).
1267 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1268 return Dygraph
.pageX(e
) - context
.px
;
1273 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1274 * canvas (i.e. DOM Coords).
1276 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1277 return Dygraph
.pageY(e
) - context
.py
;
1281 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1285 Dygraph
.prototype.createDragInterface_
= function() {
1287 // Tracks whether the mouse is down right now
1289 isPanning
: false, // is this drag part of a pan?
1290 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1291 dragStartX
: null, // pixel coordinates
1292 dragStartY
: null, // pixel coordinates
1293 dragEndX
: null, // pixel coordinates
1294 dragEndY
: null, // pixel coordinates
1295 dragDirection
: null,
1296 prevEndX
: null, // pixel coordinates
1297 prevEndY
: null, // pixel coordinates
1298 prevDragDirection
: null,
1299 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1301 // The value on the left side of the graph when a pan operation starts.
1302 initialLeftmostDate
: null,
1304 // The number of units each pixel spans. (This won't be valid for log
1306 xUnitsPerPixel
: null,
1308 // TODO(danvk): update this comment
1309 // The range in second/value units that the viewport encompasses during a
1310 // panning operation.
1313 // Top-left corner of the canvas, in DOM coords
1314 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1318 // Values for use with panEdgeFraction, which limit how far outside the
1319 // graph's data boundaries it can be panned.
1320 boundedDates
: null, // [minDate, maxDate]
1321 boundedValues
: null, // [[minValue, maxValue] ...]
1323 // We cover iframes during mouse interactions. See comments in
1324 // dygraph-utils.js for more info on why this is a good idea.
1325 tarp
: new Dygraph
.IFrameTarp(),
1327 // contextB is the same thing as this context object but renamed.
1328 initializeMouseDown
: function(event
, g
, contextB
) {
1329 // prevents mouse drags from selecting page text.
1330 if (event
.preventDefault
) {
1331 event
.preventDefault(); // Firefox, Chrome, etc.
1333 event
.returnValue
= false; // IE
1334 event
.cancelBubble
= true;
1337 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1338 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1339 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1340 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1341 contextB
.cancelNextDblclick
= false;
1342 contextB
.tarp
.cover();
1346 var interactionModel
= this.attr_("interactionModel");
1348 // Self is the graph.
1351 // Function that binds the graph and context to the handler.
1352 var bindHandler
= function(handler
) {
1353 return function(event
) {
1354 handler(event
, self
, context
);
1358 for (var eventName
in interactionModel
) {
1359 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1360 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1361 bindHandler(interactionModel
[eventName
]));
1364 // If the user releases the mouse button during a drag, but not over the
1365 // canvas, then it doesn't count as a zooming action.
1366 var mouseUpHandler
= function(event
) {
1367 if (context
.isZooming
|| context
.isPanning
) {
1368 context
.isZooming
= false;
1369 context
.dragStartX
= null;
1370 context
.dragStartY
= null;
1373 if (context
.isPanning
) {
1374 context
.isPanning
= false;
1375 context
.draggingDate
= null;
1376 context
.dateRange
= null;
1377 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1378 delete self
.axes_
[i
].draggingValue
;
1379 delete self
.axes_
[i
].dragValueRange
;
1383 context
.tarp
.uncover();
1386 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1390 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1391 * up any previous zoom rectangles that were drawn. This could be optimized to
1392 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1395 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1396 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1397 * @param {Number} startX The X position where the drag started, in canvas
1399 * @param {Number} endX The current X position of the drag, in canvas coords.
1400 * @param {Number} startY The Y position where the drag started, in canvas
1402 * @param {Number} endY The current Y position of the drag, in canvas coords.
1403 * @param {Number} prevDirection the value of direction on the previous call to
1404 * this function. Used to avoid excess redrawing
1405 * @param {Number} prevEndX The value of endX on the previous call to this
1406 * function. Used to avoid excess redrawing
1407 * @param {Number} prevEndY The value of endY on the previous call to this
1408 * function. Used to avoid excess redrawing
1411 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1412 endY
, prevDirection
, prevEndX
,
1414 var ctx
= this.canvas_ctx_
;
1416 // Clean up from the previous rect if necessary
1417 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1418 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1419 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1420 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1421 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1422 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1425 // Draw a light-grey rectangle to show the new viewing area
1426 if (direction
== Dygraph
.HORIZONTAL
) {
1427 if (endX
&& startX
) {
1428 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1429 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1430 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1432 } else if (direction
== Dygraph
.VERTICAL
) {
1433 if (endY
&& startY
) {
1434 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1435 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1436 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1440 if (this.isUsingExcanvas_
) {
1441 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1446 * Clear the zoom rectangle (and perform no zoom).
1449 Dygraph
.prototype.clearZoomRect_
= function() {
1450 this.currentZoomRectArgs_
= null;
1451 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1455 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1456 * the canvas. The exact zoom window may be slightly larger if there are no data
1457 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1458 * which accepts dates that match the raw data. This function redraws the graph.
1460 * @param {Number} lowX The leftmost pixel value that should be visible.
1461 * @param {Number} highX The rightmost pixel value that should be visible.
1464 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1465 this.currentZoomRectArgs_
= null;
1466 // Find the earliest and latest dates contained in this canvasx range.
1467 // Convert the call to date ranges of the raw data.
1468 var minDate
= this.toDataXCoord(lowX
);
1469 var maxDate
= this.toDataXCoord(highX
);
1470 this.doZoomXDates_(minDate
, maxDate
);
1474 * Transition function to use in animations. Returns values between 0.0
1475 * (totally old values) and 1.0 (totally new values) for each frame.
1478 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1480 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1484 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1485 * method with doZoomX which accepts pixel coordinates. This function redraws
1488 * @param {Number} minDate The minimum date that should be visible.
1489 * @param {Number} maxDate The maximum date that should be visible.
1492 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1493 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1494 // can produce strange effects. Rather than the y-axis transitioning slowly
1495 // between values, it can jerk around.)
1496 var old_window
= this.xAxisRange();
1497 var new_window
= [minDate
, maxDate
];
1498 this.zoomed_x_
= true;
1500 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1501 if (that
.attr_("zoomCallback")) {
1502 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1508 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1509 * the canvas. This function redraws the graph.
1511 * @param {Number} lowY The topmost pixel value that should be visible.
1512 * @param {Number} highY The lowest pixel value that should be visible.
1515 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1516 this.currentZoomRectArgs_
= null;
1517 // Find the highest and lowest values in pixel range for each axis.
1518 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1519 // This is because pixels increase as you go down on the screen, whereas data
1520 // coordinates increase as you go up the screen.
1521 var oldValueRanges
= this.yAxisRanges();
1522 var newValueRanges
= [];
1523 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1524 var hi
= this.toDataYCoord(lowY
, i
);
1525 var low
= this.toDataYCoord(highY
, i
);
1526 newValueRanges
.push([low
, hi
]);
1529 this.zoomed_y_
= true;
1531 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1532 if (that
.attr_("zoomCallback")) {
1533 var xRange
= that
.xAxisRange();
1534 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1540 * Reset the zoom to the original view coordinates. This is the same as
1541 * double-clicking on the graph.
1543 Dygraph
.prototype.resetZoom
= function() {
1544 var dirty
= false, dirtyX
= false, dirtyY
= false;
1545 if (this.dateWindow_
!== null) {
1550 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1551 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1557 // Clear any selection, since it's likely to be drawn in the wrong place.
1558 this.clearSelection();
1561 this.zoomed_x_
= false;
1562 this.zoomed_y_
= false;
1564 var minDate
= this.rawData_
[0][0];
1565 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1567 // With only one frame, don't bother calculating extreme ranges.
1568 // TODO(danvk): merge this block w/ the code below
.
1569 if (!this.attr_("animatedZooms")) {
1570 this.dateWindow_
= null;
1571 for (i
= 0; i
< this.axes_
.length
; i
++) {
1572 if (this.axes_
[i
].valueWindow
!== null) {
1573 delete this.axes_
[i
].valueWindow
;
1577 if (this.attr_("zoomCallback")) {
1578 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1583 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1585 oldWindow
= this.xAxisRange();
1586 newWindow
= [minDate
, maxDate
];
1590 oldValueRanges
= this.yAxisRanges();
1591 // TODO(danvk): this is pretty inefficient
1592 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1593 var extremes
= packed
.extremes
;
1595 // this has the side-effect of modifying this.axes_.
1596 // this doesn't make much sense in this context, but it's convenient (we
1597 // need this.axes_[*].extremeValues) and not harmful since we'll be
1598 // calling drawGraph_ shortly, which clobbers these values.
1599 this.computeYAxisRanges_(extremes
);
1601 newValueRanges
= [];
1602 for (i
= 0; i
< this.axes_
.length
; i
++) {
1603 var axis
= this.axes_
[i
];
1604 newValueRanges
.push((axis
.valueRange
!== null &&
1605 axis
.valueRange
!== undefined
) ?
1606 axis
.valueRange
: axis
.extremeRange
);
1611 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1613 that
.dateWindow_
= null;
1614 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1615 if (that
.axes_
[i
].valueWindow
!== null) {
1616 delete that
.axes_
[i
].valueWindow
;
1619 if (that
.attr_("zoomCallback")) {
1620 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1627 * Combined animation logic for all zoom functions.
1628 * either the x parameters or y parameters may be null.
1631 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1632 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1635 var valueRanges
= [];
1638 if (oldXRange
!== null && newXRange
!== null) {
1639 for (step
= 1; step
<= steps
; step
++) {
1640 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1641 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1642 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1646 if (oldYRanges
!== null && newYRanges
!== null) {
1647 for (step
= 1; step
<= steps
; step
++) {
1648 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1650 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1651 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1652 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1654 valueRanges
[step
-1] = thisRange
;
1659 Dygraph
.repeatAndCleanup(function(step
) {
1660 if (valueRanges
.length
) {
1661 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1662 var w
= valueRanges
[step
][i
];
1663 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1666 if (windows
.length
) {
1667 that
.dateWindow_
= windows
[step
];
1670 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1674 * Get the current graph's area object.
1676 * Returns: {x, y, w, h}
1678 Dygraph
.prototype.getArea
= function() {
1679 return this.plotter_
.area
;
1683 * Convert a mouse event to DOM coordinates relative to the graph origin.
1685 * Returns a two-element array: [X, Y].
1687 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1688 if (event
.offsetX
&& event
.offsetY
) {
1689 return [ event
.offsetX
, event
.offsetY
];
1691 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1692 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1693 return [canvasx
, canvasy
];
1698 * Given a canvas X coordinate, find the closest row.
1699 * @param {Number} domX graph-relative DOM X coordinate
1700 * Returns: row number, integer
1703 Dygraph
.prototype.findClosestRow
= function(domX
) {
1704 var minDistX
= Infinity
;
1705 var closestRow
= -1;
1706 var sets
= this.layout_
.points
;
1707 for (var i
= 0; i
< sets
.length
; i
++) {
1708 var points
= sets
[i
];
1709 var len
= points
.length
;
1710 for (var j
= 0; j
< len
; j
++) {
1711 var point
= points
[j
];
1712 if (!Dygraph
.isValidPoint(point
, true)) continue;
1713 var dist
= Math
.abs(point
.canvasx
- domX
);
1714 if (dist
< minDistX
) {
1716 closestRow
= point
.idx
;
1725 * Given canvas X,Y coordinates, find the closest point.
1727 * This finds the individual data point across all visible series
1728 * that's closest to the supplied DOM coordinates using the standard
1729 * Euclidean X,Y distance.
1731 * @param {Number} domX graph-relative DOM X coordinate
1732 * @param {Number} domY graph-relative DOM Y coordinate
1733 * Returns: {row, seriesName, point}
1736 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1737 var minDist
= Infinity
;
1738 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1739 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1740 var points
= this.layout_
.points
[setIdx
];
1741 for (var i
= 0; i
< points
.length
; ++i
) {
1743 if (!Dygraph
.isValidPoint(point
)) continue;
1744 dx
= point
.canvasx
- domX
;
1745 dy
= point
.canvasy
- domY
;
1746 dist
= dx
* dx
+ dy
* dy
;
1747 if (dist
< minDist
) {
1749 closestPoint
= point
;
1750 closestSeries
= setIdx
;
1751 closestRow
= point
.idx
;
1755 var name
= this.layout_
.setNames
[closestSeries
];
1764 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1766 * This first finds the X data point closest to the supplied DOM X coordinate,
1767 * then finds the series which puts the Y coordinate on top of its filled area,
1768 * using linear interpolation between adjacent point pairs.
1770 * @param {Number} domX graph-relative DOM X coordinate
1771 * @param {Number} domY graph-relative DOM Y coordinate
1772 * Returns: {row, seriesName, point}
1775 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1776 var row
= this.findClosestRow(domX
);
1777 var closestPoint
, closestSeries
;
1778 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1779 var boundary
= this.getLeftBoundary_(setIdx
);
1780 var rowIdx
= row
- boundary
;
1781 var points
= this.layout_
.points
[setIdx
];
1782 if (rowIdx
>= points
.length
) continue;
1783 var p1
= points
[rowIdx
];
1784 if (!Dygraph
.isValidPoint(p1
)) continue;
1785 var py
= p1
.canvasy
;
1786 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1787 // interpolate series Y value using next point
1788 var p2
= points
[rowIdx
+ 1];
1789 if (Dygraph
.isValidPoint(p2
)) {
1790 var dx
= p2
.canvasx
- p1
.canvasx
;
1792 var r
= (domX
- p1
.canvasx
) / dx
;
1793 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1796 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1797 // interpolate series Y value using previous point
1798 var p0
= points
[rowIdx
- 1];
1799 if (Dygraph
.isValidPoint(p0
)) {
1800 var dx
= p1
.canvasx
- p0
.canvasx
;
1802 var r
= (p1
.canvasx
- domX
) / dx
;
1803 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1807 // Stop if the point (domX, py) is above this series' upper edge
1808 if (setIdx
=== 0 || py
< domY
) {
1810 closestSeries
= setIdx
;
1813 var name
= this.layout_
.setNames
[closestSeries
];
1822 * When the mouse moves in the canvas, display information about a nearby data
1823 * point and draw dots over those points in the data series. This function
1824 * takes care of cleanup of previously-drawn dots.
1825 * @param {Object} event The mousemove event from the browser.
1828 Dygraph
.prototype.mouseMove_
= function(event
) {
1829 // This prevents JS errors when mousing over the canvas before data loads.
1830 var points
= this.layout_
.points
;
1831 if (points
=== undefined
|| points
=== null) return;
1833 var canvasCoords
= this.eventToDomCoords(event
);
1834 var canvasx
= canvasCoords
[0];
1835 var canvasy
= canvasCoords
[1];
1837 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1838 var selectionChanged
= false;
1839 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1841 if (this.attr_("stackedGraph")) {
1842 closest
= this.findStackedPoint(canvasx
, canvasy
);
1844 closest
= this.findClosestPoint(canvasx
, canvasy
);
1846 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1848 var idx
= this.findClosestRow(canvasx
);
1849 selectionChanged
= this.setSelection(idx
);
1852 var callback
= this.attr_("highlightCallback");
1853 if (callback
&& selectionChanged
) {
1858 this.highlightSet_
);
1863 * Fetch left offset from the specified set index or if not passed, the
1864 * first defined boundaryIds record (see bug #236).
1867 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1868 if (this.boundaryIds_
[setIdx
]) {
1869 return this.boundaryIds_
[setIdx
][0];
1871 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1872 if (this.boundaryIds_
[i
] !== undefined
) {
1873 return this.boundaryIds_
[i
][0];
1880 Dygraph
.prototype.animateSelection_
= function(direction
) {
1881 var totalSteps
= 10;
1883 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1884 if (this.animateId
=== undefined
) this.animateId
= 0;
1885 var start
= this.fadeLevel
;
1886 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1888 if (this.fadeLevel
) {
1889 this.updateSelection_(1.0);
1894 var thisId
= ++this.animateId
;
1896 Dygraph
.repeatAndCleanup(
1898 // ignore simultaneous animations
1899 if (that
.animateId
!= thisId
) return;
1901 that
.fadeLevel
+= direction
;
1902 if (that
.fadeLevel
=== 0) {
1903 that
.clearSelection();
1905 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1908 steps
, millis
, function() {});
1912 * Draw dots over the selectied points in the data series. This function
1913 * takes care of cleanup of previously-drawn dots.
1916 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1917 /*var defaultPrevented = */
1918 this.cascadeEvents_('select', {
1919 selectedX
: this.lastx_
,
1920 selectedPoints
: this.selPoints_
1922 // TODO(danvk): use defaultPrevented here?
1924 // Clear the previously drawn vertical, if there is one
1926 var ctx
= this.canvas_ctx_
;
1927 if (this.attr_('highlightSeriesOpts')) {
1928 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1929 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1931 // Activating background fade includes an animation effect for a gradual
1932 // fade. TODO(klausw): make this independently configurable if it causes
1933 // issues? Use a shared preference to control animations?
1934 var animateBackgroundFade
= true;
1935 if (animateBackgroundFade
) {
1936 if (opt_animFraction
=== undefined
) {
1937 // start a new animation
1938 this.animateSelection_(1);
1941 alpha
*= opt_animFraction
;
1943 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1944 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1947 // Redraw only the highlighted series in the interactive canvas (not the
1948 // static plot canvas, which is where series are usually drawn).
1949 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1950 } else if (this.previousVerticalX_
>= 0) {
1951 // Determine the maximum highlight circle size.
1952 var maxCircleSize
= 0;
1953 var labels
= this.attr_('labels');
1954 for (i
= 1; i
< labels
.length
; i
++) {
1955 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1956 if (r
> maxCircleSize
) maxCircleSize
= r
;
1958 var px
= this.previousVerticalX_
;
1959 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1960 2 * maxCircleSize
+ 2, this.height_
);
1963 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1964 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1967 if (this.selPoints_
.length
> 0) {
1968 // Draw colored circles over the center of each selected point
1969 var canvasx
= this.selPoints_
[0].canvasx
;
1971 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1972 var pt
= this.selPoints_
[i
];
1973 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1975 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1976 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1977 var color
= this.plotter_
.colors
[pt
.name
];
1979 callback
= Dygraph
.Circles
.DEFAULT
;
1981 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1982 ctx
.strokeStyle
= color
;
1983 ctx
.fillStyle
= color
;
1984 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1985 color
, circleSize
, pt
.idx
);
1989 this.previousVerticalX_
= canvasx
;
1994 * Manually set the selected points and display information about them in the
1995 * legend. The selection can be cleared using clearSelection() and queried
1996 * using getSelection().
1997 * @param { Integer } row number that should be highlighted (i.e. appear with
1998 * hover dots on the chart). Set to false to clear any selection.
1999 * @param { seriesName } optional series name to highlight that series with the
2000 * the highlightSeriesOpts setting.
2001 * @param { locked } optional If true, keep seriesName selected when mousing
2002 * over the graph, disabling closest-series highlighting. Call clearSelection()
2005 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2006 // Extract the points we've selected
2007 this.selPoints_
= [];
2009 var changed
= false;
2010 if (row
!== false && row
>= 0) {
2011 if (row
!= this.lastRow_
) changed
= true;
2012 this.lastRow_
= row
;
2013 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2014 var points
= this.layout_
.points
[setIdx
];
2015 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2016 if (setRow
< points
.length
) {
2017 var point
= points
[setRow
];
2018 if (point
.yval
!== null) this.selPoints_
.push(point
);
2022 if (this.lastRow_
>= 0) changed
= true;
2026 if (this.selPoints_
.length
) {
2027 this.lastx_
= this.selPoints_
[0].xval
;
2032 if (opt_seriesName
!== undefined
) {
2033 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2034 this.highlightSet_
= opt_seriesName
;
2037 if (opt_locked
!== undefined
) {
2038 this.lockedSet_
= opt_locked
;
2042 this.updateSelection_(undefined
);
2048 * The mouse has left the canvas. Clear out whatever artifacts remain
2049 * @param {Object} event the mouseout event from the browser.
2052 Dygraph
.prototype.mouseOut_
= function(event
) {
2053 if (this.attr_("unhighlightCallback")) {
2054 this.attr_("unhighlightCallback")(event
);
2057 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2058 this.clearSelection();
2063 * Clears the current selection (i.e. points that were highlighted by moving
2064 * the mouse over the chart).
2066 Dygraph
.prototype.clearSelection
= function() {
2067 this.cascadeEvents_('deselect', {});
2069 this.lockedSet_
= false;
2070 // Get rid of the overlay data
2071 if (this.fadeLevel
) {
2072 this.animateSelection_(-1);
2075 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2077 this.selPoints_
= [];
2080 this.highlightSet_
= null;
2084 * Returns the number of the currently selected row. To get data for this row,
2085 * you can use the getValue method.
2086 * @return { Integer } row number, or -1 if nothing is selected
2088 Dygraph
.prototype.getSelection
= function() {
2089 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2093 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2094 var points
= this.layout_
.points
[setIdx
];
2095 for (var row
= 0; row
< points
.length
; row
++) {
2096 if (points
[row
].x
== this.selPoints_
[0].x
) {
2097 return points
[row
].idx
;
2105 * Returns the name of the currently-highlighted series.
2106 * Only available when the highlightSeriesOpts option is in use.
2108 Dygraph
.prototype.getHighlightSeries
= function() {
2109 return this.highlightSet_
;
2113 * Returns true if the currently-highlighted series was locked
2114 * via setSelection(..., seriesName, true).
2116 Dygraph
.prototype.isSeriesLocked
= function() {
2117 return this.lockedSet_
;
2121 * Fires when there's data available to be graphed.
2122 * @param {String} data Raw CSV data to be plotted
2125 Dygraph
.prototype.loadedEvent_
= function(data
) {
2126 this.rawData_
= this.parseCSV_(data
);
2131 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2134 Dygraph
.prototype.addXTicks_
= function() {
2135 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2137 if (this.dateWindow_
) {
2138 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2140 range
= this.xAxisExtremes();
2143 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2144 var xTicks
= xAxisOptionsView('ticker')(
2147 this.width_
, // TODO(danvk): should be area.width
2150 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2151 // console.log(msg);
2152 this.layout_
.setXTicks(xTicks
);
2157 * Returns the correct handler ID for the currently set options.
2158 * The actual handler may then be retrieved using the
2159 * Dygraph.DataHandlers.getHandler() method.
2161 Dygraph
.prototype.getHandlerId_
= function() {
2163 if (this.attr_("dataHandlerId")) {
2164 handlerId
= this.attr_("dataHandlerId");
2165 } else if (this.fractions_
){
2166 if (this.attr_("errorBars")) {
2167 handlerId
= "bars-fractions";
2169 handlerId
= "default-fractions";
2171 } else if (this.attr_("customBars")) {
2172 handlerId
= "bars-custom";
2173 } else if (this.attr_("errorBars")) {
2174 handlerId
= "bars-error";
2176 handlerId
= "default";
2183 * This function is called once when the chart's data is changed or the options
2184 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2185 * idea is that values derived from the chart's data can be computed here,
2186 * rather than every time the chart is drawn. This includes things like the
2187 * number of axes, rolling averages, etc.
2189 Dygraph
.prototype.predraw_
= function() {
2190 var start
= new Date();
2192 // Create the correct dataHandler
2193 this.dataHandler_
= new (Dygraph
.DataHandlers
.getHandler(this.getHandlerId_()))();
2195 this.layout_
.computePlotArea();
2197 // TODO(danvk): move more computations out of drawGraph_ and into here.
2198 this.computeYAxes_();
2200 // Create a new plotter.
2201 if (this.plotter_
) {
2202 this.cascadeEvents_('clearChart');
2203 this.plotter_
.clear();
2206 if (!this.is_initial_draw_
) {
2207 this.canvas_ctx_
.restore();
2208 this.hidden_ctx_
.restore();
2211 this.canvas_ctx_
.save();
2212 this.hidden_ctx_
.save();
2214 this.plotter_
= new DygraphCanvasRenderer(this,
2219 // The roller sits in the bottom left corner of the chart. We don't know where
2220 // this will be until the options are available, so it's positioned here.
2221 this.createRollInterface_();
2223 this.cascadeEvents_('predraw');
2225 // Convert the raw data (a 2D array) into the internal format and compute
2226 // rolling averages.
2227 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2228 for (var i
= 1; i
< this.numColumns(); i
++) {
2229 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2230 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2231 if (this.rollPeriod_
> 1) {
2232 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2235 this.rolledSeries_
.push(series
);
2238 // If the data or options have changed, then we'd better redraw.
2241 // This is used to determine whether to do various animations.
2242 var end
= new Date();
2243 this.drawingTimeMs_
= (end
- start
);
2249 * xval_* and yval_* are the original unscaled data values,
2250 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2251 * yval_stacked is the cumulative Y value used for stacking graphs,
2252 * and bottom/top/minus/plus are used for error bar graphs.
2259 * y_bottom: ?number,
2261 * y_stacked: ?number,
2263 * yval_minus: ?number,
2265 * yval_plus: ?number,
2269 Dygraph
.PointType
= undefined
;
2272 * Calculates point stacking for stackedGraph=true.
2274 * For stacking purposes, interpolate or extend neighboring data across
2275 * NaN values based on stackedGraphNaNFill settings. This is for display
2276 * only, the underlying data value as shown in the legend remains NaN.
2278 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2279 * Updates each Point's yval_stacked property.
2280 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2281 * values for the series seen so far. Index is the row number. Updated
2282 * based on the current series's values.
2283 * @param {Array.<number>} seriesExtremes Min and max values, updated
2284 * to reflect the stacked values.
2285 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2289 Dygraph
.stackPoints_
= function(
2290 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2291 var lastXval
= null;
2292 var prevPoint
= null;
2293 var nextPoint
= null;
2294 var nextPointIdx
= -1;
2296 // Find the next stackable point starting from the given index.
2297 var updateNextPoint
= function(idx
) {
2298 // If we've previously found a non-NaN point and haven't gone past it yet,
2300 if (nextPointIdx
>= idx
) return;
2302 // We haven't found a non-NaN point yet or have moved past it,
2303 // look towards the right to find a non-NaN point.
2304 for (var j
= idx
; j
< points
.length
; ++j
) {
2305 // Clear out a previously-found point (if any) since it's no longer
2306 // valid, we shouldn't use it for interpolation anymore.
2308 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2310 nextPoint
= points
[j
];
2316 for (var i
= 0; i
< points
.length
; ++i
) {
2317 var point
= points
[i
];
2318 var xval
= point
.xval
;
2319 if (cumulativeYval
[xval
] === undefined
) {
2320 cumulativeYval
[xval
] = 0;
2323 var actualYval
= point
.yval
;
2324 if (isNaN(actualYval
) || actualYval
=== null) {
2325 // Interpolate/extend
for stacking purposes
if possible
.
2327 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2328 // Use linear interpolation between prevPoint and nextPoint.
2329 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2330 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2331 } else if (prevPoint
&& fillMethod
== 'all') {
2332 actualYval
= prevPoint
.yval
;
2333 } else if (nextPoint
&& fillMethod
== 'all') {
2334 actualYval
= nextPoint
.yval
;
2342 var stackedYval
= cumulativeYval
[xval
];
2343 if (lastXval
!= xval
) {
2344 // If an x-value is repeated, we ignore the duplicates.
2345 stackedYval
+= actualYval
;
2346 cumulativeYval
[xval
] = stackedYval
;
2350 point
.yval_stacked
= stackedYval
;
2352 if (stackedYval
> seriesExtremes
[1]) {
2353 seriesExtremes
[1] = stackedYval
;
2355 if (stackedYval
< seriesExtremes
[0]) {
2356 seriesExtremes
[0] = stackedYval
;
2363 * Loop over all fields and create datasets, calculating extreme y-values for
2364 * each series and extreme x-indices as we go.
2366 * dateWindow is passed in as an explicit parameter so that we can compute
2367 * extreme values "speculatively", i.e. without actually setting state on the
2370 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2371 * rolledSeries[seriesIndex][row] = raw point, where
2372 * seriesIndex is the column number starting with 1, and
2373 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2374 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2376 * points: Array.<Array.<Dygraph.PointType>>,
2377 * seriesExtremes: Array.<Array.<number>>,
2378 * boundaryIds: Array.<number>}}
2381 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2382 var boundaryIds
= [];
2384 var cumulativeYval
= []; // For stacked series.
2385 var extremes
= {}; // series name -> [low, high]
2386 var seriesIdx
, sampleIdx
;
2387 var firstIdx
, lastIdx
;
2389 // Loop over the fields (series). Go from the last to the first,
2390 // because if they're stacked that's how we accumulate the values.
2391 var num_series
= rolledSeries
.length
- 1;
2393 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2394 if (!this.visibility()[seriesIdx
- 1]) continue;
2396 // Prune down to the desired range, if necessary (for zooming)
2397 // Because there can be lines going to points outside of the visible area,
2398 // we actually prune to visible points, plus one on either side.
2400 series
= rolledSeries
[seriesIdx
];
2401 var low
= dateWindow
[0];
2402 var high
= dateWindow
[1];
2404 // TODO(danvk): do binary search instead of linear search.
2405 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2408 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2409 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2410 firstIdx
= sampleIdx
;
2412 if (series
[sampleIdx
][0] <= high
) {
2413 lastIdx
= sampleIdx
;
2417 if (firstIdx
=== null) firstIdx
= 0;
2418 var correctedFirstIdx
= firstIdx
;
2419 var isInvalidValue
= true;
2420 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2421 correctedFirstIdx
--;
2422 // check if the y value is null.
2423 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2426 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2427 var correctedLastIdx
= lastIdx
;
2428 isInvalidValue
= true;
2429 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2431 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2434 if (correctedFirstIdx
!==firstIdx
) {
2435 firstIdx
= correctedFirstIdx
;
2437 if (correctedLastIdx
!== lastIdx
) {
2438 lastIdx
= correctedLastIdx
;
2441 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2443 // .slice's end is exclusive, we want to include lastIdx.
2444 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2446 series
= rolledSeries
[seriesIdx
];
2447 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2450 var seriesName
= this.attr_("labels")[seriesIdx
];
2451 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2452 dateWindow
, this.attr_("stepPlot",seriesName
));
2454 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2455 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2457 if (this.attr_("stackedGraph")) {
2458 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2459 this.attr_("stackedGraphNaNFill"));
2462 extremes
[seriesName
] = seriesExtremes
;
2463 points
[seriesIdx
] = seriesPoints
;
2466 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2470 * Update the graph with new data. This method is called when the viewing area
2471 * has changed. If the underlying data or options have changed, predraw_ will
2472 * be called before drawGraph_ is called.
2476 Dygraph
.prototype.drawGraph_
= function() {
2477 var start
= new Date();
2479 // This is used to set the second parameter to drawCallback, below.
2480 var is_initial_draw
= this.is_initial_draw_
;
2481 this.is_initial_draw_
= false;
2483 this.layout_
.removeAllDatasets();
2485 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2487 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2488 var points
= packed
.points
;
2489 var extremes
= packed
.extremes
;
2490 this.boundaryIds_
= packed
.boundaryIds
;
2492 this.setIndexByName_
= {};
2493 var labels
= this.attr_("labels");
2494 if (labels
.length
> 0) {
2495 this.setIndexByName_
[labels
[0]] = 0;
2498 for (var i
= 1; i
< points
.length
; i
++) {
2499 this.setIndexByName_
[labels
[i
]] = i
;
2500 if (!this.visibility()[i
- 1]) continue;
2501 this.layout_
.addDataset(labels
[i
], points
[i
]);
2502 this.datasetIndex_
[i
] = dataIdx
++;
2505 this.computeYAxisRanges_(extremes
);
2506 this.layout_
.setYAxes(this.axes_
);
2510 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2511 var tmp_zoomed_x
= this.zoomed_x_
;
2512 // Tell PlotKit to use this new data and render itself
2513 this.zoomed_x_
= tmp_zoomed_x
;
2514 this.layout_
.evaluate();
2515 this.renderGraph_(is_initial_draw
);
2517 if (this.attr_("timingName")) {
2518 var end
= new Date();
2519 Dygraph
.info(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2524 * This does the work of drawing the chart. It assumes that the layout and axis
2525 * scales have already been set (e.g. by predraw_).
2529 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2530 this.cascadeEvents_('clearChart');
2531 this.plotter_
.clear();
2533 if (this.attr_('underlayCallback')) {
2534 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2535 // users who expect a deprecated form of this callback.
2536 this.attr_('underlayCallback')(
2537 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2541 canvas
: this.hidden_
,
2542 drawingContext
: this.hidden_ctx_
2544 this.cascadeEvents_('willDrawChart', e
);
2545 this.plotter_
.render();
2546 this.cascadeEvents_('didDrawChart', e
);
2547 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2549 // TODO(danvk): is this a performance bottleneck when panning?
2550 // The interaction canvas should already be empty in that situation.
2551 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2552 this.canvas_
.height
);
2554 if (this.attr_("drawCallback") !== null) {
2555 this.attr_("drawCallback")(this, is_initial_draw
);
2557 if (is_initial_draw
) {
2558 this.readyFired_
= true;
2559 while (this.readyFns_
.length
> 0) {
2560 var fn
= this.readyFns_
.pop();
2568 * Determine properties of the y-axes which are independent of the data
2569 * currently being displayed. This includes things like the number of axes and
2570 * the style of the axes. It does not include the range of each axis and its
2572 * This fills in this.axes_.
2573 * axes_ = [ { options } ]
2574 * indices are into the axes_ array.
2576 Dygraph
.prototype.computeYAxes_
= function() {
2577 // Preserve valueWindow settings if they exist, and if the user hasn't
2578 // specified a new valueRange.
2579 var valueWindows
, axis
, index
, opts
, v
;
2580 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2582 for (index
= 0; index
< this.axes_
.length
; index
++) {
2583 valueWindows
.push(this.axes_
[index
].valueWindow
);
2587 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2588 // data computation as well as options storage.
2589 // Go through once and add all the axes.
2592 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2593 // Add a new axis, making a copy of its per-axis options.
2594 opts
= { g
: this };
2595 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2596 this.axes_
[axis
] = opts
;
2600 // Copy global valueRange option over to the first axis.
2601 // NOTE(konigsberg): Are these two statements necessary?
2602 // I tried removing it. The automated tests pass, and manually
2603 // messing with tests/zoom
.html showed no trouble
.
2604 v
= this.attr_('valueRange');
2605 if (v
) this.axes_
[0].valueRange
= v
;
2607 if (valueWindows
!== undefined
) {
2608 // Restore valueWindow settings.
2610 // When going from two axes back to one, we only restore
2612 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2614 for (index
= 0; index
< idxCount
; index
++) {
2615 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2619 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2621 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2622 v
= opts("valueRange");
2623 if (v
) this.axes_
[axis
].valueRange
= v
;
2624 } else { // To keep old behavior
2625 var axes
= this.user_attrs_
.axes
;
2626 if (axes
&& axes
.y2
) {
2627 v
= axes
.y2
.valueRange
;
2628 if (v
) this.axes_
[axis
].valueRange
= v
;
2635 * Returns the number of y-axes on the chart.
2636 * @return {Number} the number of axes.
2638 Dygraph
.prototype.numAxes
= function() {
2639 return this.attributes_
.numAxes();
2644 * Returns axis properties for the given series.
2645 * @param { String } setName The name of the series for which to get axis
2646 * properties, e.g. 'Y1'.
2647 * @return { Object } The axis properties.
2649 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2650 // TODO(danvk): handle errors.
2651 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2656 * Determine the value range and tick marks for each axis.
2657 * @param {Object} extremes A mapping from seriesName -> [low, high]
2658 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2660 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2661 var isNullUndefinedOrNaN
= function(num
) {
2662 return isNaN(parseFloat(num
));
2664 var numAxes
= this.attributes_
.numAxes();
2665 var ypadCompat
, span
, series
, ypad
;
2669 // Compute extreme values, a span and tick marks for each axis.
2670 for (var i
= 0; i
< numAxes
; i
++) {
2671 var axis
= this.axes_
[i
];
2672 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2673 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2674 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2675 series
= this.attributes_
.seriesForAxis(i
);
2677 // Add some padding. This supports two Y padding operation modes:
2679 // - backwards compatible (yRangePad not set):
2680 // 10% padding for automatic Y ranges, but not for user-supplied
2681 // ranges, and move a close-to-zero edge to zero except if
2682 // avoidMinZero is set, since drawing at the edge results in
2683 // invisible lines. Unfortunately lines drawn at the edge of a
2684 // user-supplied range will still be invisible. If logscale is
2685 // set, add a variable amount of padding at the top but
2686 // none at the bottom.
2688 // - new-style (yRangePad set by the user):
2689 // always add the specified Y padding.
2692 ypad
= 0.1; // add 10%
2693 if (this.attr_('yRangePad') !== null) {
2695 // Convert pixel padding to ratio
2696 ypad
= this.attr_('yRangePad') / this.plotter_
.area
.h
;
2699 if (series
.length
=== 0) {
2700 // If no series are defined or visible then use a reasonable default
2701 axis
.extremeRange
= [0, 1];
2703 // Calculate the extremes of extremes.
2704 var minY
= Infinity
; // extremes[series[0]][0];
2705 var maxY
= -Infinity
; // extremes[series[0]][1];
2706 var extremeMinY
, extremeMaxY
;
2708 for (var j
= 0; j
< series
.length
; j
++) {
2709 // this skips invisible series
2710 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2712 // Only use valid extremes to stop null data series' from corrupting the scale.
2713 extremeMinY
= extremes
[series
[j
]][0];
2714 if (extremeMinY
!== null) {
2715 minY
= Math
.min(extremeMinY
, minY
);
2717 extremeMaxY
= extremes
[series
[j
]][1];
2718 if (extremeMaxY
!== null) {
2719 maxY
= Math
.max(extremeMaxY
, maxY
);
2723 // Include zero if requested by the user.
2724 if (includeZero
&& !logscale
) {
2725 if (minY
> 0) minY
= 0;
2726 if (maxY
< 0) maxY
= 0;
2729 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2730 if (minY
== Infinity
) minY
= 0;
2731 if (maxY
== -Infinity
) maxY
= 1;
2734 // special case: if we have no sense of scale, center on the sole value.
2737 span
= Math
.abs(maxY
);
2739 // ... and if the sole value is zero, use range 0-1.
2745 var maxAxisY
, minAxisY
;
2748 maxAxisY
= maxY
+ ypad
* span
;
2751 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2752 maxAxisY
= maxY
* logpad
;
2753 minAxisY
= minY
/ logpad
;
2756 maxAxisY
= maxY
+ ypad
* span
;
2757 minAxisY
= minY
- ypad
* span
;
2759 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2760 // close to zero, but not if avoidMinZero is set.
2761 if (ypadCompat
&& !this.attr_("avoidMinZero")) {
2762 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2763 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2766 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2768 if (axis
.valueWindow
) {
2769 // This is only set if the user has zoomed on the y-axis. It is never set
2770 // by a user. It takes precedence over axis.valueRange because, if you set
2771 // valueRange, you'd still expect to be able to pan.
2772 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2773 } else if (axis
.valueRange
) {
2774 // This is a user-set value range for this axis.
2775 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2776 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2778 if (axis
.logscale
) {
2779 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2788 axis
.computedValueRange
= [y0
, y1
];
2790 axis
.computedValueRange
= axis
.extremeRange
;
2794 if (independentTicks
) {
2795 axis
.independentTicks
= independentTicks
;
2796 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2797 var ticker
= opts('ticker');
2798 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2799 axis
.computedValueRange
[1],
2800 this.height_
, // TODO(danvk): should be area.height
2803 // Define the first independent axis as primary axis.
2804 if (!p_axis
) p_axis
= axis
;
2807 if (p_axis
=== undefined
) {
2808 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2810 // Add ticks. By default, all axes inherit the tick positions of the
2811 // primary axis. However, if an axis is specifically marked as having
2812 // independent ticks, then that is permissible as well.
2813 for (var i
= 0; i
< numAxes
; i
++) {
2814 var axis
= this.axes_
[i
];
2816 if (!axis
.independentTicks
) {
2817 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2818 var ticker
= opts('ticker');
2819 var p_ticks
= p_axis
.ticks
;
2820 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2821 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2822 var tick_values
= [];
2823 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2824 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2825 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2826 tick_values
.push(y_val
);
2829 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2830 axis
.computedValueRange
[1],
2831 this.height_
, // TODO(danvk): should be area.height
2840 * Detects the type of the str (date or numeric) and sets the various
2841 * formatting attributes in this.attrs_ based on this type.
2842 * @param {String} str An x value.
2845 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2847 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2848 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2849 str
.indexOf('/') >= 0 ||
2850 isNaN(parseFloat(str
))) {
2852 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2853 // TODO(danvk): remove support for this format.
2857 this.setXAxisOptions_(isDate
);
2860 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2862 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2863 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2864 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2865 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2867 /** @private (shut up, jsdoc!) */
2868 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2869 // TODO(danvk): use Dygraph.numberValueFormatter here?
2870 /** @private (shut up, jsdoc!) */
2871 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2872 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2873 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2878 * Parses the value as a floating point number. This is like the parseFloat()
2879 * built-in, but with a few differences:
2880 * - the empty string is parsed as null, rather than NaN.
2881 * - if the string cannot be parsed at all, an error is logged.
2882 * If the string can't be parsed, this method returns null.
2883 * @param {String} x The string to be parsed
2884 * @param {Number} opt_line_no The line number from which the string comes.
2885 * @param {String} opt_line The text of the line from which the string comes.
2889 // Parse the x as a float or return null if it's not a number.
2890 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2891 var val
= parseFloat(x
);
2892 if (!isNaN(val
)) return val
;
2894 // Try to figure out what happeend.
2895 // If the value is the empty string, parse it as null.
2896 if (/^ *$/.test(x
)) return null;
2898 // If it was actually "NaN", return it as NaN.
2899 if (/^ *nan *$/i.test(x
)) return NaN
;
2901 // Looks like a parsing error.
2902 var msg
= "Unable to parse '" + x
+ "' as a number";
2903 if (opt_line
!== null && opt_line_no
!== null) {
2904 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2913 * Parses a string in a special csv format. We expect a csv file where each
2914 * line is a date point, and the first field in each line is the date string.
2915 * We also expect that all remaining fields represent series.
2916 * if the errorBars attribute is set, then interpret the fields as:
2917 * date, series1, stddev1, series2, stddev2, ...
2918 * @param {[Object]} data See above.
2920 * @return [Object] An array with one entry for each row. These entries
2921 * are an array of cells in that row. The first entry is the parsed x-value for
2922 * the row. The second, third, etc. are the y-values. These can take on one of
2923 * three forms, depending on the CSV and constructor parameters:
2925 * 2. [ value, stddev ]
2926 * 3. [ low value, center value, high value ]
2928 Dygraph
.prototype.parseCSV_
= function(data
) {
2930 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2931 var lines
= data
.split(line_delimiter
|| "\n");
2934 // Use the default delimiter or fall back to a tab if that makes sense.
2935 var delim
= this.attr_('delimiter');
2936 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2941 if (!('labels' in this.user_attrs_
)) {
2942 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2944 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2945 this.attributes_
.reparseSeries();
2950 var defaultParserSet
= false; // attempt to auto-detect x value type
2951 var expectedCols
= this.attr_("labels").length
;
2952 var outOfOrder
= false;
2953 for (var i
= start
; i
< lines
.length
; i
++) {
2954 var line
= lines
[i
];
2956 if (line
.length
=== 0) continue; // skip blank lines
2957 if (line
[0] == '#') continue; // skip comment lines
2958 var inFields
= line
.split(delim
);
2959 if (inFields
.length
< 2) continue;
2962 if (!defaultParserSet
) {
2963 this.detectTypeFromString_(inFields
[0]);
2964 xParser
= this.attr_("xValueParser");
2965 defaultParserSet
= true;
2967 fields
[0] = xParser(inFields
[0], this);
2969 // If fractions are expected, parse the numbers as "A/B
"
2970 if (this.fractions_) {
2971 for (j = 1; j < inFields.length; j++) {
2972 // TODO(danvk): figure out an appropriate way to flag parse errors.
2973 vals = inFields[j].split("/");
2974 if (vals.length != 2) {
2975 this.error('Expected fractional "num
/den
" values in CSV data ' +
2976 "but found a value
'" + inFields[j] + "' on line
" +
2977 (1 + i) + " ('" + line + "') which is not of
this form
.");
2980 fields[j] = [this.parseFloat_(vals[0], i, line),
2981 this.parseFloat_(vals[1], i, line)];
2984 } else if (this.attr_("errorBars
")) {
2985 // If there are error bars, values are (value, stddev) pairs
2986 if (inFields.length % 2 != 1) {
2987 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2988 'but line ' + (1 + i) + ' has an odd number of values (' +
2989 (inFields.length - 1) + "): '" + line + "'");
2991 for (j = 1; j < inFields.length; j += 2) {
2992 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2993 this.parseFloat_(inFields[j + 1], i, line)];
2995 } else if (this.attr_("customBars
")) {
2996 // Bars are a low;center;high tuple
2997 for (j = 1; j < inFields.length; j++) {
2998 var val = inFields[j];
2999 if (/^ *$/.test(val)) {
3000 fields[j] = [null, null, null];
3002 vals = val.split(";");
3003 if (vals.length == 3) {
3004 fields[j] = [ this.parseFloat_(vals[0], i, line),
3005 this.parseFloat_(vals[1], i, line),
3006 this.parseFloat_(vals[2], i, line) ];
3008 this.warn('When using customBars, values must be either blank ' +
3009 'or "low
;center
;high
" tuples (got "' + val +
3010 '" on line ' + (1+i));
3015 // Values are just numbers
3016 for (j = 1; j < inFields.length; j++) {
3017 fields[j] = this.parseFloat_(inFields[j], i, line);
3020 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3024 if (fields.length != expectedCols) {
3025 this.error("Number of columns
in line
" + i + " (" + fields.length +
3026 ") does not agree
with number of
labels (" + expectedCols +
3030 // If the user specified the 'labels' option and none of the cells of the
3031 // first row parsed correctly, then they probably double-specified the
3032 // labels. We go with the values set in the option, discard this row and
3033 // log a warning to the JS console.
3034 if (i === 0 && this.attr_('labels')) {
3035 var all_null = true;
3036 for (j = 0; all_null && j < fields.length; j++) {
3037 if (fields[j]) all_null = false;
3040 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3041 "CSV
data ('" + line + "') appears to also contain labels
. " +
3042 "Will drop the CSV labels and
use the option labels
.");
3050 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3051 ret.sort(function(a,b) { return a[0] - b[0]; });
3059 * The user has provided their data as a pre-packaged JS array. If the x values
3060 * are numeric, this is the same as dygraphs' internal format. If the x values
3061 * are dates, we need to convert them from Date objects to ms since epoch.
3062 * @param {[Object]} data
3063 * @return {[Object]} data with numeric x values.
3065 Dygraph.prototype.parseArray_ = function(data) {
3066 // Peek at the first x value to see if it's numeric.
3067 if (data.length === 0) {
3068 this.error("Can
't plot empty data set");
3071 if (data[0].length === 0) {
3072 this.error("Data set cannot contain an empty row");
3077 if (this.attr_("labels") === null) {
3078 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3079 "in the options parameter");
3080 this.attrs_.labels = [ "X" ];
3081 for (i = 1; i < data[0].length; i++) {
3082 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3084 this.attributes_.reparseSeries();
3086 var num_labels = this.attr_("labels");
3087 if (num_labels.length != data[0].length) {
3088 this.error("Mismatch between number of labels (" + num_labels +
3089 ") and number of columns in array (" + data[0].length + ")");
3094 if (Dygraph.isDateLike(data[0][0])) {
3095 // Some intelligent defaults for a date x-axis.
3096 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3097 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3098 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3100 // Assume they're all dates
.
3101 var parsedData
= Dygraph
.clone(data
);
3102 for (i
= 0; i
< data
.length
; i
++) {
3103 if (parsedData
[i
].length
=== 0) {
3104 this.error("Row " + (1 + i
) + " of data is empty");
3107 if (parsedData
[i
][0] === null ||
3108 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3109 isNaN(parsedData
[i
][0].getTime())) {
3110 this.error("x value in row " + (1 + i
) + " is not a Date");
3113 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3117 // Some intelligent defaults for a numeric x-axis.
3118 /** @private (shut up, jsdoc!) */
3119 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3120 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3121 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3127 * Parses a DataTable object from gviz.
3128 * The data is expected to have a first column that is either a date or a
3129 * number. All subsequent columns must be numbers. If there is a clear mismatch
3130 * between this.xValueParser_ and the type of the first column, it will be
3131 * fixed. Fills out rawData_.
3132 * @param {[Object]} data See above.
3135 Dygraph
.prototype.parseDataTable_
= function(data
) {
3136 var shortTextForAnnotationNum
= function(num
) {
3137 // converts [0-9]+ [A-Z][a-z]*
3138 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3139 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3140 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3141 num
= Math
.floor(num
/ 26);
3143 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3144 num
= Math
.floor((num
- 1) / 26);
3149 var cols
= data
.getNumberOfColumns();
3150 var rows
= data
.getNumberOfRows();
3152 var indepType
= data
.getColumnType(0);
3153 if (indepType
== 'date' || indepType
== 'datetime') {
3154 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3155 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3156 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3157 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3158 } else if (indepType
== 'number') {
3159 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3160 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3161 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3162 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3164 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3165 "column 1 of DataTable input (Got '" + indepType
+ "')");
3169 // Array of the column indices which contain data (and not annotations).
3171 var annotationCols
= {}; // data index -> [annotation cols]
3172 var hasAnnotations
= false;
3174 for (i
= 1; i
< cols
; i
++) {
3175 var type
= data
.getColumnType(i
);
3176 if (type
== 'number') {
3178 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3179 // This is OK -- it's an annotation column.
3180 var dataIdx
= colIdx
[colIdx
.length
- 1];
3181 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3182 annotationCols
[dataIdx
] = [i
];
3184 annotationCols
[dataIdx
].push(i
);
3186 hasAnnotations
= true;
3188 this.error("Only 'number' is supported as a dependent type with Gviz." +
3189 " 'string' is only supported if displayAnnotations is true");
3193 // Read column labels
3194 // TODO(danvk): add support back for errorBars
3195 var labels
= [data
.getColumnLabel(0)];
3196 for (i
= 0; i
< colIdx
.length
; i
++) {
3197 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3198 if (this.attr_("errorBars")) i
+= 1;
3200 this.attrs_
.labels
= labels
;
3201 cols
= labels
.length
;
3204 var outOfOrder
= false;
3205 var annotations
= [];
3206 for (i
= 0; i
< rows
; i
++) {
3208 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3209 data
.getValue(i
, 0) === null) {
3210 this.warn("Ignoring row " + i
+
3211 " of DataTable because of undefined or null first column.");
3215 if (indepType
== 'date' || indepType
== 'datetime') {
3216 row
.push(data
.getValue(i
, 0).getTime());
3218 row
.push(data
.getValue(i
, 0));
3220 if (!this.attr_("errorBars")) {
3221 for (j
= 0; j
< colIdx
.length
; j
++) {
3222 var col
= colIdx
[j
];
3223 row
.push(data
.getValue(i
, col
));
3224 if (hasAnnotations
&&
3225 annotationCols
.hasOwnProperty(col
) &&
3226 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3228 ann
.series
= data
.getColumnLabel(col
);
3230 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3232 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3233 if (k
) ann
.text
+= "\n";
3234 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3236 annotations
.push(ann
);
3240 // Strip out infinities, which give dygraphs problems later on.
3241 for (j
= 0; j
< row
.length
; j
++) {
3242 if (!isFinite(row
[j
])) row
[j
] = null;
3245 for (j
= 0; j
< cols
- 1; j
++) {
3246 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3249 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3256 this.warn("DataTable is out of order; order it correctly to speed loading.");
3257 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3259 this.rawData_
= ret
;
3261 if (annotations
.length
> 0) {
3262 this.setAnnotations(annotations
, true);
3264 this.attributes_
.reparseSeries();
3268 * Get the CSV data. If it's in a function, call that function. If it's in a
3269 * file, do an XMLHttpRequest to get it.
3272 Dygraph
.prototype.start_
= function() {
3273 var data
= this.file_
;
3275 // Functions can return references of all other types.
3276 if (typeof data
== 'function') {
3280 if (Dygraph
.isArrayLike(data
)) {
3281 this.rawData_
= this.parseArray_(data
);
3283 } else if (typeof data
== 'object' &&
3284 typeof data
.getColumnRange
== 'function') {
3285 // must be a DataTable from gviz.
3286 this.parseDataTable_(data
);
3288 } else if (typeof data
== 'string') {
3289 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3290 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3291 if (line_delimiter
) {
3292 this.loadedEvent_(data
);
3296 if (window
.XMLHttpRequest
) {
3297 // Firefox, Opera, IE7, and other browsers will use the native object
3298 req
= new XMLHttpRequest();
3300 // IE 5 and 6 will use the ActiveX control
3301 req
= new ActiveXObject("Microsoft.XMLHTTP");
3305 req
.onreadystatechange
= function () {
3306 if (req
.readyState
== 4) {
3307 if (req
.status
=== 200 || // Normal http
3308 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3309 caller
.loadedEvent_(req
.responseText
);
3314 req
.open("GET", data
, true);
3318 this.error("Unknown data format: " + (typeof data
));
3323 * Changes various properties of the graph. These can include:
3325 * <li>file: changes the source data for the graph</li>
3326 * <li>errorBars: changes whether the data contains stddev</li>
3329 * There's a huge variety of options that can be passed to this method. For a
3330 * full list, see http://dygraphs.com/options.html.
3332 * @param {Object} attrs The new properties and values
3333 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3334 * call to updateOptions(). If you know better, you can pass true to explicitly
3335 * block the redraw. This can be useful for chaining updateOptions() calls,
3336 * avoiding the occasional infinite loop and preventing redraws when it's not
3337 * necessary (e.g. when updating a callback).
3339 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3340 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3342 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3343 var file
= input_attrs
.file
;
3344 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3346 // TODO(danvk): this is a mess. Move these options into attr_.
3347 if ('rollPeriod' in attrs
) {
3348 this.rollPeriod_
= attrs
.rollPeriod
;
3350 if ('dateWindow' in attrs
) {
3351 this.dateWindow_
= attrs
.dateWindow
;
3352 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3353 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3356 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3357 this.zoomed_y_
= (attrs
.valueRange
!== null);
3360 // TODO(danvk): validate per-series options.
3365 // highlightCircleSize
3367 // Check if this set options will require new points.
3368 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3370 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3372 this.attributes_
.reparseSeries();
3376 if (!block_redraw
) this.start_();
3378 if (!block_redraw
) {
3379 if (requiresNewPoints
) {
3382 this.renderGraph_(false);
3389 * Returns a copy of the options with deprecated names converted into current
3390 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3391 * interested in that, they should save a copy before calling this.
3394 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3396 for (var k
in attrs
) {
3397 if (k
== 'file') continue;
3398 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3401 var set
= function(axis
, opt
, value
) {
3402 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3403 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3404 my_attrs
.axes
[axis
][opt
] = value
;
3406 var map
= function(opt
, axis
, new_opt
) {
3407 if (typeof(attrs
[opt
]) != 'undefined') {
3408 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3409 new_opt
+ " option for the " + axis
+ " axis instead. " +
3410 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3411 "(see http://dygraphs.com/per-axis.html for more information.");
3412 set(axis
, new_opt
, attrs
[opt
]);
3413 delete my_attrs
[opt
];
3417 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3418 map('xValueFormatter', 'x', 'valueFormatter');
3419 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3420 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3421 map('xTicker', 'x', 'ticker');
3422 map('yValueFormatter', 'y', 'valueFormatter');
3423 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3424 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3425 map('yTicker', 'y', 'ticker');
3430 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3431 * containing div (which has presumably changed size since the dygraph was
3432 * instantiated. If the width/height are specified, the div will be resized.
3434 * This is far more efficient than destroying and re-instantiating a
3435 * Dygraph, since it doesn't have to reparse the underlying data.
3437 * @param {Number} [width] Width (in pixels)
3438 * @param {Number} [height] Height (in pixels)
3440 Dygraph
.prototype.resize
= function(width
, height
) {
3441 if (this.resize_lock
) {
3444 this.resize_lock
= true;
3446 if ((width
=== null) != (height
=== null)) {
3447 this.warn("Dygraph.resize() should be called with zero parameters or " +
3448 "two non-NULL parameters. Pretending it was zero.");
3449 width
= height
= null;
3452 var old_width
= this.width_
;
3453 var old_height
= this.height_
;
3456 this.maindiv_
.style
.width
= width
+ "px";
3457 this.maindiv_
.style
.height
= height
+ "px";
3458 this.width_
= width
;
3459 this.height_
= height
;
3461 this.width_
= this.maindiv_
.clientWidth
;
3462 this.height_
= this.maindiv_
.clientHeight
;
3465 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3466 // Resizing a canvas erases it, even when the size doesn't change, so
3467 // any resize needs to be followed by a redraw.
3468 this.resizeElements_();
3472 this.resize_lock
= false;
3476 * Adjusts the number of points in the rolling average. Updates the graph to
3477 * reflect the new averaging period.
3478 * @param {Number} length Number of points over which to average the data.
3480 Dygraph
.prototype.adjustRoll
= function(length
) {
3481 this.rollPeriod_
= length
;
3486 * Returns a boolean array of visibility statuses.
3488 Dygraph
.prototype.visibility
= function() {
3489 // Do lazy-initialization, so that this happens after we know the number of
3491 if (!this.attr_("visibility")) {
3492 this.attrs_
.visibility
= [];
3494 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3495 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3496 this.attrs_
.visibility
.push(true);
3498 return this.attr_("visibility");
3502 * Changes the visiblity of a series.
3504 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3505 var x
= this.visibility();
3506 if (num
< 0 || num
>= x
.length
) {
3507 this.warn("invalid series number in setVisibility: " + num
);
3515 * How large of an area will the dygraph render itself in?
3516 * This is used for testing.
3517 * @return A {width: w, height: h} object.
3520 Dygraph
.prototype.size
= function() {
3521 return { width
: this.width_
, height
: this.height_
};
3525 * Update the list of annotations and redraw the chart.
3526 * See dygraphs.com/annotations.html for more info on how to use annotations.
3527 * @param ann {Array} An array of annotation objects.
3528 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3530 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3531 // Only add the annotation CSS rule once we know it will be used.
3532 Dygraph
.addAnnotationRule();
3533 this.annotations_
= ann
;
3534 if (!this.layout_
) {
3535 this.warn("Tried to setAnnotations before dygraph was ready. " +
3536 "Try setting them in a ready() block. See " +
3537 "dygraphs.com/tests/annotation.html");
3541 this.layout_
.setAnnotations(this.annotations_
);
3542 if (!suppressDraw
) {
3548 * Return the list of annotations.
3550 Dygraph
.prototype.annotations
= function() {
3551 return this.annotations_
;
3555 * Get the list of label names for this graph. The first column is the
3556 * x-axis, so the data series names start at index 1.
3558 * Returns null when labels have not yet been defined.
3560 Dygraph
.prototype.getLabels
= function() {
3561 var labels
= this.attr_("labels");
3562 return labels
? labels
.slice() : null;
3566 * Get the index of a series (column) given its name. The first column is the
3567 * x-axis, so the data series start with index 1.
3569 Dygraph
.prototype.indexFromSetName
= function(name
) {
3570 return this.setIndexByName_
[name
];
3574 * Trigger a callback when the dygraph has drawn itself and is ready to be
3575 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3576 * data (i.e. a URL is passed as the data source) and the chart is drawn
3577 * asynchronously. If the chart has already drawn, the callback will fire
3580 * This is a good place to call setAnnotation().
3582 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3585 Dygraph
.prototype.ready
= function(callback
) {
3586 if (this.is_initial_draw_
) {
3587 this.readyFns_
.push(callback
);
3595 * Adds a default style for the annotation CSS classes to the document. This is
3596 * only executed when annotations are actually used. It is designed to only be
3597 * called once -- all calls after the first will return immediately.
3599 Dygraph
.addAnnotationRule
= function() {
3600 // TODO(danvk): move this function into plugins/annotations.js
?
3601 if (Dygraph
.addedAnnotationCSS
) return;
3603 var rule
= "border: 1px solid black; " +
3604 "background-color: white; " +
3605 "text-align: center;";
3607 var styleSheetElement
= document
.createElement("style");
3608 styleSheetElement
.type
= "text/css";
3609 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3611 // Find the first style sheet that we can access.
3612 // We may not add a rule to a style sheet from another domain for security
3613 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3614 // adds its own style sheets from google.com.
3615 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3616 if (document
.styleSheets
[i
].disabled
) continue;
3617 var mysheet
= document
.styleSheets
[i
];
3619 if (mysheet
.insertRule
) { // Firefox
3620 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3621 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3622 } else if (mysheet
.addRule
) { // IE
3623 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3625 Dygraph
.addedAnnotationCSS
= true;
3628 // Was likely a security exception.
3632 this.warn("Unable to add default annotation CSS rule; display may be off.");
3635 // Older pages may still use this name.
3636 var DateGraph
= Dygraph
;