3 * Copyright 2006 Dan Vanderkam (danvdk@gmail.com)
4 * MIT-licensed (http://opensource.org/licenses/MIT)
8 * @fileoverview Creates an interactive, zoomable graph based on a CSV file or
9 * string. Dygraph can handle multiple series with or without error bars. The
10 * date/value ranges will be automatically set. Dygraph uses the
11 * <canvas> tag, so it only works in FF1.5+.
12 * @author danvdk@gmail.com (Dan Vanderkam)
15 <div id="graphdiv" style="width:800px; height:500px;"></div>
16 <script type="text/javascript">
17 new Dygraph(document.getElementById("graphdiv"),
18 "datafile.csv", // CSV file with headers
22 The CSV file is of the form
24 Date,SeriesA,SeriesB,SeriesC
28 If the 'errorBars' option is set in the constructor, the input should be of
30 Date,SeriesA,SeriesB,...
31 YYYYMMDD,A1,sigmaA1,B1,sigmaB1,...
32 YYYYMMDD,A2,sigmaA2,B2,sigmaB2,...
34 If the 'fractions' option is set, the input should be of the form:
36 Date,SeriesA,SeriesB,...
37 YYYYMMDD,A1/B1,A2/B2,...
38 YYYYMMDD,A1/B1,A2/B2,...
40 And error bars will be calculated automatically using a binomial distribution.
42 For further documentation and examples, see http://dygraphs.com/
46 /*jshint globalstrict: true */
47 /*global DygraphLayout:false, DygraphCanvasRenderer:false, DygraphOptions:false, G_vmlCanvasManager:false,ActiveXObject:false */
51 * Creates an interactive, zoomable chart.
54 * @param {div | String} div A div or the id of a div into which to construct
56 * @param {String | Function} file A file containing CSV data or a function
57 * that returns this data. The most basic expected format for each line is
58 * "YYYY/MM/DD,val1,val2,...". For more information, see
59 * http://dygraphs.com/data.html.
60 * @param {Object} attrs Various other attributes, e.g. errorBars determines
61 * whether the input data contains error ranges. For a complete list of
62 * options, see http://dygraphs.com/options.html.
64 var Dygraph
= function(div
, data
, opts
, opt_fourth_param
) {
65 // These have to go above the "Hack for IE" in __init__ since .ready() can be
66 // called as soon as the constructor returns. Once support for OldIE is
67 // dropped, this can go down with the rest of the initializers.
68 this.is_initial_draw_
= true;
71 if (opt_fourth_param
!== undefined
) {
72 // Old versions of dygraphs took in the series labels as a constructor
73 // parameter. This doesn't make sense anymore, but it's easy to continue
74 // to support this usage.
75 this.warn("Using deprecated four-argument dygraph constructor");
76 this.__old_init__(div
, data
, opts
, opt_fourth_param
);
78 this.__init__(div
, data
, opts
);
82 Dygraph
.NAME
= "Dygraph";
83 Dygraph
.VERSION
= "1.0.1";
84 Dygraph
.__repr__
= function() {
85 return "[" + this.NAME
+ " " + this.VERSION
+ "]";
89 * Returns information about the Dygraph class.
91 Dygraph
.toString
= function() {
92 return this.__repr__();
95 // Various default values
96 Dygraph
.DEFAULT_ROLL_PERIOD
= 1;
97 Dygraph
.DEFAULT_WIDTH
= 480;
98 Dygraph
.DEFAULT_HEIGHT
= 320;
100 // For max 60 Hz. animation:
101 Dygraph
.ANIMATION_STEPS
= 12;
102 Dygraph
.ANIMATION_DURATION
= 200;
104 // Label constants for the labelsKMB and labelsKMG2 options.
105 // (i.e. '100000' -> '100K')
106 Dygraph
.KMB_LABELS
= [ 'K', 'M', 'B', 'T', 'Q' ];
107 Dygraph
.KMG2_BIG_LABELS
= [ 'k', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y' ];
108 Dygraph
.KMG2_SMALL_LABELS
= [ 'm', 'u', 'n', 'p', 'f', 'a', 'z', 'y' ];
110 // These are defined before DEFAULT_ATTRS so that it can refer to them.
113 * Return a string version of a number. This respects the digitsAfterDecimal
114 * and maxNumberWidth options.
115 * @param {Number} x The number to be formatted
116 * @param {Dygraph} opts An options view
117 * @param {String} name The name of the point's data series
118 * @param {Dygraph} g The dygraph object
120 Dygraph
.numberValueFormatter
= function(x
, opts
, pt
, g
) {
121 var sigFigs
= opts('sigFigs');
123 if (sigFigs
!== null) {
124 // User has opted for a fixed number of significant figures.
125 return Dygraph
.floatFormat(x
, sigFigs
);
128 var digits
= opts('digitsAfterDecimal');
129 var maxNumberWidth
= opts('maxNumberWidth');
131 var kmb
= opts('labelsKMB');
132 var kmg2
= opts('labelsKMG2');
136 // switch to scientific notation if we underflow or overflow fixed display.
138 (Math
.abs(x
) >= Math
.pow(10, maxNumberWidth
) ||
139 Math
.abs(x
) < Math
.pow(10, -digits
))) {
140 label
= x
.toExponential(digits
);
142 label
= '' + Dygraph
.round_(x
, digits
);
151 k_labels
= Dygraph
.KMB_LABELS
;
154 if (kmb
) Dygraph
.warn("Setting both labelsKMB and labelsKMG2. Pick one!");
156 k_labels
= Dygraph
.KMG2_BIG_LABELS
;
157 m_labels
= Dygraph
.KMG2_SMALL_LABELS
;
160 var absx
= Math
.abs(x
);
161 var n
= Dygraph
.pow(k
, k_labels
.length
);
162 for (var j
= k_labels
.length
- 1; j
>= 0; j
--, n
/= k
) {
164 label
= Dygraph
.round_(x
/ n
, digits
) + k_labels
[j
];
169 // TODO(danvk): clean up this logic. Why so different than kmb?
170 var x_parts
= String(x
.toExponential()).split('e-');
171 if (x_parts
.length
=== 2 && x_parts
[1] >= 3 && x_parts
[1] <= 24) {
172 if (x_parts
[1] % 3 > 0) {
173 label
= Dygraph
.round_(x_parts
[0] /
174 Dygraph
.pow(10, (x_parts
[1] % 3)),
177 label
= Number(x_parts
[0]).toFixed(2);
179 label
+= m_labels
[Math
.floor(x_parts
[1] / 3) - 1];
188 * variant for use as an axisLabelFormatter.
191 Dygraph
.numberAxisLabelFormatter
= function(x
, granularity
, opts
, g
) {
192 return Dygraph
.numberValueFormatter(x
, opts
, g
);
196 * Convert a JS date (millis since epoch) to YYYY/MM/DD
197 * @param {Number} date The JavaScript date (ms since epoch)
198 * @return {String} A date of the form "YYYY/MM/DD"
201 Dygraph
.dateString_
= function(date
) {
202 var zeropad
= Dygraph
.zeropad
;
203 var d
= new Date(date
);
206 var year
= "" + d
.getFullYear();
207 // Get a 0 padded month string
208 var month
= zeropad(d
.getMonth() + 1); //months are 0-offset, sigh
209 // Get a 0 padded day string
210 var day
= zeropad(d
.getDate());
213 var frac
= d
.getHours() * 3600 + d
.getMinutes() * 60 + d
.getSeconds();
214 if (frac
) ret
= " " + Dygraph
.hmsString_(date
);
216 return year
+ "/" + month + "/" + day
+ ret
;
220 * Convert a JS date to a string appropriate to display on an axis that
221 * is displaying values at the stated granularity.
222 * @param {Date} date The date to format
223 * @param {Number} granularity One of the Dygraph granularity constants
224 * @return {String} The formatted date
227 Dygraph
.dateAxisFormatter
= function(date
, granularity
) {
228 if (granularity
>= Dygraph
.DECADAL
) {
229 return date
.strftime('%Y');
230 } else if (granularity
>= Dygraph
.MONTHLY
) {
231 return date
.strftime('%b %y');
233 var frac
= date
.getHours() * 3600 + date
.getMinutes() * 60 + date
.getSeconds() + date
.getMilliseconds();
234 if (frac
=== 0 || granularity
>= Dygraph
.DAILY
) {
235 return new Date(date
.getTime() + 3600*1000).strftime('%d%b');
237 return Dygraph
.hmsString_(date
.getTime());
243 * Standard plotters. These may be used by clients.
244 * Available plotters are:
245 * - Dygraph.Plotters.linePlotter: draws central lines (most common)
246 * - Dygraph.Plotters.errorPlotter: draws error bars
247 * - Dygraph.Plotters.fillPlotter: draws fills under lines (used with fillGraph)
249 * By default, the plotter is [fillPlotter, errorPlotter, linePlotter].
250 * This causes all the lines to be drawn over all the fills/error bars.
252 Dygraph
.Plotters
= DygraphCanvasRenderer
._Plotters
;
255 // Default attribute values.
256 Dygraph
.DEFAULT_ATTRS
= {
257 highlightCircleSize
: 3,
258 highlightSeriesOpts
: null,
259 highlightSeriesBackgroundAlpha
: 0.5,
263 // TODO(danvk): move defaults from createStatusMessage_ here.
265 labelsSeparateLines
: false,
266 labelsShowZeroValues
: true,
269 showLabelsOnHighlight
: true,
271 digitsAfterDecimal
: 2,
276 strokeBorderWidth
: 0,
277 strokeBorderColor
: "white",
280 axisLabelFontSize
: 14,
286 xValueParser
: Dygraph
.dateParser
,
293 wilsonInterval
: true, // only relevant if fractions is true
297 connectSeparatedPoints
: false,
300 stackedGraphNaNFill
: 'all',
301 hideOverlayOnMouseOut
: true,
303 // TODO(danvk): support 'onmouseover' and 'never', and remove synonyms.
304 legend
: 'onmouseover', // the only relevant value at the moment is 'always'.
310 drawAxesAtZero
: false,
312 // Sizes of the various chart labels.
319 axisLineColor
: "black",
322 axisLabelColor
: "black",
323 axisLabelFont
: "Arial", // TODO(danvk): is this implemented?
327 gridLineColor
: "rgb(128,128,128)",
329 interactionModel
: null, // will be set to Dygraph.Interaction.defaultModel
330 animatedZooms
: false, // (for now)
332 // Range selector options
333 showRangeSelector
: false,
334 rangeSelectorHeight
: 40,
335 rangeSelectorPlotStrokeColor
: "#808FAB",
336 rangeSelectorPlotFillColor
: "#A7B1C4",
338 // The ordering here ensures that central lines always appear above any
339 // fill bars/error bars
.
341 Dygraph
.Plotters
.fillPlotter
,
342 Dygraph
.Plotters
.errorPlotter
,
343 Dygraph
.Plotters
.linePlotter
352 axisLabelFormatter
: Dygraph
.dateAxisFormatter
,
353 valueFormatter
: Dygraph
.dateString_
,
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.attributes_
.getForAxis("logscale", axis
)) {
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_
= {};
1165 // These are used for when no custom colors are specified.
1166 var sat
= this.attr_('colorSaturation') || 1.0;
1167 var val
= this.attr_('colorValue') || 0.5;
1168 var half
= Math
.ceil(num
/ 2);
1170 var colors
= this.attr_('colors');
1171 var visibility
= this.visibility();
1172 for (var i
= 0; i
< num
; i
++) {
1173 if (!visibility
[i
]) {
1176 var label
= labels
[i
+ 1];
1177 var colorStr
= this.attributes_
.getForSeries('color', label
);
1180 colorStr
= colors
[i
% colors
.length
];
1182 // alternate colors for high contrast.
1183 var idx
= i
% 2 ? (half
+ (i
+ 1)/ 2) : Math.ceil((i + 1) / 2);
1184 var hue
= (1.0 * idx
/ (1 + num
));
1185 colorStr
= Dygraph
.hsvToRGB(hue
, sat
, val
);
1188 this.colors_
.push(colorStr
);
1189 this.colorsMap_
[label
] = colorStr
;
1194 * Return the list of colors. This is either the list of colors passed in the
1195 * attributes or the autogenerated list of rgb(r,g,b) strings.
1196 * This does not return colors for invisible series.
1197 * @return {Array<string>} The list of colors.
1199 Dygraph
.prototype.getColors
= function() {
1200 return this.colors_
;
1204 * Returns a few attributes of a series, i.e. its color, its visibility, which
1205 * axis it's assigned to, and its column in the original data.
1206 * Returns null if the series does not exist.
1207 * Otherwise, returns an object with column, visibility, color and axis properties.
1208 * The "axis" property will be set to 1 for y1 and 2 for y2.
1209 * The "column" property can be fed back into getValue(row, column) to get
1210 * values for this series.
1212 Dygraph
.prototype.getPropertiesForSeries
= function(series_name
) {
1214 var labels
= this.getLabels();
1215 for (var i
= 1; i
< labels
.length
; i
++) {
1216 if (labels
[i
] == series_name
) {
1221 if (idx
== -1) return null;
1226 visible
: this.visibility()[idx
- 1],
1227 color
: this.colorsMap_
[series_name
],
1228 axis
: 1 + this.attributes_
.axisForSeries(series_name
)
1233 * Create the text box to adjust the averaging period
1236 Dygraph
.prototype.createRollInterface_
= function() {
1237 // Create a roller if one doesn't exist already.
1238 if (!this.roller_
) {
1239 this.roller_
= document
.createElement("input");
1240 this.roller_
.type
= "text";
1241 this.roller_
.style
.display
= "none";
1242 this.graphDiv
.appendChild(this.roller_
);
1245 var display
= this.attr_('showRoller') ? 'block' : 'none';
1247 var area
= this.plotter_
.area
;
1248 var textAttr
= { "position": "absolute",
1250 "top": (area
.y
+ area
.h
- 25) + "px",
1251 "left": (area
.x
+ 1) + "px",
1254 this.roller_
.size
= "2";
1255 this.roller_
.value
= this.rollPeriod_
;
1256 for (var name
in textAttr
) {
1257 if (textAttr
.hasOwnProperty(name
)) {
1258 this.roller_
.style
[name
] = textAttr
[name
];
1263 this.roller_
.onchange
= function() { dygraph
.adjustRoll(dygraph
.roller_
.value
); };
1268 * Converts page the x-coordinate of the event to pixel x-coordinates on the
1269 * canvas (i.e. DOM Coords).
1271 Dygraph
.prototype.dragGetX_
= function(e
, context
) {
1272 return Dygraph
.pageX(e
) - context
.px
;
1277 * Converts page the y-coordinate of the event to pixel y-coordinates on the
1278 * canvas (i.e. DOM Coords).
1280 Dygraph
.prototype.dragGetY_
= function(e
, context
) {
1281 return Dygraph
.pageY(e
) - context
.py
;
1285 * Set up all the mouse handlers needed to capture dragging behavior for zoom
1289 Dygraph
.prototype.createDragInterface_
= function() {
1291 // Tracks whether the mouse is down right now
1293 isPanning
: false, // is this drag part of a pan?
1294 is2DPan
: false, // if so, is that pan 1- or 2-dimensional?
1295 dragStartX
: null, // pixel coordinates
1296 dragStartY
: null, // pixel coordinates
1297 dragEndX
: null, // pixel coordinates
1298 dragEndY
: null, // pixel coordinates
1299 dragDirection
: null,
1300 prevEndX
: null, // pixel coordinates
1301 prevEndY
: null, // pixel coordinates
1302 prevDragDirection
: null,
1303 cancelNextDblclick
: false, // see comment in dygraph-interaction-model.js
1305 // The value on the left side of the graph when a pan operation starts.
1306 initialLeftmostDate
: null,
1308 // The number of units each pixel spans. (This won't be valid for log
1310 xUnitsPerPixel
: null,
1312 // TODO(danvk): update this comment
1313 // The range in second/value units that the viewport encompasses during a
1314 // panning operation.
1317 // Top-left corner of the canvas, in DOM coords
1318 // TODO(konigsberg): Rename topLeftCanvasX, topLeftCanvasY.
1322 // Values for use with panEdgeFraction, which limit how far outside the
1323 // graph's data boundaries it can be panned.
1324 boundedDates
: null, // [minDate, maxDate]
1325 boundedValues
: null, // [[minValue, maxValue] ...]
1327 // We cover iframes during mouse interactions. See comments in
1328 // dygraph-utils.js for more info on why this is a good idea.
1329 tarp
: new Dygraph
.IFrameTarp(),
1331 // contextB is the same thing as this context object but renamed.
1332 initializeMouseDown
: function(event
, g
, contextB
) {
1333 // prevents mouse drags from selecting page text.
1334 if (event
.preventDefault
) {
1335 event
.preventDefault(); // Firefox, Chrome, etc.
1337 event
.returnValue
= false; // IE
1338 event
.cancelBubble
= true;
1341 contextB
.px
= Dygraph
.findPosX(g
.canvas_
);
1342 contextB
.py
= Dygraph
.findPosY(g
.canvas_
);
1343 contextB
.dragStartX
= g
.dragGetX_(event
, contextB
);
1344 contextB
.dragStartY
= g
.dragGetY_(event
, contextB
);
1345 contextB
.cancelNextDblclick
= false;
1346 contextB
.tarp
.cover();
1350 var interactionModel
= this.attr_("interactionModel");
1352 // Self is the graph.
1355 // Function that binds the graph and context to the handler.
1356 var bindHandler
= function(handler
) {
1357 return function(event
) {
1358 handler(event
, self
, context
);
1362 for (var eventName
in interactionModel
) {
1363 if (!interactionModel
.hasOwnProperty(eventName
)) continue;
1364 this.addAndTrackEvent(this.mouseEventElement_
, eventName
,
1365 bindHandler(interactionModel
[eventName
]));
1368 // If the user releases the mouse button during a drag, but not over the
1369 // canvas, then it doesn't count as a zooming action.
1370 var mouseUpHandler
= function(event
) {
1371 if (context
.isZooming
|| context
.isPanning
) {
1372 context
.isZooming
= false;
1373 context
.dragStartX
= null;
1374 context
.dragStartY
= null;
1377 if (context
.isPanning
) {
1378 context
.isPanning
= false;
1379 context
.draggingDate
= null;
1380 context
.dateRange
= null;
1381 for (var i
= 0; i
< self
.axes_
.length
; i
++) {
1382 delete self
.axes_
[i
].draggingValue
;
1383 delete self
.axes_
[i
].dragValueRange
;
1387 context
.tarp
.uncover();
1390 this.addAndTrackEvent(document
, 'mouseup', mouseUpHandler
);
1394 * Draw a gray zoom rectangle over the desired area of the canvas. Also clears
1395 * up any previous zoom rectangles that were drawn. This could be optimized to
1396 * avoid extra redrawing, but it's tricky to avoid interactions with the status
1399 * @param {Number} direction the direction of the zoom rectangle. Acceptable
1400 * values are Dygraph.HORIZONTAL and Dygraph.VERTICAL.
1401 * @param {Number} startX The X position where the drag started, in canvas
1403 * @param {Number} endX The current X position of the drag, in canvas coords.
1404 * @param {Number} startY The Y position where the drag started, in canvas
1406 * @param {Number} endY The current Y position of the drag, in canvas coords.
1407 * @param {Number} prevDirection the value of direction on the previous call to
1408 * this function. Used to avoid excess redrawing
1409 * @param {Number} prevEndX The value of endX on the previous call to this
1410 * function. Used to avoid excess redrawing
1411 * @param {Number} prevEndY The value of endY on the previous call to this
1412 * function. Used to avoid excess redrawing
1415 Dygraph
.prototype.drawZoomRect_
= function(direction
, startX
, endX
, startY
,
1416 endY
, prevDirection
, prevEndX
,
1418 var ctx
= this.canvas_ctx_
;
1420 // Clean up from the previous rect if necessary
1421 if (prevDirection
== Dygraph
.HORIZONTAL
) {
1422 ctx
.clearRect(Math
.min(startX
, prevEndX
), this.layout_
.getPlotArea().y
,
1423 Math
.abs(startX
- prevEndX
), this.layout_
.getPlotArea().h
);
1424 } else if (prevDirection
== Dygraph
.VERTICAL
) {
1425 ctx
.clearRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, prevEndY
),
1426 this.layout_
.getPlotArea().w
, Math
.abs(startY
- prevEndY
));
1429 // Draw a light-grey rectangle to show the new viewing area
1430 if (direction
== Dygraph
.HORIZONTAL
) {
1431 if (endX
&& startX
) {
1432 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1433 ctx
.fillRect(Math
.min(startX
, endX
), this.layout_
.getPlotArea().y
,
1434 Math
.abs(endX
- startX
), this.layout_
.getPlotArea().h
);
1436 } else if (direction
== Dygraph
.VERTICAL
) {
1437 if (endY
&& startY
) {
1438 ctx
.fillStyle
= "rgba(128,128,128,0.33)";
1439 ctx
.fillRect(this.layout_
.getPlotArea().x
, Math
.min(startY
, endY
),
1440 this.layout_
.getPlotArea().w
, Math
.abs(endY
- startY
));
1444 if (this.isUsingExcanvas_
) {
1445 this.currentZoomRectArgs_
= [direction
, startX
, endX
, startY
, endY
, 0, 0, 0];
1450 * Clear the zoom rectangle (and perform no zoom).
1453 Dygraph
.prototype.clearZoomRect_
= function() {
1454 this.currentZoomRectArgs_
= null;
1455 this.canvas_ctx_
.clearRect(0, 0, this.canvas_
.width
, this.canvas_
.height
);
1459 * Zoom to something containing [lowX, highX]. These are pixel coordinates in
1460 * the canvas. The exact zoom window may be slightly larger if there are no data
1461 * points near lowX or highX. Don't confuse this function with doZoomXDates,
1462 * which accepts dates that match the raw data. This function redraws the graph.
1464 * @param {Number} lowX The leftmost pixel value that should be visible.
1465 * @param {Number} highX The rightmost pixel value that should be visible.
1468 Dygraph
.prototype.doZoomX_
= function(lowX
, highX
) {
1469 this.currentZoomRectArgs_
= null;
1470 // Find the earliest and latest dates contained in this canvasx range.
1471 // Convert the call to date ranges of the raw data.
1472 var minDate
= this.toDataXCoord(lowX
);
1473 var maxDate
= this.toDataXCoord(highX
);
1474 this.doZoomXDates_(minDate
, maxDate
);
1478 * Transition function to use in animations. Returns values between 0.0
1479 * (totally old values) and 1.0 (totally new values) for each frame.
1482 Dygraph
.zoomAnimationFunction
= function(frame
, numFrames
) {
1484 return (1.0 - Math
.pow(k
, -frame
)) / (1.0 - Math
.pow(k
, -numFrames
));
1488 * Zoom to something containing [minDate, maxDate] values. Don't confuse this
1489 * method with doZoomX which accepts pixel coordinates. This function redraws
1492 * @param {Number} minDate The minimum date that should be visible.
1493 * @param {Number} maxDate The maximum date that should be visible.
1496 Dygraph
.prototype.doZoomXDates_
= function(minDate
, maxDate
) {
1497 // TODO(danvk): when yAxisRange is null (i.e. "fit to data", the animation
1498 // can produce strange effects. Rather than the y-axis transitioning slowly
1499 // between values, it can jerk around.)
1500 var old_window
= this.xAxisRange();
1501 var new_window
= [minDate
, maxDate
];
1502 this.zoomed_x_
= true;
1504 this.doAnimatedZoom(old_window
, new_window
, null, null, function() {
1505 if (that
.attr_("zoomCallback")) {
1506 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1512 * Zoom to something containing [lowY, highY]. These are pixel coordinates in
1513 * the canvas. This function redraws the graph.
1515 * @param {Number} lowY The topmost pixel value that should be visible.
1516 * @param {Number} highY The lowest pixel value that should be visible.
1519 Dygraph
.prototype.doZoomY_
= function(lowY
, highY
) {
1520 this.currentZoomRectArgs_
= null;
1521 // Find the highest and lowest values in pixel range for each axis.
1522 // Note that lowY (in pixels) corresponds to the max Value (in data coords).
1523 // This is because pixels increase as you go down on the screen, whereas data
1524 // coordinates increase as you go up the screen.
1525 var oldValueRanges
= this.yAxisRanges();
1526 var newValueRanges
= [];
1527 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1528 var hi
= this.toDataYCoord(lowY
, i
);
1529 var low
= this.toDataYCoord(highY
, i
);
1530 newValueRanges
.push([low
, hi
]);
1533 this.zoomed_y_
= true;
1535 this.doAnimatedZoom(null, null, oldValueRanges
, newValueRanges
, function() {
1536 if (that
.attr_("zoomCallback")) {
1537 var xRange
= that
.xAxisRange();
1538 that
.attr_("zoomCallback")(xRange
[0], xRange
[1], that
.yAxisRanges());
1544 * Reset the zoom to the original view coordinates. This is the same as
1545 * double-clicking on the graph.
1547 Dygraph
.prototype.resetZoom
= function() {
1548 var dirty
= false, dirtyX
= false, dirtyY
= false;
1549 if (this.dateWindow_
!== null) {
1554 for (var i
= 0; i
< this.axes_
.length
; i
++) {
1555 if (typeof(this.axes_
[i
].valueWindow
) !== 'undefined' && this.axes_
[i
].valueWindow
!== null) {
1561 // Clear any selection, since it's likely to be drawn in the wrong place.
1562 this.clearSelection();
1565 this.zoomed_x_
= false;
1566 this.zoomed_y_
= false;
1568 var minDate
= this.rawData_
[0][0];
1569 var maxDate
= this.rawData_
[this.rawData_
.length
- 1][0];
1571 // With only one frame, don't bother calculating extreme ranges.
1572 // TODO(danvk): merge this block w/ the code below
.
1573 if (!this.attr_("animatedZooms")) {
1574 this.dateWindow_
= null;
1575 for (i
= 0; i
< this.axes_
.length
; i
++) {
1576 if (this.axes_
[i
].valueWindow
!== null) {
1577 delete this.axes_
[i
].valueWindow
;
1581 if (this.attr_("zoomCallback")) {
1582 this.attr_("zoomCallback")(minDate
, maxDate
, this.yAxisRanges());
1587 var oldWindow
=null, newWindow
=null, oldValueRanges
=null, newValueRanges
=null;
1589 oldWindow
= this.xAxisRange();
1590 newWindow
= [minDate
, maxDate
];
1594 oldValueRanges
= this.yAxisRanges();
1595 // TODO(danvk): this is pretty inefficient
1596 var packed
= this.gatherDatasets_(this.rolledSeries_
, null);
1597 var extremes
= packed
.extremes
;
1599 // this has the side-effect of modifying this.axes_.
1600 // this doesn't make much sense in this context, but it's convenient (we
1601 // need this.axes_[*].extremeValues) and not harmful since we'll be
1602 // calling drawGraph_ shortly, which clobbers these values.
1603 this.computeYAxisRanges_(extremes
);
1605 newValueRanges
= [];
1606 for (i
= 0; i
< this.axes_
.length
; i
++) {
1607 var axis
= this.axes_
[i
];
1608 newValueRanges
.push((axis
.valueRange
!== null &&
1609 axis
.valueRange
!== undefined
) ?
1610 axis
.valueRange
: axis
.extremeRange
);
1615 this.doAnimatedZoom(oldWindow
, newWindow
, oldValueRanges
, newValueRanges
,
1617 that
.dateWindow_
= null;
1618 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1619 if (that
.axes_
[i
].valueWindow
!== null) {
1620 delete that
.axes_
[i
].valueWindow
;
1623 if (that
.attr_("zoomCallback")) {
1624 that
.attr_("zoomCallback")(minDate
, maxDate
, that
.yAxisRanges());
1631 * Combined animation logic for all zoom functions.
1632 * either the x parameters or y parameters may be null.
1635 Dygraph
.prototype.doAnimatedZoom
= function(oldXRange
, newXRange
, oldYRanges
, newYRanges
, callback
) {
1636 var steps
= this.attr_("animatedZooms") ? Dygraph
.ANIMATION_STEPS
: 1;
1639 var valueRanges
= [];
1642 if (oldXRange
!== null && newXRange
!== null) {
1643 for (step
= 1; step
<= steps
; step
++) {
1644 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1645 windows
[step
-1] = [oldXRange
[0]*(1-frac
) + frac
*newXRange
[0],
1646 oldXRange
[1]*(1-frac
) + frac
*newXRange
[1]];
1650 if (oldYRanges
!== null && newYRanges
!== null) {
1651 for (step
= 1; step
<= steps
; step
++) {
1652 frac
= Dygraph
.zoomAnimationFunction(step
, steps
);
1654 for (var j
= 0; j
< this.axes_
.length
; j
++) {
1655 thisRange
.push([oldYRanges
[j
][0]*(1-frac
) + frac
*newYRanges
[j
][0],
1656 oldYRanges
[j
][1]*(1-frac
) + frac
*newYRanges
[j
][1]]);
1658 valueRanges
[step
-1] = thisRange
;
1663 Dygraph
.repeatAndCleanup(function(step
) {
1664 if (valueRanges
.length
) {
1665 for (var i
= 0; i
< that
.axes_
.length
; i
++) {
1666 var w
= valueRanges
[step
][i
];
1667 that
.axes_
[i
].valueWindow
= [w
[0], w
[1]];
1670 if (windows
.length
) {
1671 that
.dateWindow_
= windows
[step
];
1674 }, steps
, Dygraph
.ANIMATION_DURATION
/ steps
, callback
);
1678 * Get the current graph's area object.
1680 * Returns: {x, y, w, h}
1682 Dygraph
.prototype.getArea
= function() {
1683 return this.plotter_
.area
;
1687 * Convert a mouse event to DOM coordinates relative to the graph origin.
1689 * Returns a two-element array: [X, Y].
1691 Dygraph
.prototype.eventToDomCoords
= function(event
) {
1692 if (event
.offsetX
&& event
.offsetY
) {
1693 return [ event
.offsetX
, event
.offsetY
];
1695 var canvasx
= Dygraph
.pageX(event
) - Dygraph
.findPosX(this.mouseEventElement_
);
1696 var canvasy
= Dygraph
.pageY(event
) - Dygraph
.findPosY(this.mouseEventElement_
);
1697 return [canvasx
, canvasy
];
1702 * Given a canvas X coordinate, find the closest row.
1703 * @param {Number} domX graph-relative DOM X coordinate
1704 * Returns: row number, integer
1707 Dygraph
.prototype.findClosestRow
= function(domX
) {
1708 var minDistX
= Infinity
;
1709 var closestRow
= -1;
1710 var sets
= this.layout_
.points
;
1711 for (var i
= 0; i
< sets
.length
; i
++) {
1712 var points
= sets
[i
];
1713 var len
= points
.length
;
1714 for (var j
= 0; j
< len
; j
++) {
1715 var point
= points
[j
];
1716 if (!Dygraph
.isValidPoint(point
, true)) continue;
1717 var dist
= Math
.abs(point
.canvasx
- domX
);
1718 if (dist
< minDistX
) {
1720 closestRow
= point
.idx
;
1729 * Given canvas X,Y coordinates, find the closest point.
1731 * This finds the individual data point across all visible series
1732 * that's closest to the supplied DOM coordinates using the standard
1733 * Euclidean X,Y distance.
1735 * @param {Number} domX graph-relative DOM X coordinate
1736 * @param {Number} domY graph-relative DOM Y coordinate
1737 * Returns: {row, seriesName, point}
1740 Dygraph
.prototype.findClosestPoint
= function(domX
, domY
) {
1741 var minDist
= Infinity
;
1742 var dist
, dx
, dy
, point
, closestPoint
, closestSeries
, closestRow
;
1743 for ( var setIdx
= this.layout_
.points
.length
- 1 ; setIdx
>= 0 ; --setIdx
) {
1744 var points
= this.layout_
.points
[setIdx
];
1745 for (var i
= 0; i
< points
.length
; ++i
) {
1747 if (!Dygraph
.isValidPoint(point
)) continue;
1748 dx
= point
.canvasx
- domX
;
1749 dy
= point
.canvasy
- domY
;
1750 dist
= dx
* dx
+ dy
* dy
;
1751 if (dist
< minDist
) {
1753 closestPoint
= point
;
1754 closestSeries
= setIdx
;
1755 closestRow
= point
.idx
;
1759 var name
= this.layout_
.setNames
[closestSeries
];
1768 * Given canvas X,Y coordinates, find the touched area in a stacked graph.
1770 * This first finds the X data point closest to the supplied DOM X coordinate,
1771 * then finds the series which puts the Y coordinate on top of its filled area,
1772 * using linear interpolation between adjacent point pairs.
1774 * @param {Number} domX graph-relative DOM X coordinate
1775 * @param {Number} domY graph-relative DOM Y coordinate
1776 * Returns: {row, seriesName, point}
1779 Dygraph
.prototype.findStackedPoint
= function(domX
, domY
) {
1780 var row
= this.findClosestRow(domX
);
1781 var closestPoint
, closestSeries
;
1782 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
1783 var boundary
= this.getLeftBoundary_(setIdx
);
1784 var rowIdx
= row
- boundary
;
1785 var points
= this.layout_
.points
[setIdx
];
1786 if (rowIdx
>= points
.length
) continue;
1787 var p1
= points
[rowIdx
];
1788 if (!Dygraph
.isValidPoint(p1
)) continue;
1789 var py
= p1
.canvasy
;
1790 if (domX
> p1
.canvasx
&& rowIdx
+ 1 < points
.length
) {
1791 // interpolate series Y value using next point
1792 var p2
= points
[rowIdx
+ 1];
1793 if (Dygraph
.isValidPoint(p2
)) {
1794 var dx
= p2
.canvasx
- p1
.canvasx
;
1796 var r
= (domX
- p1
.canvasx
) / dx
;
1797 py
+= r
* (p2
.canvasy
- p1
.canvasy
);
1800 } else if (domX
< p1
.canvasx
&& rowIdx
> 0) {
1801 // interpolate series Y value using previous point
1802 var p0
= points
[rowIdx
- 1];
1803 if (Dygraph
.isValidPoint(p0
)) {
1804 var dx
= p1
.canvasx
- p0
.canvasx
;
1806 var r
= (p1
.canvasx
- domX
) / dx
;
1807 py
+= r
* (p0
.canvasy
- p1
.canvasy
);
1811 // Stop if the point (domX, py) is above this series' upper edge
1812 if (setIdx
=== 0 || py
< domY
) {
1814 closestSeries
= setIdx
;
1817 var name
= this.layout_
.setNames
[closestSeries
];
1826 * When the mouse moves in the canvas, display information about a nearby data
1827 * point and draw dots over those points in the data series. This function
1828 * takes care of cleanup of previously-drawn dots.
1829 * @param {Object} event The mousemove event from the browser.
1832 Dygraph
.prototype.mouseMove_
= function(event
) {
1833 // This prevents JS errors when mousing over the canvas before data loads.
1834 var points
= this.layout_
.points
;
1835 if (points
=== undefined
|| points
=== null) return;
1837 var canvasCoords
= this.eventToDomCoords(event
);
1838 var canvasx
= canvasCoords
[0];
1839 var canvasy
= canvasCoords
[1];
1841 var highlightSeriesOpts
= this.attr_("highlightSeriesOpts");
1842 var selectionChanged
= false;
1843 if (highlightSeriesOpts
&& !this.isSeriesLocked()) {
1845 if (this.attr_("stackedGraph")) {
1846 closest
= this.findStackedPoint(canvasx
, canvasy
);
1848 closest
= this.findClosestPoint(canvasx
, canvasy
);
1850 selectionChanged
= this.setSelection(closest
.row
, closest
.seriesName
);
1852 var idx
= this.findClosestRow(canvasx
);
1853 selectionChanged
= this.setSelection(idx
);
1856 var callback
= this.attr_("highlightCallback");
1857 if (callback
&& selectionChanged
) {
1862 this.highlightSet_
);
1867 * Fetch left offset from the specified set index or if not passed, the
1868 * first defined boundaryIds record (see bug #236).
1871 Dygraph
.prototype.getLeftBoundary_
= function(setIdx
) {
1872 if (this.boundaryIds_
[setIdx
]) {
1873 return this.boundaryIds_
[setIdx
][0];
1875 for (var i
= 0; i
< this.boundaryIds_
.length
; i
++) {
1876 if (this.boundaryIds_
[i
] !== undefined
) {
1877 return this.boundaryIds_
[i
][0];
1884 Dygraph
.prototype.animateSelection_
= function(direction
) {
1885 var totalSteps
= 10;
1887 if (this.fadeLevel
=== undefined
) this.fadeLevel
= 0;
1888 if (this.animateId
=== undefined
) this.animateId
= 0;
1889 var start
= this.fadeLevel
;
1890 var steps
= direction
< 0 ? start
: totalSteps
- start
;
1892 if (this.fadeLevel
) {
1893 this.updateSelection_(1.0);
1898 var thisId
= ++this.animateId
;
1900 Dygraph
.repeatAndCleanup(
1902 // ignore simultaneous animations
1903 if (that
.animateId
!= thisId
) return;
1905 that
.fadeLevel
+= direction
;
1906 if (that
.fadeLevel
=== 0) {
1907 that
.clearSelection();
1909 that
.updateSelection_(that
.fadeLevel
/ totalSteps
);
1912 steps
, millis
, function() {});
1916 * Draw dots over the selectied points in the data series. This function
1917 * takes care of cleanup of previously-drawn dots.
1920 Dygraph
.prototype.updateSelection_
= function(opt_animFraction
) {
1921 /*var defaultPrevented = */
1922 this.cascadeEvents_('select', {
1923 selectedX
: this.lastx_
,
1924 selectedPoints
: this.selPoints_
1926 // TODO(danvk): use defaultPrevented here?
1928 // Clear the previously drawn vertical, if there is one
1930 var ctx
= this.canvas_ctx_
;
1931 if (this.attr_('highlightSeriesOpts')) {
1932 ctx
.clearRect(0, 0, this.width_
, this.height_
);
1933 var alpha
= 1.0 - this.attr_('highlightSeriesBackgroundAlpha');
1935 // Activating background fade includes an animation effect for a gradual
1936 // fade. TODO(klausw): make this independently configurable if it causes
1937 // issues? Use a shared preference to control animations?
1938 var animateBackgroundFade
= true;
1939 if (animateBackgroundFade
) {
1940 if (opt_animFraction
=== undefined
) {
1941 // start a new animation
1942 this.animateSelection_(1);
1945 alpha
*= opt_animFraction
;
1947 ctx
.fillStyle
= 'rgba(255,255,255,' + alpha
+ ')';
1948 ctx
.fillRect(0, 0, this.width_
, this.height_
);
1951 // Redraw only the highlighted series in the interactive canvas (not the
1952 // static plot canvas, which is where series are usually drawn).
1953 this.plotter_
._renderLineChart(this.highlightSet_
, ctx
);
1954 } else if (this.previousVerticalX_
>= 0) {
1955 // Determine the maximum highlight circle size.
1956 var maxCircleSize
= 0;
1957 var labels
= this.attr_('labels');
1958 for (i
= 1; i
< labels
.length
; i
++) {
1959 var r
= this.attr_('highlightCircleSize', labels
[i
]);
1960 if (r
> maxCircleSize
) maxCircleSize
= r
;
1962 var px
= this.previousVerticalX_
;
1963 ctx
.clearRect(px
- maxCircleSize
- 1, 0,
1964 2 * maxCircleSize
+ 2, this.height_
);
1967 if (this.isUsingExcanvas_
&& this.currentZoomRectArgs_
) {
1968 Dygraph
.prototype.drawZoomRect_
.apply(this, this.currentZoomRectArgs_
);
1971 if (this.selPoints_
.length
> 0) {
1972 // Draw colored circles over the center of each selected point
1973 var canvasx
= this.selPoints_
[0].canvasx
;
1975 for (i
= 0; i
< this.selPoints_
.length
; i
++) {
1976 var pt
= this.selPoints_
[i
];
1977 if (!Dygraph
.isOK(pt
.canvasy
)) continue;
1979 var circleSize
= this.attr_('highlightCircleSize', pt
.name
);
1980 var callback
= this.attr_("drawHighlightPointCallback", pt
.name
);
1981 var color
= this.plotter_
.colors
[pt
.name
];
1983 callback
= Dygraph
.Circles
.DEFAULT
;
1985 ctx
.lineWidth
= this.attr_('strokeWidth', pt
.name
);
1986 ctx
.strokeStyle
= color
;
1987 ctx
.fillStyle
= color
;
1988 callback(this.g
, pt
.name
, ctx
, canvasx
, pt
.canvasy
,
1989 color
, circleSize
, pt
.idx
);
1993 this.previousVerticalX_
= canvasx
;
1998 * Manually set the selected points and display information about them in the
1999 * legend. The selection can be cleared using clearSelection() and queried
2000 * using getSelection().
2001 * @param { Integer } row number that should be highlighted (i.e. appear with
2002 * hover dots on the chart). Set to false to clear any selection.
2003 * @param { seriesName } optional series name to highlight that series with the
2004 * the highlightSeriesOpts setting.
2005 * @param { locked } optional If true, keep seriesName selected when mousing
2006 * over the graph, disabling closest-series highlighting. Call clearSelection()
2009 Dygraph
.prototype.setSelection
= function(row
, opt_seriesName
, opt_locked
) {
2010 // Extract the points we've selected
2011 this.selPoints_
= [];
2013 var changed
= false;
2014 if (row
!== false && row
>= 0) {
2015 if (row
!= this.lastRow_
) changed
= true;
2016 this.lastRow_
= row
;
2017 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; ++setIdx
) {
2018 var points
= this.layout_
.points
[setIdx
];
2019 var setRow
= row
- this.getLeftBoundary_(setIdx
);
2020 if (setRow
< points
.length
) {
2021 var point
= points
[setRow
];
2022 if (point
.yval
!== null) this.selPoints_
.push(point
);
2026 if (this.lastRow_
>= 0) changed
= true;
2030 if (this.selPoints_
.length
) {
2031 this.lastx_
= this.selPoints_
[0].xval
;
2036 if (opt_seriesName
!== undefined
) {
2037 if (this.highlightSet_
!== opt_seriesName
) changed
= true;
2038 this.highlightSet_
= opt_seriesName
;
2041 if (opt_locked
!== undefined
) {
2042 this.lockedSet_
= opt_locked
;
2046 this.updateSelection_(undefined
);
2052 * The mouse has left the canvas. Clear out whatever artifacts remain
2053 * @param {Object} event the mouseout event from the browser.
2056 Dygraph
.prototype.mouseOut_
= function(event
) {
2057 if (this.attr_("unhighlightCallback")) {
2058 this.attr_("unhighlightCallback")(event
);
2061 if (this.attr_("hideOverlayOnMouseOut") && !this.lockedSet_
) {
2062 this.clearSelection();
2067 * Clears the current selection (i.e. points that were highlighted by moving
2068 * the mouse over the chart).
2070 Dygraph
.prototype.clearSelection
= function() {
2071 this.cascadeEvents_('deselect', {});
2073 this.lockedSet_
= false;
2074 // Get rid of the overlay data
2075 if (this.fadeLevel
) {
2076 this.animateSelection_(-1);
2079 this.canvas_ctx_
.clearRect(0, 0, this.width_
, this.height_
);
2081 this.selPoints_
= [];
2084 this.highlightSet_
= null;
2088 * Returns the number of the currently selected row. To get data for this row,
2089 * you can use the getValue method.
2090 * @return { Integer } row number, or -1 if nothing is selected
2092 Dygraph
.prototype.getSelection
= function() {
2093 if (!this.selPoints_
|| this.selPoints_
.length
< 1) {
2097 for (var setIdx
= 0; setIdx
< this.layout_
.points
.length
; setIdx
++) {
2098 var points
= this.layout_
.points
[setIdx
];
2099 for (var row
= 0; row
< points
.length
; row
++) {
2100 if (points
[row
].x
== this.selPoints_
[0].x
) {
2101 return points
[row
].idx
;
2109 * Returns the name of the currently-highlighted series.
2110 * Only available when the highlightSeriesOpts option is in use.
2112 Dygraph
.prototype.getHighlightSeries
= function() {
2113 return this.highlightSet_
;
2117 * Returns true if the currently-highlighted series was locked
2118 * via setSelection(..., seriesName, true).
2120 Dygraph
.prototype.isSeriesLocked
= function() {
2121 return this.lockedSet_
;
2125 * Fires when there's data available to be graphed.
2126 * @param {String} data Raw CSV data to be plotted
2129 Dygraph
.prototype.loadedEvent_
= function(data
) {
2130 this.rawData_
= this.parseCSV_(data
);
2135 * Add ticks on the x-axis representing years, months, quarters, weeks, or days
2138 Dygraph
.prototype.addXTicks_
= function() {
2139 // Determine the correct ticks scale on the x-axis: quarterly, monthly, ...
2141 if (this.dateWindow_
) {
2142 range
= [this.dateWindow_
[0], this.dateWindow_
[1]];
2144 range
= this.xAxisExtremes();
2147 var xAxisOptionsView
= this.optionsViewForAxis_('x');
2148 var xTicks
= xAxisOptionsView('ticker')(
2151 this.width_
, // TODO(danvk): should be area.width
2154 // var msg = 'ticker(' + range[0] + ', ' + range[1] + ', ' + this.width_ + ', ' + this.attr_('pixelsPerXLabel') + ') -> ' + JSON.stringify(xTicks);
2155 // console.log(msg);
2156 this.layout_
.setXTicks(xTicks
);
2160 * Returns the correct handler class for the currently set options.
2163 Dygraph
.prototype.getHandlerClass_
= function() {
2165 if (this.attr_('dataHandler')) {
2166 handlerClass
= this.attr_('dataHandler');
2167 } else if (this.fractions_
) {
2168 if (this.attr_('errorBars')) {
2169 handlerClass
= Dygraph
.DataHandlers
.FractionsBarsHandler
;
2171 handlerClass
= Dygraph
.DataHandlers
.DefaultFractionHandler
;
2173 } else if (this.attr_('customBars')) {
2174 handlerClass
= Dygraph
.DataHandlers
.CustomBarsHandler
;
2175 } else if (this.attr_('errorBars')) {
2176 handlerClass
= Dygraph
.DataHandlers
.ErrorBarsHandler
;
2178 handlerClass
= Dygraph
.DataHandlers
.DefaultHandler
;
2180 return handlerClass
;
2185 * This function is called once when the chart's data is changed or the options
2186 * dictionary is updated. It is _not_ called when the user pans or zooms. The
2187 * idea is that values derived from the chart's data can be computed here,
2188 * rather than every time the chart is drawn. This includes things like the
2189 * number of axes, rolling averages, etc.
2191 Dygraph
.prototype.predraw_
= function() {
2192 var start
= new Date();
2194 // Create the correct dataHandler
2195 this.dataHandler_
= new (this.getHandlerClass_())();
2197 this.layout_
.computePlotArea();
2199 // TODO(danvk): move more computations out of drawGraph_ and into here.
2200 this.computeYAxes_();
2202 // Create a new plotter.
2203 if (this.plotter_
) {
2204 this.cascadeEvents_('clearChart');
2205 this.plotter_
.clear();
2208 if (!this.is_initial_draw_
) {
2209 this.canvas_ctx_
.restore();
2210 this.hidden_ctx_
.restore();
2213 this.canvas_ctx_
.save();
2214 this.hidden_ctx_
.save();
2216 this.plotter_
= new DygraphCanvasRenderer(this,
2221 // The roller sits in the bottom left corner of the chart. We don't know where
2222 // this will be until the options are available, so it's positioned here.
2223 this.createRollInterface_();
2225 this.cascadeEvents_('predraw');
2227 // Convert the raw data (a 2D array) into the internal format and compute
2228 // rolling averages.
2229 this.rolledSeries_
= [null]; // x-axis is the first series and it's special
2230 for (var i
= 1; i
< this.numColumns(); i
++) {
2231 // var logScale = this.attr_('logscale', i); // TODO(klausw): this looks wrong // konigsberg thinks so too
.
2232 var series
= this.dataHandler_
.extractSeries(this.rawData_
, i
, this.attributes_
);
2233 if (this.rollPeriod_
> 1) {
2234 series
= this.dataHandler_
.rollingAverage(series
, this.rollPeriod_
, this.attributes_
);
2237 this.rolledSeries_
.push(series
);
2240 // If the data or options have changed, then we'd better redraw.
2243 // This is used to determine whether to do various animations.
2244 var end
= new Date();
2245 this.drawingTimeMs_
= (end
- start
);
2251 * xval_* and yval_* are the original unscaled data values,
2252 * while x_* and y_* are scaled to the range (0.0-1.0) for plotting.
2253 * yval_stacked is the cumulative Y value used for stacking graphs,
2254 * and bottom/top/minus/plus are used for error bar graphs.
2261 * y_bottom: ?number,
2263 * y_stacked: ?number,
2265 * yval_minus: ?number,
2267 * yval_plus: ?number,
2271 Dygraph
.PointType
= undefined
;
2274 * Calculates point stacking for stackedGraph=true.
2276 * For stacking purposes, interpolate or extend neighboring data across
2277 * NaN values based on stackedGraphNaNFill settings. This is for display
2278 * only, the underlying data value as shown in the legend remains NaN.
2280 * @param {Array.<Dygraph.PointType>} points Point array for a single series.
2281 * Updates each Point's yval_stacked property.
2282 * @param {Array.<number>} cumulativeYval Accumulated top-of-graph stacked Y
2283 * values for the series seen so far. Index is the row number. Updated
2284 * based on the current series's values.
2285 * @param {Array.<number>} seriesExtremes Min and max values, updated
2286 * to reflect the stacked values.
2287 * @param {string} fillMethod Interpolation method, one of 'all', 'inside', or
2291 Dygraph
.stackPoints_
= function(
2292 points
, cumulativeYval
, seriesExtremes
, fillMethod
) {
2293 var lastXval
= null;
2294 var prevPoint
= null;
2295 var nextPoint
= null;
2296 var nextPointIdx
= -1;
2298 // Find the next stackable point starting from the given index.
2299 var updateNextPoint
= function(idx
) {
2300 // If we've previously found a non-NaN point and haven't gone past it yet,
2302 if (nextPointIdx
>= idx
) return;
2304 // We haven't found a non-NaN point yet or have moved past it,
2305 // look towards the right to find a non-NaN point.
2306 for (var j
= idx
; j
< points
.length
; ++j
) {
2307 // Clear out a previously-found point (if any) since it's no longer
2308 // valid, we shouldn't use it for interpolation anymore.
2310 if (!isNaN(points
[j
].yval
) && points
[j
].yval
!== null) {
2312 nextPoint
= points
[j
];
2318 for (var i
= 0; i
< points
.length
; ++i
) {
2319 var point
= points
[i
];
2320 var xval
= point
.xval
;
2321 if (cumulativeYval
[xval
] === undefined
) {
2322 cumulativeYval
[xval
] = 0;
2325 var actualYval
= point
.yval
;
2326 if (isNaN(actualYval
) || actualYval
=== null) {
2327 // Interpolate/extend
for stacking purposes
if possible
.
2329 if (prevPoint
&& nextPoint
&& fillMethod
!= 'none') {
2330 // Use linear interpolation between prevPoint and nextPoint.
2331 actualYval
= prevPoint
.yval
+ (nextPoint
.yval
- prevPoint
.yval
) *
2332 ((xval
- prevPoint
.xval
) / (nextPoint
.xval
- prevPoint
.xval
));
2333 } else if (prevPoint
&& fillMethod
== 'all') {
2334 actualYval
= prevPoint
.yval
;
2335 } else if (nextPoint
&& fillMethod
== 'all') {
2336 actualYval
= nextPoint
.yval
;
2344 var stackedYval
= cumulativeYval
[xval
];
2345 if (lastXval
!= xval
) {
2346 // If an x-value is repeated, we ignore the duplicates.
2347 stackedYval
+= actualYval
;
2348 cumulativeYval
[xval
] = stackedYval
;
2352 point
.yval_stacked
= stackedYval
;
2354 if (stackedYval
> seriesExtremes
[1]) {
2355 seriesExtremes
[1] = stackedYval
;
2357 if (stackedYval
< seriesExtremes
[0]) {
2358 seriesExtremes
[0] = stackedYval
;
2365 * Loop over all fields and create datasets, calculating extreme y-values for
2366 * each series and extreme x-indices as we go.
2368 * dateWindow is passed in as an explicit parameter so that we can compute
2369 * extreme values "speculatively", i.e. without actually setting state on the
2372 * @param {Array.<Array.<Array.<(number|Array<number>)>>} rolledSeries, where
2373 * rolledSeries[seriesIndex][row] = raw point, where
2374 * seriesIndex is the column number starting with 1, and
2375 * rawPoint is [x,y] or [x, [y, err]] or [x, [y, yminus, yplus]].
2376 * @param {?Array.<number>} dateWindow [xmin, xmax] pair, or null.
2378 * points: Array.<Array.<Dygraph.PointType>>,
2379 * seriesExtremes: Array.<Array.<number>>,
2380 * boundaryIds: Array.<number>}}
2383 Dygraph
.prototype.gatherDatasets_
= function(rolledSeries
, dateWindow
) {
2384 var boundaryIds
= [];
2386 var cumulativeYval
= []; // For stacked series.
2387 var extremes
= {}; // series name -> [low, high]
2388 var seriesIdx
, sampleIdx
;
2389 var firstIdx
, lastIdx
;
2391 // Loop over the fields (series). Go from the last to the first,
2392 // because if they're stacked that's how we accumulate the values.
2393 var num_series
= rolledSeries
.length
- 1;
2395 for (seriesIdx
= num_series
; seriesIdx
>= 1; seriesIdx
--) {
2396 if (!this.visibility()[seriesIdx
- 1]) continue;
2398 // Prune down to the desired range, if necessary (for zooming)
2399 // Because there can be lines going to points outside of the visible area,
2400 // we actually prune to visible points, plus one on either side.
2402 series
= rolledSeries
[seriesIdx
];
2403 var low
= dateWindow
[0];
2404 var high
= dateWindow
[1];
2406 // TODO(danvk): do binary search instead of linear search.
2407 // TODO(danvk): pass firstIdx and lastIdx directly to the renderer.
2410 for (sampleIdx
= 0; sampleIdx
< series
.length
; sampleIdx
++) {
2411 if (series
[sampleIdx
][0] >= low
&& firstIdx
=== null) {
2412 firstIdx
= sampleIdx
;
2414 if (series
[sampleIdx
][0] <= high
) {
2415 lastIdx
= sampleIdx
;
2419 if (firstIdx
=== null) firstIdx
= 0;
2420 var correctedFirstIdx
= firstIdx
;
2421 var isInvalidValue
= true;
2422 while (isInvalidValue
&& correctedFirstIdx
> 0) {
2423 correctedFirstIdx
--;
2424 // check if the y value is null.
2425 isInvalidValue
= series
[correctedFirstIdx
][1] === null;
2428 if (lastIdx
=== null) lastIdx
= series
.length
- 1;
2429 var correctedLastIdx
= lastIdx
;
2430 isInvalidValue
= true;
2431 while (isInvalidValue
&& correctedLastIdx
< series
.length
- 1) {
2433 isInvalidValue
= series
[correctedLastIdx
][1] === null;
2436 if (correctedFirstIdx
!==firstIdx
) {
2437 firstIdx
= correctedFirstIdx
;
2439 if (correctedLastIdx
!== lastIdx
) {
2440 lastIdx
= correctedLastIdx
;
2443 boundaryIds
[seriesIdx
-1] = [firstIdx
, lastIdx
];
2445 // .slice's end is exclusive, we want to include lastIdx.
2446 series
= series
.slice(firstIdx
, lastIdx
+ 1);
2448 series
= rolledSeries
[seriesIdx
];
2449 boundaryIds
[seriesIdx
-1] = [0, series
.length
-1];
2452 var seriesName
= this.attr_("labels")[seriesIdx
];
2453 var seriesExtremes
= this.dataHandler_
.getExtremeYValues(series
,
2454 dateWindow
, this.attr_("stepPlot",seriesName
));
2456 var seriesPoints
= this.dataHandler_
.seriesToPoints(series
,
2457 seriesName
, boundaryIds
[seriesIdx
-1][0]);
2459 if (this.attr_("stackedGraph")) {
2460 Dygraph
.stackPoints_(seriesPoints
, cumulativeYval
, seriesExtremes
,
2461 this.attr_("stackedGraphNaNFill"));
2464 extremes
[seriesName
] = seriesExtremes
;
2465 points
[seriesIdx
] = seriesPoints
;
2468 return { points
: points
, extremes
: extremes
, boundaryIds
: boundaryIds
};
2472 * Update the graph with new data. This method is called when the viewing area
2473 * has changed. If the underlying data or options have changed, predraw_ will
2474 * be called before drawGraph_ is called.
2478 Dygraph
.prototype.drawGraph_
= function() {
2479 var start
= new Date();
2481 // This is used to set the second parameter to drawCallback, below.
2482 var is_initial_draw
= this.is_initial_draw_
;
2483 this.is_initial_draw_
= false;
2485 this.layout_
.removeAllDatasets();
2487 this.attrs_
.pointSize
= 0.5 * this.attr_('highlightCircleSize');
2489 var packed
= this.gatherDatasets_(this.rolledSeries_
, this.dateWindow_
);
2490 var points
= packed
.points
;
2491 var extremes
= packed
.extremes
;
2492 this.boundaryIds_
= packed
.boundaryIds
;
2494 this.setIndexByName_
= {};
2495 var labels
= this.attr_("labels");
2496 if (labels
.length
> 0) {
2497 this.setIndexByName_
[labels
[0]] = 0;
2500 for (var i
= 1; i
< points
.length
; i
++) {
2501 this.setIndexByName_
[labels
[i
]] = i
;
2502 if (!this.visibility()[i
- 1]) continue;
2503 this.layout_
.addDataset(labels
[i
], points
[i
]);
2504 this.datasetIndex_
[i
] = dataIdx
++;
2507 this.computeYAxisRanges_(extremes
);
2508 this.layout_
.setYAxes(this.axes_
);
2512 // Save the X axis zoomed status as the updateOptions call will tend to set it erroneously
2513 var tmp_zoomed_x
= this.zoomed_x_
;
2514 // Tell PlotKit to use this new data and render itself
2515 this.zoomed_x_
= tmp_zoomed_x
;
2516 this.layout_
.evaluate();
2517 this.renderGraph_(is_initial_draw
);
2519 if (this.attr_("timingName")) {
2520 var end
= new Date();
2521 Dygraph
.info(this.attr_("timingName") + " - drawGraph: " + (end
- start
) + "ms");
2526 * This does the work of drawing the chart. It assumes that the layout and axis
2527 * scales have already been set (e.g. by predraw_).
2531 Dygraph
.prototype.renderGraph_
= function(is_initial_draw
) {
2532 this.cascadeEvents_('clearChart');
2533 this.plotter_
.clear();
2535 if (this.attr_('underlayCallback')) {
2536 // NOTE: we pass the dygraph object to this callback twice to avoid breaking
2537 // users who expect a deprecated form of this callback.
2538 this.attr_('underlayCallback')(
2539 this.hidden_ctx_
, this.layout_
.getPlotArea(), this, this);
2543 canvas
: this.hidden_
,
2544 drawingContext
: this.hidden_ctx_
2546 this.cascadeEvents_('willDrawChart', e
);
2547 this.plotter_
.render();
2548 this.cascadeEvents_('didDrawChart', e
);
2549 this.lastRow_
= -1; // because plugins/legend.js clears the legend
2551 // TODO(danvk): is this a performance bottleneck when panning?
2552 // The interaction canvas should already be empty in that situation.
2553 this.canvas_
.getContext('2d').clearRect(0, 0, this.canvas_
.width
,
2554 this.canvas_
.height
);
2556 if (this.attr_("drawCallback") !== null) {
2557 this.attr_("drawCallback")(this, is_initial_draw
);
2559 if (is_initial_draw
) {
2560 this.readyFired_
= true;
2561 while (this.readyFns_
.length
> 0) {
2562 var fn
= this.readyFns_
.pop();
2570 * Determine properties of the y-axes which are independent of the data
2571 * currently being displayed. This includes things like the number of axes and
2572 * the style of the axes. It does not include the range of each axis and its
2574 * This fills in this.axes_.
2575 * axes_ = [ { options } ]
2576 * indices are into the axes_ array.
2578 Dygraph
.prototype.computeYAxes_
= function() {
2579 // Preserve valueWindow settings if they exist, and if the user hasn't
2580 // specified a new valueRange.
2581 var valueWindows
, axis
, index
, opts
, v
;
2582 if (this.axes_
!== undefined
&& this.user_attrs_
.hasOwnProperty("valueRange") === false) {
2584 for (index
= 0; index
< this.axes_
.length
; index
++) {
2585 valueWindows
.push(this.axes_
[index
].valueWindow
);
2589 // this.axes_ doesn't match this.attributes_.axes_.options. It's used for
2590 // data computation as well as options storage.
2591 // Go through once and add all the axes.
2594 for (axis
= 0; axis
< this.attributes_
.numAxes(); axis
++) {
2595 // Add a new axis, making a copy of its per-axis options.
2596 opts
= { g
: this };
2597 Dygraph
.update(opts
, this.attributes_
.axisOptions(axis
));
2598 this.axes_
[axis
] = opts
;
2602 // Copy global valueRange option over to the first axis.
2603 // NOTE(konigsberg): Are these two statements necessary?
2604 // I tried removing it. The automated tests pass, and manually
2605 // messing with tests/zoom
.html showed no trouble
.
2606 v
= this.attr_('valueRange');
2607 if (v
) this.axes_
[0].valueRange
= v
;
2609 if (valueWindows
!== undefined
) {
2610 // Restore valueWindow settings.
2612 // When going from two axes back to one, we only restore
2614 var idxCount
= Math
.min(valueWindows
.length
, this.axes_
.length
);
2616 for (index
= 0; index
< idxCount
; index
++) {
2617 this.axes_
[index
].valueWindow
= valueWindows
[index
];
2621 for (axis
= 0; axis
< this.axes_
.length
; axis
++) {
2623 opts
= this.optionsViewForAxis_('y' + (axis
? '2' : ''));
2624 v
= opts("valueRange");
2625 if (v
) this.axes_
[axis
].valueRange
= v
;
2626 } else { // To keep old behavior
2627 var axes
= this.user_attrs_
.axes
;
2628 if (axes
&& axes
.y2
) {
2629 v
= axes
.y2
.valueRange
;
2630 if (v
) this.axes_
[axis
].valueRange
= v
;
2637 * Returns the number of y-axes on the chart.
2638 * @return {Number} the number of axes.
2640 Dygraph
.prototype.numAxes
= function() {
2641 return this.attributes_
.numAxes();
2646 * Returns axis properties for the given series.
2647 * @param { String } setName The name of the series for which to get axis
2648 * properties, e.g. 'Y1'.
2649 * @return { Object } The axis properties.
2651 Dygraph
.prototype.axisPropertiesForSeries
= function(series
) {
2652 // TODO(danvk): handle errors.
2653 return this.axes_
[this.attributes_
.axisForSeries(series
)];
2658 * Determine the value range and tick marks for each axis.
2659 * @param {Object} extremes A mapping from seriesName -> [low, high]
2660 * This fills in the valueRange and ticks fields in each entry of this.axes_.
2662 Dygraph
.prototype.computeYAxisRanges_
= function(extremes
) {
2663 var isNullUndefinedOrNaN
= function(num
) {
2664 return isNaN(parseFloat(num
));
2666 var numAxes
= this.attributes_
.numAxes();
2667 var ypadCompat
, span
, series
, ypad
;
2671 // Compute extreme values, a span and tick marks for each axis.
2672 for (var i
= 0; i
< numAxes
; i
++) {
2673 var axis
= this.axes_
[i
];
2674 var logscale
= this.attributes_
.getForAxis("logscale", i
);
2675 var includeZero
= this.attributes_
.getForAxis("includeZero", i
);
2676 var independentTicks
= this.attributes_
.getForAxis("independentTicks", i
);
2677 series
= this.attributes_
.seriesForAxis(i
);
2679 // Add some padding. This supports two Y padding operation modes:
2681 // - backwards compatible (yRangePad not set):
2682 // 10% padding for automatic Y ranges, but not for user-supplied
2683 // ranges, and move a close-to-zero edge to zero except if
2684 // avoidMinZero is set, since drawing at the edge results in
2685 // invisible lines. Unfortunately lines drawn at the edge of a
2686 // user-supplied range will still be invisible. If logscale is
2687 // set, add a variable amount of padding at the top but
2688 // none at the bottom.
2690 // - new-style (yRangePad set by the user):
2691 // always add the specified Y padding.
2694 ypad
= 0.1; // add 10%
2695 if (this.attr_('yRangePad') !== null) {
2697 // Convert pixel padding to ratio
2698 ypad
= this.attr_('yRangePad') / this.plotter_
.area
.h
;
2701 if (series
.length
=== 0) {
2702 // If no series are defined or visible then use a reasonable default
2703 axis
.extremeRange
= [0, 1];
2705 // Calculate the extremes of extremes.
2706 var minY
= Infinity
; // extremes[series[0]][0];
2707 var maxY
= -Infinity
; // extremes[series[0]][1];
2708 var extremeMinY
, extremeMaxY
;
2710 for (var j
= 0; j
< series
.length
; j
++) {
2711 // this skips invisible series
2712 if (!extremes
.hasOwnProperty(series
[j
])) continue;
2714 // Only use valid extremes to stop null data series' from corrupting the scale.
2715 extremeMinY
= extremes
[series
[j
]][0];
2716 if (extremeMinY
!== null) {
2717 minY
= Math
.min(extremeMinY
, minY
);
2719 extremeMaxY
= extremes
[series
[j
]][1];
2720 if (extremeMaxY
!== null) {
2721 maxY
= Math
.max(extremeMaxY
, maxY
);
2725 // Include zero if requested by the user.
2726 if (includeZero
&& !logscale
) {
2727 if (minY
> 0) minY
= 0;
2728 if (maxY
< 0) maxY
= 0;
2731 // Ensure we have a valid scale, otherwise default to [0, 1] for safety.
2732 if (minY
== Infinity
) minY
= 0;
2733 if (maxY
== -Infinity
) maxY
= 1;
2736 // special case: if we have no sense of scale, center on the sole value.
2739 span
= Math
.abs(maxY
);
2741 // ... and if the sole value is zero, use range 0-1.
2747 var maxAxisY
, minAxisY
;
2750 maxAxisY
= maxY
+ ypad
* span
;
2753 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2754 maxAxisY
= maxY
* logpad
;
2755 minAxisY
= minY
/ logpad
;
2758 maxAxisY
= maxY
+ ypad
* span
;
2759 minAxisY
= minY
- ypad
* span
;
2761 // Backwards-compatible behavior: Move the span to start or end at zero if it's
2762 // close to zero, but not if avoidMinZero is set.
2763 if (ypadCompat
&& !this.attr_("avoidMinZero")) {
2764 if (minAxisY
< 0 && minY
>= 0) minAxisY
= 0;
2765 if (maxAxisY
> 0 && maxY
<= 0) maxAxisY
= 0;
2768 axis
.extremeRange
= [minAxisY
, maxAxisY
];
2770 if (axis
.valueWindow
) {
2771 // This is only set if the user has zoomed on the y-axis. It is never set
2772 // by a user. It takes precedence over axis.valueRange because, if you set
2773 // valueRange, you'd still expect to be able to pan.
2774 axis
.computedValueRange
= [axis
.valueWindow
[0], axis
.valueWindow
[1]];
2775 } else if (axis
.valueRange
) {
2776 // This is a user-set value range for this axis.
2777 var y0
= isNullUndefinedOrNaN(axis
.valueRange
[0]) ? axis
.extremeRange
[0] : axis
.valueRange
[0];
2778 var y1
= isNullUndefinedOrNaN(axis
.valueRange
[1]) ? axis
.extremeRange
[1] : axis
.valueRange
[1];
2780 if (axis
.logscale
) {
2781 var logpad
= Math
.exp(Math
.log(span
) * ypad
);
2790 axis
.computedValueRange
= [y0
, y1
];
2792 axis
.computedValueRange
= axis
.extremeRange
;
2796 if (independentTicks
) {
2797 axis
.independentTicks
= independentTicks
;
2798 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2799 var ticker
= opts('ticker');
2800 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2801 axis
.computedValueRange
[1],
2802 this.height_
, // TODO(danvk): should be area.height
2805 // Define the first independent axis as primary axis.
2806 if (!p_axis
) p_axis
= axis
;
2809 if (p_axis
=== undefined
) {
2810 throw ("Configuration Error: At least one axis has to have the \"independentTicks\" option activated.");
2812 // Add ticks. By default, all axes inherit the tick positions of the
2813 // primary axis. However, if an axis is specifically marked as having
2814 // independent ticks, then that is permissible as well.
2815 for (var i
= 0; i
< numAxes
; i
++) {
2816 var axis
= this.axes_
[i
];
2818 if (!axis
.independentTicks
) {
2819 var opts
= this.optionsViewForAxis_('y' + (i
? '2' : ''));
2820 var ticker
= opts('ticker');
2821 var p_ticks
= p_axis
.ticks
;
2822 var p_scale
= p_axis
.computedValueRange
[1] - p_axis
.computedValueRange
[0];
2823 var scale
= axis
.computedValueRange
[1] - axis
.computedValueRange
[0];
2824 var tick_values
= [];
2825 for (var k
= 0; k
< p_ticks
.length
; k
++) {
2826 var y_frac
= (p_ticks
[k
].v
- p_axis
.computedValueRange
[0]) / p_scale
;
2827 var y_val
= axis
.computedValueRange
[0] + y_frac
* scale
;
2828 tick_values
.push(y_val
);
2831 axis
.ticks
= ticker(axis
.computedValueRange
[0],
2832 axis
.computedValueRange
[1],
2833 this.height_
, // TODO(danvk): should be area.height
2842 * Detects the type of the str (date or numeric) and sets the various
2843 * formatting attributes in this.attrs_ based on this type.
2844 * @param {String} str An x value.
2847 Dygraph
.prototype.detectTypeFromString_
= function(str
) {
2849 var dashPos
= str
.indexOf('-'); // could be 2006-01-01 _or_ 1.0e-2
2850 if ((dashPos
> 0 && (str
[dashPos
-1] != 'e' && str
[dashPos
-1] != 'E')) ||
2851 str
.indexOf('/') >= 0 ||
2852 isNaN(parseFloat(str
))) {
2854 } else if (str
.length
== 8 && str
> '19700101' && str
< '20371231') {
2855 // TODO(danvk): remove support for this format.
2859 this.setXAxisOptions_(isDate
);
2862 Dygraph
.prototype.setXAxisOptions_
= function(isDate
) {
2864 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
2865 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
2866 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
2867 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
2869 /** @private (shut up, jsdoc!) */
2870 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
2871 // TODO(danvk): use Dygraph.numberValueFormatter here?
2872 /** @private (shut up, jsdoc!) */
2873 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
2874 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
2875 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
2880 * Parses the value as a floating point number. This is like the parseFloat()
2881 * built-in, but with a few differences:
2882 * - the empty string is parsed as null, rather than NaN.
2883 * - if the string cannot be parsed at all, an error is logged.
2884 * If the string can't be parsed, this method returns null.
2885 * @param {String} x The string to be parsed
2886 * @param {Number} opt_line_no The line number from which the string comes.
2887 * @param {String} opt_line The text of the line from which the string comes.
2891 // Parse the x as a float or return null if it's not a number.
2892 Dygraph
.prototype.parseFloat_
= function(x
, opt_line_no
, opt_line
) {
2893 var val
= parseFloat(x
);
2894 if (!isNaN(val
)) return val
;
2896 // Try to figure out what happeend.
2897 // If the value is the empty string, parse it as null.
2898 if (/^ *$/.test(x
)) return null;
2900 // If it was actually "NaN", return it as NaN.
2901 if (/^ *nan *$/i.test(x
)) return NaN
;
2903 // Looks like a parsing error.
2904 var msg
= "Unable to parse '" + x
+ "' as a number";
2905 if (opt_line
!== null && opt_line_no
!== null) {
2906 msg
+= " on line " + (1+opt_line_no
) + " ('" + opt_line
+ "') of CSV.";
2915 * Parses a string in a special csv format. We expect a csv file where each
2916 * line is a date point, and the first field in each line is the date string.
2917 * We also expect that all remaining fields represent series.
2918 * if the errorBars attribute is set, then interpret the fields as:
2919 * date, series1, stddev1, series2, stddev2, ...
2920 * @param {[Object]} data See above.
2922 * @return [Object] An array with one entry for each row. These entries
2923 * are an array of cells in that row. The first entry is the parsed x-value for
2924 * the row. The second, third, etc. are the y-values. These can take on one of
2925 * three forms, depending on the CSV and constructor parameters:
2927 * 2. [ value, stddev ]
2928 * 3. [ low value, center value, high value ]
2930 Dygraph
.prototype.parseCSV_
= function(data
) {
2932 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
2933 var lines
= data
.split(line_delimiter
|| "\n");
2936 // Use the default delimiter or fall back to a tab if that makes sense.
2937 var delim
= this.attr_('delimiter');
2938 if (lines
[0].indexOf(delim
) == -1 && lines
[0].indexOf('\t') >= 0) {
2943 if (!('labels' in this.user_attrs_
)) {
2944 // User hasn't explicitly set labels, so they're (presumably) in the CSV.
2946 this.attrs_
.labels
= lines
[0].split(delim
); // NOTE: _not_ user_attrs_.
2947 this.attributes_
.reparseSeries();
2952 var defaultParserSet
= false; // attempt to auto-detect x value type
2953 var expectedCols
= this.attr_("labels").length
;
2954 var outOfOrder
= false;
2955 for (var i
= start
; i
< lines
.length
; i
++) {
2956 var line
= lines
[i
];
2958 if (line
.length
=== 0) continue; // skip blank lines
2959 if (line
[0] == '#') continue; // skip comment lines
2960 var inFields
= line
.split(delim
);
2961 if (inFields
.length
< 2) continue;
2964 if (!defaultParserSet
) {
2965 this.detectTypeFromString_(inFields
[0]);
2966 xParser
= this.attr_("xValueParser");
2967 defaultParserSet
= true;
2969 fields
[0] = xParser(inFields
[0], this);
2971 // If fractions are expected, parse the numbers as "A/B
"
2972 if (this.fractions_) {
2973 for (j = 1; j < inFields.length; j++) {
2974 // TODO(danvk): figure out an appropriate way to flag parse errors.
2975 vals = inFields[j].split("/");
2976 if (vals.length != 2) {
2977 this.error('Expected fractional "num
/den
" values in CSV data ' +
2978 "but found a value
'" + inFields[j] + "' on line
" +
2979 (1 + i) + " ('" + line + "') which is not of
this form
.");
2982 fields[j] = [this.parseFloat_(vals[0], i, line),
2983 this.parseFloat_(vals[1], i, line)];
2986 } else if (this.attr_("errorBars
")) {
2987 // If there are error bars, values are (value, stddev) pairs
2988 if (inFields.length % 2 != 1) {
2989 this.error('Expected alternating (value, stdev.) pairs in CSV data ' +
2990 'but line ' + (1 + i) + ' has an odd number of values (' +
2991 (inFields.length - 1) + "): '" + line + "'");
2993 for (j = 1; j < inFields.length; j += 2) {
2994 fields[(j + 1) / 2] = [this.parseFloat_(inFields[j], i, line),
2995 this.parseFloat_(inFields[j + 1], i, line)];
2997 } else if (this.attr_("customBars
")) {
2998 // Bars are a low;center;high tuple
2999 for (j = 1; j < inFields.length; j++) {
3000 var val = inFields[j];
3001 if (/^ *$/.test(val)) {
3002 fields[j] = [null, null, null];
3004 vals = val.split(";");
3005 if (vals.length == 3) {
3006 fields[j] = [ this.parseFloat_(vals[0], i, line),
3007 this.parseFloat_(vals[1], i, line),
3008 this.parseFloat_(vals[2], i, line) ];
3010 this.warn('When using customBars, values must be either blank ' +
3011 'or "low
;center
;high
" tuples (got "' + val +
3012 '" on line ' + (1+i));
3017 // Values are just numbers
3018 for (j = 1; j < inFields.length; j++) {
3019 fields[j] = this.parseFloat_(inFields[j], i, line);
3022 if (ret.length > 0 && fields[0] < ret[ret.length - 1][0]) {
3026 if (fields.length != expectedCols) {
3027 this.error("Number of columns
in line
" + i + " (" + fields.length +
3028 ") does not agree
with number of
labels (" + expectedCols +
3032 // If the user specified the 'labels' option and none of the cells of the
3033 // first row parsed correctly, then they probably double-specified the
3034 // labels. We go with the values set in the option, discard this row and
3035 // log a warning to the JS console.
3036 if (i === 0 && this.attr_('labels')) {
3037 var all_null = true;
3038 for (j = 0; all_null && j < fields.length; j++) {
3039 if (fields[j]) all_null = false;
3042 this.warn("The dygraphs
'labels' option is set
, but the first row of
" +
3043 "CSV
data ('" + line + "') appears to also contain labels
. " +
3044 "Will drop the CSV labels and
use the option labels
.");
3052 this.warn("CSV is out of order
; order it correctly to speed loading
.");
3053 ret.sort(function(a,b) { return a[0] - b[0]; });
3061 * The user has provided their data as a pre-packaged JS array. If the x values
3062 * are numeric, this is the same as dygraphs' internal format. If the x values
3063 * are dates, we need to convert them from Date objects to ms since epoch.
3064 * @param {[Object]} data
3065 * @return {[Object]} data with numeric x values.
3067 Dygraph.prototype.parseArray_ = function(data) {
3068 // Peek at the first x value to see if it's numeric.
3069 if (data.length === 0) {
3070 this.error("Can
't plot empty data set");
3073 if (data[0].length === 0) {
3074 this.error("Data set cannot contain an empty row");
3079 if (this.attr_("labels") === null) {
3080 this.warn("Using default labels. Set labels explicitly via 'labels
' " +
3081 "in the options parameter");
3082 this.attrs_.labels = [ "X" ];
3083 for (i = 1; i < data[0].length; i++) {
3084 this.attrs_.labels.push("Y" + i); // Not user_attrs_.
3086 this.attributes_.reparseSeries();
3088 var num_labels = this.attr_("labels");
3089 if (num_labels.length != data[0].length) {
3090 this.error("Mismatch between number of labels (" + num_labels +
3091 ") and number of columns in array (" + data[0].length + ")");
3096 if (Dygraph.isDateLike(data[0][0])) {
3097 // Some intelligent defaults for a date x-axis.
3098 this.attrs_.axes.x.valueFormatter = Dygraph.dateString_;
3099 this.attrs_.axes.x.ticker = Dygraph.dateTicker;
3100 this.attrs_.axes.x.axisLabelFormatter = Dygraph.dateAxisFormatter;
3102 // Assume they're all dates
.
3103 var parsedData
= Dygraph
.clone(data
);
3104 for (i
= 0; i
< data
.length
; i
++) {
3105 if (parsedData
[i
].length
=== 0) {
3106 this.error("Row " + (1 + i
) + " of data is empty");
3109 if (parsedData
[i
][0] === null ||
3110 typeof(parsedData
[i
][0].getTime
) != 'function' ||
3111 isNaN(parsedData
[i
][0].getTime())) {
3112 this.error("x value in row " + (1 + i
) + " is not a Date");
3115 parsedData
[i
][0] = parsedData
[i
][0].getTime();
3119 // Some intelligent defaults for a numeric x-axis.
3120 /** @private (shut up, jsdoc!) */
3121 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3122 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3123 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.numberAxisLabelFormatter
;
3129 * Parses a DataTable object from gviz.
3130 * The data is expected to have a first column that is either a date or a
3131 * number. All subsequent columns must be numbers. If there is a clear mismatch
3132 * between this.xValueParser_ and the type of the first column, it will be
3133 * fixed. Fills out rawData_.
3134 * @param {[Object]} data See above.
3137 Dygraph
.prototype.parseDataTable_
= function(data
) {
3138 var shortTextForAnnotationNum
= function(num
) {
3139 // converts [0-9]+ [A-Z][a-z]*
3140 // example: 0=A, 1=B, 25=Z, 26=Aa, 27=Ab
3141 // and continues like.. Ba Bb .. Za .. Zz..Aaa...Zzz Aaaa Zzzz
3142 var shortText
= String
.fromCharCode(65 /* A */ + num
% 26);
3143 num
= Math
.floor(num
/ 26);
3145 shortText
= String
.fromCharCode(65 /* A */ + (num
- 1) % 26 ) + shortText
.toLowerCase();
3146 num
= Math
.floor((num
- 1) / 26);
3151 var cols
= data
.getNumberOfColumns();
3152 var rows
= data
.getNumberOfRows();
3154 var indepType
= data
.getColumnType(0);
3155 if (indepType
== 'date' || indepType
== 'datetime') {
3156 this.attrs_
.xValueParser
= Dygraph
.dateParser
;
3157 this.attrs_
.axes
.x
.valueFormatter
= Dygraph
.dateString_
;
3158 this.attrs_
.axes
.x
.ticker
= Dygraph
.dateTicker
;
3159 this.attrs_
.axes
.x
.axisLabelFormatter
= Dygraph
.dateAxisFormatter
;
3160 } else if (indepType
== 'number') {
3161 this.attrs_
.xValueParser
= function(x
) { return parseFloat(x
); };
3162 this.attrs_
.axes
.x
.valueFormatter
= function(x
) { return x
; };
3163 this.attrs_
.axes
.x
.ticker
= Dygraph
.numericLinearTicks
;
3164 this.attrs_
.axes
.x
.axisLabelFormatter
= this.attrs_
.axes
.x
.valueFormatter
;
3166 this.error("only 'date', 'datetime' and 'number' types are supported for " +
3167 "column 1 of DataTable input (Got '" + indepType
+ "')");
3171 // Array of the column indices which contain data (and not annotations).
3173 var annotationCols
= {}; // data index -> [annotation cols]
3174 var hasAnnotations
= false;
3176 for (i
= 1; i
< cols
; i
++) {
3177 var type
= data
.getColumnType(i
);
3178 if (type
== 'number') {
3180 } else if (type
== 'string' && this.attr_('displayAnnotations')) {
3181 // This is OK -- it's an annotation column.
3182 var dataIdx
= colIdx
[colIdx
.length
- 1];
3183 if (!annotationCols
.hasOwnProperty(dataIdx
)) {
3184 annotationCols
[dataIdx
] = [i
];
3186 annotationCols
[dataIdx
].push(i
);
3188 hasAnnotations
= true;
3190 this.error("Only 'number' is supported as a dependent type with Gviz." +
3191 " 'string' is only supported if displayAnnotations is true");
3195 // Read column labels
3196 // TODO(danvk): add support back for errorBars
3197 var labels
= [data
.getColumnLabel(0)];
3198 for (i
= 0; i
< colIdx
.length
; i
++) {
3199 labels
.push(data
.getColumnLabel(colIdx
[i
]));
3200 if (this.attr_("errorBars")) i
+= 1;
3202 this.attrs_
.labels
= labels
;
3203 cols
= labels
.length
;
3206 var outOfOrder
= false;
3207 var annotations
= [];
3208 for (i
= 0; i
< rows
; i
++) {
3210 if (typeof(data
.getValue(i
, 0)) === 'undefined' ||
3211 data
.getValue(i
, 0) === null) {
3212 this.warn("Ignoring row " + i
+
3213 " of DataTable because of undefined or null first column.");
3217 if (indepType
== 'date' || indepType
== 'datetime') {
3218 row
.push(data
.getValue(i
, 0).getTime());
3220 row
.push(data
.getValue(i
, 0));
3222 if (!this.attr_("errorBars")) {
3223 for (j
= 0; j
< colIdx
.length
; j
++) {
3224 var col
= colIdx
[j
];
3225 row
.push(data
.getValue(i
, col
));
3226 if (hasAnnotations
&&
3227 annotationCols
.hasOwnProperty(col
) &&
3228 data
.getValue(i
, annotationCols
[col
][0]) !== null) {
3230 ann
.series
= data
.getColumnLabel(col
);
3232 ann
.shortText
= shortTextForAnnotationNum(annotations
.length
);
3234 for (var k
= 0; k
< annotationCols
[col
].length
; k
++) {
3235 if (k
) ann
.text
+= "\n";
3236 ann
.text
+= data
.getValue(i
, annotationCols
[col
][k
]);
3238 annotations
.push(ann
);
3242 // Strip out infinities, which give dygraphs problems later on.
3243 for (j
= 0; j
< row
.length
; j
++) {
3244 if (!isFinite(row
[j
])) row
[j
] = null;
3247 for (j
= 0; j
< cols
- 1; j
++) {
3248 row
.push([ data
.getValue(i
, 1 + 2 * j
), data
.getValue(i
, 2 + 2 * j
) ]);
3251 if (ret
.length
> 0 && row
[0] < ret
[ret
.length
- 1][0]) {
3258 this.warn("DataTable is out of order; order it correctly to speed loading.");
3259 ret
.sort(function(a
,b
) { return a
[0] - b
[0]; });
3261 this.rawData_
= ret
;
3263 if (annotations
.length
> 0) {
3264 this.setAnnotations(annotations
, true);
3266 this.attributes_
.reparseSeries();
3270 * Get the CSV data. If it's in a function, call that function. If it's in a
3271 * file, do an XMLHttpRequest to get it.
3274 Dygraph
.prototype.start_
= function() {
3275 var data
= this.file_
;
3277 // Functions can return references of all other types.
3278 if (typeof data
== 'function') {
3282 if (Dygraph
.isArrayLike(data
)) {
3283 this.rawData_
= this.parseArray_(data
);
3285 } else if (typeof data
== 'object' &&
3286 typeof data
.getColumnRange
== 'function') {
3287 // must be a DataTable from gviz.
3288 this.parseDataTable_(data
);
3290 } else if (typeof data
== 'string') {
3291 // Heuristic: a newline means it's CSV data. Otherwise it's an URL.
3292 var line_delimiter
= Dygraph
.detectLineDelimiter(data
);
3293 if (line_delimiter
) {
3294 this.loadedEvent_(data
);
3298 if (window
.XMLHttpRequest
) {
3299 // Firefox, Opera, IE7, and other browsers will use the native object
3300 req
= new XMLHttpRequest();
3302 // IE 5 and 6 will use the ActiveX control
3303 req
= new ActiveXObject("Microsoft.XMLHTTP");
3307 req
.onreadystatechange
= function () {
3308 if (req
.readyState
== 4) {
3309 if (req
.status
=== 200 || // Normal http
3310 req
.status
=== 0) { // Chrome w/ --allow
-file
-access
-from
-files
3311 caller
.loadedEvent_(req
.responseText
);
3316 req
.open("GET", data
, true);
3320 this.error("Unknown data format: " + (typeof data
));
3325 * Changes various properties of the graph. These can include:
3327 * <li>file: changes the source data for the graph</li>
3328 * <li>errorBars: changes whether the data contains stddev</li>
3331 * There's a huge variety of options that can be passed to this method. For a
3332 * full list, see http://dygraphs.com/options.html.
3334 * @param {Object} attrs The new properties and values
3335 * @param {Boolean} [block_redraw] Usually the chart is redrawn after every
3336 * call to updateOptions(). If you know better, you can pass true to explicitly
3337 * block the redraw. This can be useful for chaining updateOptions() calls,
3338 * avoiding the occasional infinite loop and preventing redraws when it's not
3339 * necessary (e.g. when updating a callback).
3341 Dygraph
.prototype.updateOptions
= function(input_attrs
, block_redraw
) {
3342 if (typeof(block_redraw
) == 'undefined') block_redraw
= false;
3344 // mapLegacyOptions_ drops the "file" parameter as a convenience to us.
3345 var file
= input_attrs
.file
;
3346 var attrs
= Dygraph
.mapLegacyOptions_(input_attrs
);
3348 // TODO(danvk): this is a mess. Move these options into attr_.
3349 if ('rollPeriod' in attrs
) {
3350 this.rollPeriod_
= attrs
.rollPeriod
;
3352 if ('dateWindow' in attrs
) {
3353 this.dateWindow_
= attrs
.dateWindow
;
3354 if (!('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3355 this.zoomed_x_
= (attrs
.dateWindow
!== null);
3358 if ('valueRange' in attrs
&& !('isZoomedIgnoreProgrammaticZoom' in attrs
)) {
3359 this.zoomed_y_
= (attrs
.valueRange
!== null);
3362 // TODO(danvk): validate per-series options.
3367 // highlightCircleSize
3369 // Check if this set options will require new points.
3370 var requiresNewPoints
= Dygraph
.isPixelChangingOptionList(this.attr_("labels"), attrs
);
3372 Dygraph
.updateDeep(this.user_attrs_
, attrs
);
3374 this.attributes_
.reparseSeries();
3378 if (!block_redraw
) this.start_();
3380 if (!block_redraw
) {
3381 if (requiresNewPoints
) {
3384 this.renderGraph_(false);
3391 * Returns a copy of the options with deprecated names converted into current
3392 * names. Also drops the (potentially-large) 'file' attribute. If the caller is
3393 * interested in that, they should save a copy before calling this.
3396 Dygraph
.mapLegacyOptions_
= function(attrs
) {
3398 for (var k
in attrs
) {
3399 if (k
== 'file') continue;
3400 if (attrs
.hasOwnProperty(k
)) my_attrs
[k
] = attrs
[k
];
3403 var set
= function(axis
, opt
, value
) {
3404 if (!my_attrs
.axes
) my_attrs
.axes
= {};
3405 if (!my_attrs
.axes
[axis
]) my_attrs
.axes
[axis
] = {};
3406 my_attrs
.axes
[axis
][opt
] = value
;
3408 var map
= function(opt
, axis
, new_opt
) {
3409 if (typeof(attrs
[opt
]) != 'undefined') {
3410 Dygraph
.warn("Option " + opt
+ " is deprecated. Use the " +
3411 new_opt
+ " option for the " + axis
+ " axis instead. " +
3412 "(e.g. { axes : { " + axis
+ " : { " + new_opt
+ " : ... } } } " +
3413 "(see http://dygraphs.com/per-axis.html for more information.");
3414 set(axis
, new_opt
, attrs
[opt
]);
3415 delete my_attrs
[opt
];
3419 // This maps, e.g., xValueFormater -> axes: { x: { valueFormatter: ... } }
3420 map('xValueFormatter', 'x', 'valueFormatter');
3421 map('pixelsPerXLabel', 'x', 'pixelsPerLabel');
3422 map('xAxisLabelFormatter', 'x', 'axisLabelFormatter');
3423 map('xTicker', 'x', 'ticker');
3424 map('yValueFormatter', 'y', 'valueFormatter');
3425 map('pixelsPerYLabel', 'y', 'pixelsPerLabel');
3426 map('yAxisLabelFormatter', 'y', 'axisLabelFormatter');
3427 map('yTicker', 'y', 'ticker');
3432 * Resizes the dygraph. If no parameters are specified, resizes to fill the
3433 * containing div (which has presumably changed size since the dygraph was
3434 * instantiated. If the width/height are specified, the div will be resized.
3436 * This is far more efficient than destroying and re-instantiating a
3437 * Dygraph, since it doesn't have to reparse the underlying data.
3439 * @param {Number} [width] Width (in pixels)
3440 * @param {Number} [height] Height (in pixels)
3442 Dygraph
.prototype.resize
= function(width
, height
) {
3443 if (this.resize_lock
) {
3446 this.resize_lock
= true;
3448 if ((width
=== null) != (height
=== null)) {
3449 this.warn("Dygraph.resize() should be called with zero parameters or " +
3450 "two non-NULL parameters. Pretending it was zero.");
3451 width
= height
= null;
3454 var old_width
= this.width_
;
3455 var old_height
= this.height_
;
3458 this.maindiv_
.style
.width
= width
+ "px";
3459 this.maindiv_
.style
.height
= height
+ "px";
3460 this.width_
= width
;
3461 this.height_
= height
;
3463 this.width_
= this.maindiv_
.clientWidth
;
3464 this.height_
= this.maindiv_
.clientHeight
;
3467 if (old_width
!= this.width_
|| old_height
!= this.height_
) {
3468 // Resizing a canvas erases it, even when the size doesn't change, so
3469 // any resize needs to be followed by a redraw.
3470 this.resizeElements_();
3474 this.resize_lock
= false;
3478 * Adjusts the number of points in the rolling average. Updates the graph to
3479 * reflect the new averaging period.
3480 * @param {Number} length Number of points over which to average the data.
3482 Dygraph
.prototype.adjustRoll
= function(length
) {
3483 this.rollPeriod_
= length
;
3488 * Returns a boolean array of visibility statuses.
3490 Dygraph
.prototype.visibility
= function() {
3491 // Do lazy-initialization, so that this happens after we know the number of
3493 if (!this.attr_("visibility")) {
3494 this.attrs_
.visibility
= [];
3496 // TODO(danvk): it looks like this could go into an infinite loop w/ user_attrs
.
3497 while (this.attr_("visibility").length
< this.numColumns() - 1) {
3498 this.attrs_
.visibility
.push(true);
3500 return this.attr_("visibility");
3504 * Changes the visiblity of a series.
3506 Dygraph
.prototype.setVisibility
= function(num
, value
) {
3507 var x
= this.visibility();
3508 if (num
< 0 || num
>= x
.length
) {
3509 this.warn("invalid series number in setVisibility: " + num
);
3517 * How large of an area will the dygraph render itself in?
3518 * This is used for testing.
3519 * @return A {width: w, height: h} object.
3522 Dygraph
.prototype.size
= function() {
3523 return { width
: this.width_
, height
: this.height_
};
3527 * Update the list of annotations and redraw the chart.
3528 * See dygraphs.com/annotations.html for more info on how to use annotations.
3529 * @param ann {Array} An array of annotation objects.
3530 * @param suppressDraw {Boolean} Set to "true" to block chart redraw (optional).
3532 Dygraph
.prototype.setAnnotations
= function(ann
, suppressDraw
) {
3533 // Only add the annotation CSS rule once we know it will be used.
3534 Dygraph
.addAnnotationRule();
3535 this.annotations_
= ann
;
3536 if (!this.layout_
) {
3537 this.warn("Tried to setAnnotations before dygraph was ready. " +
3538 "Try setting them in a ready() block. See " +
3539 "dygraphs.com/tests/annotation.html");
3543 this.layout_
.setAnnotations(this.annotations_
);
3544 if (!suppressDraw
) {
3550 * Return the list of annotations.
3552 Dygraph
.prototype.annotations
= function() {
3553 return this.annotations_
;
3557 * Get the list of label names for this graph. The first column is the
3558 * x-axis, so the data series names start at index 1.
3560 * Returns null when labels have not yet been defined.
3562 Dygraph
.prototype.getLabels
= function() {
3563 var labels
= this.attr_("labels");
3564 return labels
? labels
.slice() : null;
3568 * Get the index of a series (column) given its name. The first column is the
3569 * x-axis, so the data series start with index 1.
3571 Dygraph
.prototype.indexFromSetName
= function(name
) {
3572 return this.setIndexByName_
[name
];
3576 * Trigger a callback when the dygraph has drawn itself and is ready to be
3577 * manipulated. This is primarily useful when dygraphs has to do an XHR for the
3578 * data (i.e. a URL is passed as the data source) and the chart is drawn
3579 * asynchronously. If the chart has already drawn, the callback will fire
3582 * This is a good place to call setAnnotation().
3584 * @param {function(!Dygraph)} callback The callback to trigger when the chart
3587 Dygraph
.prototype.ready
= function(callback
) {
3588 if (this.is_initial_draw_
) {
3589 this.readyFns_
.push(callback
);
3597 * Adds a default style for the annotation CSS classes to the document. This is
3598 * only executed when annotations are actually used. It is designed to only be
3599 * called once -- all calls after the first will return immediately.
3601 Dygraph
.addAnnotationRule
= function() {
3602 // TODO(danvk): move this function into plugins/annotations.js
?
3603 if (Dygraph
.addedAnnotationCSS
) return;
3605 var rule
= "border: 1px solid black; " +
3606 "background-color: white; " +
3607 "text-align: center;";
3609 var styleSheetElement
= document
.createElement("style");
3610 styleSheetElement
.type
= "text/css";
3611 document
.getElementsByTagName("head")[0].appendChild(styleSheetElement
);
3613 // Find the first style sheet that we can access.
3614 // We may not add a rule to a style sheet from another domain for security
3615 // reasons. This sometimes comes up when using gviz, since the Google gviz JS
3616 // adds its own style sheets from google.com.
3617 for (var i
= 0; i
< document
.styleSheets
.length
; i
++) {
3618 if (document
.styleSheets
[i
].disabled
) continue;
3619 var mysheet
= document
.styleSheets
[i
];
3621 if (mysheet
.insertRule
) { // Firefox
3622 var idx
= mysheet
.cssRules
? mysheet
.cssRules
.length
: 0;
3623 mysheet
.insertRule(".dygraphDefaultAnnotation { " + rule
+ " }", idx
);
3624 } else if (mysheet
.addRule
) { // IE
3625 mysheet
.addRule(".dygraphDefaultAnnotation", rule
);
3627 Dygraph
.addedAnnotationCSS
= true;
3630 // Was likely a security exception.
3634 this.warn("Unable to add default annotation CSS rule; display may be off.");