The dygraphs JavaScript library produces produces interactive, zoomable charts of time series based on CSV files.
+The dygraphs JavaScript library produces produces interactive, zoomable charts of time series.
For more demos, browse the dygraph tests directory.
+The DateGraph library depends on two other JS libraries: MochiKit and PlotKit. Rather than tracking down copies of these libraries, I recommend using a packed version of dygraphs that combines all three libraries into a single JS file. Either grab this file from dygraph project's downloads page or create it yourself by checking out a copy of the code and running: +
The dygraphs library depends on two other JS libraries: MochiKit and PlotKit. Rather than tracking down copies of these libraries, I recommend using a packed version of dygraphs that combines all three libraries into a single JS file. Either grab this file from dygraph project's downloads page or create it yourself by checking out a copy of the code and running:
./generate-combined.sh@@ -103,39 +107,33 @@ <script type="text/javascript" src="combined.js"></script> </head> <body> -<div id="graphdiv" style="width:400px; height:300px;"></div> +<div id="graphdiv"></div> <script type="text/javascript"> - g = new DateGraph( + g = new Dygraph( document.getElementById("graphdiv"), // containing div - function() { // function or path to CSV file. - return "20080507,75\n" + - "20080508,70\n" + - "20080509,80\n"; - }, - [ "Temperature" ], // names of data series - {} // additional options (see below) + "Date,Temperature\n" + // CSV or path to a CSV file. + "20080507,75\n" + + "20080508,70\n" + + "20080509,80\n", ); </script> </body> </html>
In order to keep this example self-contained, the second parameter is a function that returns CSV data. These lines must begin with a date in the form YYYYMMDD. In most applications, it makes more sense to include a CSV file instead. If the second parameter to the constructor is a string, it will be interpreted as the path to a CSV file. The DateGraph will perform an XMLHttpRequest to retrieve this file and display the data when it becomes available. Make sure your CSV file is readable and serving from a place that understands XMLHttpRequest's! In particular, you cannot specify a CSV file using "file:///". Here's an example: (data from Weather Underground)
In order to keep this example self-contained, the second parameter is a function that returns CSV data. These lines must begin with a date in the form YYYYMMDD. In most applications, it makes more sense to include a CSV file instead. If the second parameter to the constructor is a string, it will be interpreted as the path to a CSV file. The Dygraph will perform an XMLHttpRequest to retrieve this file and display the data when it becomes available. Make sure your CSV file is readable and serving from a place that understands XMLHttpRequest's! In particular, you cannot specify a CSV file using "file:///". Here's an example: (data from Weather Underground)
| HTML | @@ -150,11 +148,10 @@ <body> <div id="graphdiv" style="width:600px; height:300px;"></div> <script type="text/javascript"> - g = new DateGraph( + g = new Dygraph( document.getElementById("graphdiv"), "temperatures.csv", // path to CSV file - null, // labels in top line of CSV file - {} + {} // additional options ); </script> </body> @@ -163,9 +160,9 @@
|---|
Click here to view the temperatures.csv file. There are a few things to note here:
null, the labels were taken from the first line of the data instead. The first line of temperatures.csv is Date,High,Low.temperatures.csv, which is Date,High,Low.These last two problems can be fixed by specifying the appropriate options in the fourth parameter to the DateGraph constructor. To set the number of days for a moving average, use the rollPeriod option. To set the range of the y-axis, use the valueRange option. Here's how it's done:
+This problem can be fixed by specifying the appropriate options in the "additional options" parameter to the Dygraph constructor. To set the number of days for a moving average, use the rollPeriod option. Here's how it's done:
| HTML | @@ -195,11 +193,11 @@ <body> <div id="graphdiv" style="width:600px; height:300px;"></div> <script type="text/javascript"> - g = new DateGraph( + g = new Dygraph( document.getElementById("graphdiv"), - "temperatures.csv", null, + "temperatures.csv", { rollPeriod: 7, - valueRange: [25, 100] + showRoller: true, } ); </script> @@ -209,20 +207,20 @@
|---|
A rolling average can always be set using the text box in the lower left-hand corner of the graph.
+A rolling average can be set using the text box in the lower left-hand corner of the graph (the showRoller attribute is what makes this appear).
Another significant feature of the dygraphs library is the ability to display error bars around data series. One standard deviation must be specified for each data point. A +/-n sigma band will be drawn around the data series at that point. If a moving average is being displayed, DateGraph will compute the standard deviation of the average at each point. (i.e. σ = sqrt((σ_1^2 + σ_2^2 + ... + σ_n^2)/n))
+Another significant feature of the dygraphs library is the ability to display error bars around data series. One standard deviation must be specified for each data point. A +/-n sigma band will be drawn around the data series at that point. If a moving average is being displayed, dygraphs will compute the standard deviation of the average at each point. (i.e. σ = sqrt((σ_1^2 + σ_2^2 + ... + σ_n^2)/n))
Here's a demonstration. There are two data series. One is N(100,10) with a standard deviation of 10 specified at each point. The other is N(80,20) with a standard deviation of 20 specified at each point. The CSV file was generated using Octave and can be viewed here.
These are the options that can be passed in through the fourth parameter of the DateGraph constructor.
+These are the options that can be passed in through the optional third parameter of the Dygraph constructor. To see demonstrations of many of these options, browse the dygraphs tests directory.
| Name | Sample Value | Description | |||
|---|---|---|---|---|---|
| includeZero | +true, false |
+ Usually, dygraphs will use the range of the data plus some padding to + set the range of the y-axis. If this option is set, the y-axis will always + include zero, typically as the lowest value. This can be used to avoid + exaggerating the variance in the data. | +|||
| rollPeriod | 7 |
Number of days over which to average data. Discussed extensively above. | -|||
| showRoller | +true |
+ Should the rolling average period text box be shown? Default is false. | +|||
| colors | ['red', '#00FF00'] |
List of colors for the data series. These can be of the form "#AABBCC" or "rgb(255,100,200)" or "yellow", etc. If not specified, equally-spaced points around a color wheel are used. | -|||
| colorSaturation | 1.0 |
If colors is not specified, saturation of the automatically-generated data series colors. (0.0-1.0, default: 1.0) | -|||
| colorValue | 0.5 |
If colors is not specified, value of the data series colors, as in hue/saturation/value. (0.0-1.0, default 0.5) | -|||
| clickCallback | function(e,date){ alert(date); } |
A function to call when a data point is clicked. The function should take two arguments, the event object for the click and the date that was clicked. (default null) | -|||
| errorBars | -false |
- Does the data contain standard deviations? Setting this to true alters - the input format (see above). (default false) | -|||
| zoomCallback | +function(minDate,maxDate) {} |
+ A function to call when the zoom window is changed (either by zooming + in or out). minDate and maxDate are millis since epoch. | +|||
| strokeWidth | 2.0 |
Width of the data lines. This can be used to increase the contrast or some graphs. (default 1.0) | -|||
| dateWindow | -[(new Date('2006-01-01')).valueOf(), | ||||
| valueRange | [10, 110] |
Explicitly set the vertical range of the graph to [low, high]. By default, some clever heuristics are used (see above). | -|||
| minTickSize | -1
- | ||||
| labelsSeparateLines | true |
Put <br/> between lines in the label string. Often used in conjunction with labelsDiv. (default false) | -|||
| labelsDiv | document.getElementById('foo') |
Show data labels in an external div, rather than on the graph. (default null) | -|||
| labelsKMB | true |
Show K/M/B for thousands/millions/billions on y-axis (default false). | |||
| labelsDivWidth | +250 | +Width (in pixels) of the div which shows information on the + currently-highlighted points. | +|||
| labelsDivStyles | +{} | +Additional styles to apply to the currently-highlighted points div. For + example, { 'font-weigth': 'bold' } will make the labels bold. | +|||
| highlightCircleSize | +3 |
+ Size (in pixels) of the dot drawn over highlighted points (default 3). | +|||
| pixelsPerXLabel, pixelsPerYLabel | +50 | +Number of pixels to require between each x- and y-label. Larger values + will yield a sparser axis with fewer ticks. Defaults: 60 (x-axis), 30 + (y-axis). | +|||
| xAxisLabelWidth, yAxisLabelWidth | +50 | +Width (in pixels) of the x- and y-axis labels. | +|||
| axisLabelFontSize | +14 | +Size of the font (in pixels) to use in the axis labels, both x- and + y-axis. | +|||
| padding | -{left: 40, right: 30, |
- Adds extra pixels of padding around the graph. Sometimes a dygraph - gets clipped by surrounding text (see the Demo at the top of this page). - Setting this property appropriately will fix this problem. | +rightGap | +5 | +Number of pixels to leave blank at the right edge of the Dygraph. This + makes it easier to highlight the right-most data point. | +
| errorBars | +false |
+ Does the data contain standard deviations? Setting this to true alters + the input format (see above). (default false) | +|||
| sigma | +2 | +When errorBars is set, shade this many standard deviations above/below + each point. | +|||
| fractions | +false | +When set, attempt to parse each cell in the CSV file as "a/b", where a + and b are integers. The ratio will be plotted. This allows computation of + Wilson confidence intervals (see below). | +|||
| wilsonInterval | +true | +Use in conjunction with the "fractions" option. Instead of plotting +/- + N standard deviations, dygraphs will compute a Wilson confidence interval + and plot that. This has more reasonable behavior for ratios close to 0 or + 1. | +|||
| customBars | +false | +When set, parse each CSV cell as "low;middle;high". Error bars will be + drawn for each point between low and high, with the series itself going + through middle. |
Any options you specify also get passed on to PlotKit's Renderer class. DateGraph will override some of these (e.g. strokeColor), but others may be useful. The padding property is an example of this.
Any options you specify also get passed on to PlotKit's Renderer class. dygraphs will override some of these (e.g. strokeColor), but others may be useful. The padding property is an example of this.
Here are a few problems that I've frequently run into while using the @@ -379,28 +523,33 @@ dygraphs library.
href="http://www.getfirebug.com/">Firebug.YYYYMMDD,series1,series2,.... If you're specifying the
- names of each data series in the CSV file itself, make sure that you pass
- null as the third parameter to the DateGraph constructor to let
- the library know that. And if you set the errorBars property,
- make sure you alternate data series and standard deviations.YYYYMMDD,series1,series2,.... And if you set the
+ errorBars property, make sure you alternate data series and
+ standard deviations.
<center>
tag. This applies to the CSS text-align property as well. If you
- want to center a DateGraph, put it inside a table with "align=center"
+ want to center a Dygraph, put it inside a table with "align=center"
set.colors property or name the data series
- using the third parameter of the DateGraph constructor, make sure the number
- of data series agree in all places: colors, third parameter and
- in each line of the CSV file itself.dateWindow property to a date. It expects
milliseconds since epoch, which can be obtained from a JavaScript Date
object's valueOf method.dygraphs is purely client-side JavaScript. It does not send your data to any +servers -- the data is processed entirely in the client's browser.
+Created May 9, 2008 by Dan Vanderkam
+ + + +