X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;ds=sidebyside;f=docs%2Findex.html;h=59ac6ad587eacc0a1dbaa0f0c317a1427ff7db71;hb=d91ba598b82c927945744c7041dc05500b5545b3;hp=d79b698f3784d651a1f45bcd20fe3a22006039c7;hpb=68f9bed30349ea126921490f2631dc30a404d092;p=dygraphs.git diff --git a/docs/index.html b/docs/index.html index d79b698..59ac6ad 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,101 +1,73 @@ +
+ + +http://github.com/danvk/dygraphs
-See downloads, gallery and open issues
+dygraphs is an open source JavaScript library that produces produces interactive, zoomable charts of time series. It is designed to display dense data sets and enable users to explore and interpret them.
+http://github.com/danvk/dygraphs
+See blog, mailing list, downloads, demos and open issues
-dygraphs is an open source JavaScript library that produces produces interactive, zoomable charts of time series. It is designed to display dense data sets and enable users to explore and interpret them.
-(Mouse over to highlight individual values. Click and drag to zoom. Double-click to zoom back out. Change the number and hit enter to adjust the averaging period.)
+(Mouse over to highlight individual values. Click and drag to zoom. Double-click to zoom back out. Change the number and hit enter to adjust the averaging period.)
- - + -dygraphs allows the user to explore the data and discover these facts.
+dygraphs allows the user to explore the data and discover these facts.
-For more demos, browse the dygraph tests directory.
+For more demos, browse the dygraph tests + directory. To see other people who are using dygraphs, check out the known users.
-Some of the features of dygraphs:
-Some of the features of dygraphs:
+To use dygraphs, include the dygraph-combined.js
JavaScript file and instantiate a Dygraph
object.
To use dygraphs, include the dygraph-combined.js
JavaScript file and instantiate a Dygraph
object.
Here's a basic example to get things started:
+Here's a basic example to get things started:
-
-
+ HTML
+
+
<html>
<head>
<script type="text/javascript"
- src="dygraph-combined.js"></script>
+ src="dygraph-combined.js"></script>
</head>
<body>
<div id="graphdiv"></div>
<script type="text/javascript">
- g = new Dygraph(
- // containing div
- document.getElementById("graphdiv"),
-
- // CSV or path to a CSV file.
- "Date,Temperature\n" +
- "2008-05-07,75\n" +
- "2008-05-08,70\n" +
- "2008-05-09,80\n"
- );
+ g = new Dygraph(
+
+ // containing div
+ document.getElementById("graphdiv"),
+
+ // CSV or path to a CSV file.
+ "Date,Temperature\n" +
+ "2008-05-07,75\n" +
+ "2008-05-08,70\n" +
+ "2008-05-09,80\n"
+
+ );
</script>
</body>
</html>
-
-
+
+
In order to keep this example self-contained, the second parameter is raw CSV data. The dygraphs library parses this data (including column headers), resizes the its container to a reasonable default, calculates appropriate axis ranges and tick marks and draws the graph.
+In order to keep this example self-contained, the second parameter is raw CSV data. The dygraphs library parses this data (including column headers), resizes its container to a reasonable default, calculates appropriate axis ranges and tick marks and draws the graph.
-In most applications, it makes more sense to include a CSV file instead. If the second parameter to the constructor doesn't contain a newline, 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)
In most applications, it makes more sense to include a CSV file instead. If the second parameter to the constructor doesn't contain a newline, 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
+
<html>
<head>
<script type="text/javascript"
- src="dygraph-combined.js"></script>
+ src="dygraph-combined.js"></script>
</head>
<body>
<div id="graphdiv2"
style="width:500px; height:300px;"></div>
<script type="text/javascript">
- g2 = new Dygraph(
- document.getElementById("graphdiv2"),
- "temperatures.csv", // path to CSV file
- {} // options
- );
+ g2 = new Dygraph(
+ document.getElementById("graphdiv2"),
+ "temperatures.csv", // path to CSV file
+ {} // options
+ );
</script>
</body>
</html>
-
+
The file used is temperatures.csv
.
The file used is temperatures.csv
.
There are a few things to note here:
+There are a few things to note here:
-temperatures.csv
, which is Date,High,Low
.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:
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
+
<html>
<head>
<script type="text/javascript"
- src="dygraph-combined.js"></script>
+ src="dygraph-combined.js"></script>
</head>
<body>
<div id="graphdiv3"
- style="width:500px; height:300px;"></div>
+ style="width:500px; height:300px;"></div>
<script type="text/javascript">
- g3 = new Dygraph(
- document.getElementById("graphdiv3"),
- "temperatures.csv",
- {
- rollPeriod: 7,
- showRoller: true,
- }
- );
+ g3 = new Dygraph(
+ document.getElementById("graphdiv3"),
+ "temperatures.csv",
+ {
+ rollPeriod: 7,
+ showRoller: true
+ }
+ );
</script>
</body>
</html>
-
+
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). Also note that we've explicitly set the size of the chart div.
+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). Also note that we've explicitly set the size of the chart div.
-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( (σ12 + σ22 + ... + σn2) / 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 at twonormals.csv.
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( (σ12 + σ22 + ... + σn2) / 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 at twonormals.csv.
+ HTML
+
<html>
<head>
<script type="text/javascript"
- src="combined.js"></script>
+ src="combined.js"></script>
</head>
<body>
<div id="graphdiv4"
- style="width:600px; height:300px;"></div>
+ style="width:480px; height:320px;"></div>
<script type="text/javascript">
- g4 = new Dygraph(
- document.getElementById("graphdiv4"),
- "twonormals.csv",
- {
- rollPeriod: 7,
- showRoller: true,
- errorBars: true,
- valueRange: [50,125]
- }
- );
+ g4 = new Dygraph(
+ document.getElementById("graphdiv4"),
+ "twonormals.csv",
+ {
+ rollPeriod: 7,
+ showRoller: true,
+ errorBars: true,
+ valueRange: [50,125]
+ }
+ );
</script>
</body>
</html>
-
+
Things to note here:
-Things to note here:
+ +The dygraphs library relies heavily on the HTML5 <canvas>
tag, which Microsoft Internet Explorer did not traditionally support. To use Microsoft's native canvas implementation in IE9, you need to set an HTML5 doctype on your page:
+<!DOCTYPE html> +-
The dygraphs library relies heavily on HTML's <canvas> tag, which -Microsoft Internet Explorer does not support. Fortunately, some clever engineers -created the excanvas -library, which implements the <canvas> tag in IE using VML.
+When IE9 is in HTML5 mode, dygraphs works just like in other modern browsers.
-You can add IE support to any page using dygraphs by including the following -in your page:
+If you want to support previous versions of Internet Explorer (IE6–IE8), you'll need to include the excanvas library, which emulates the <canvas>
tag using VML. You can add excanvas by including the following snippet:
-<head> - <!--[if IE]><script src="excanvas.js"></script><![endif]--> -</head> +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7; IE=EmulateIE9"> + <!--[if IE]><script src="path/to/excanvas.js"></script><![endif]--> + </head>-
This works quite well in practice. Charts are responsive, even under VML -emulation.
+(This is surprisingly tricky because the HTML5 doctype breaks excanvas in IE8. See this discussion for details.)
-One common gotcha to look out for: make sure you don't have any trailing -commas in parameter lists, e.g.
+While VML emulation sounds like it would be slow, it works well in practice for most charts.
+ +One common gotcha to look out for: make sure you don't have any trailing commas in parameter lists, e.g.
new Dygraph(el, data, { - showRoller: true, // note trailing comma + showRoller: true, // note trailing comma })
Most browsers will ignore the trailing comma, but it will break under IE.
@@ -427,20 +411,28 @@ new Dygraph(el, data, {The Google Visualization API provides a standard interface for describing data. Once you've specified your data using this API, you can plug in any GViz-compatible visualization. dygraphs is such a visualization.
+ href="http://code.google.com/apis/visualization/documentation/index.html">Google + Visualization API provides a standard interface for describing data. + Once you've specified your data using this API, you can plug in any + GViz-compatible visualization. dygraphs is such a visualization. In + particular, it can be used as a drop-in replacement for the + AnnotatedTimeline visualization used on Google Finance and other sites. To + see how this works, check out the gviz + annotation demo.For a simple demonstration of how to use dygraphs a GViz visualization, see http://danvk.org/dygraphs/tests/gviz.html. dygraphs can also be used as a GViz gadget. This allows it to be embedded inside of a Google Spreadsheet. For a demonstration of this, see this spreadsheet. The URL for the gadget is http://danvk.org/dygraphs/gadget.xml
.
Here's an example of a published gviz gadget using dygraphs:
- +Situations often arise where you want to plot fractions, e.g. the fraction of respondents in a poll who said they'd vote for candidate X or the number of hits divided by at bats (baseball's batting average). Fractions require special treatment for two main reasons:
a1/b1
and a2/b2
is (a1+a2)/(b1+b2)
, not (a1/b1 + a2/b2)/2
.a1/b1
and a2/b2
is (a1+a2)/(b1+b2)
, not (a1/b1 + a2/b2)/2
.Fortunately, dygraphs handles both of these for you! Here's a chart and the command that generated it:
@@ -448,58 +440,111 @@ new Dygraph(el, data, {Command:
-new Dygraph( + new Dygraph( document.getElementById("baseballdiv"), "suzuki-mariners.txt", { - fractions: true, - errorBars: true, - showRoller: true, - rollPeriod: 15 + fractions: true, + errorBars: true, + showRoller: true, + rollPeriod: 15 } -); + );
The fractions
option indicates that the values in each column should be parsed as fractions (e.g. "1/2" instead of "0.5"). The errorBars
option indicates that we'd like to see a confidence interval around each data point. By default, when fractions
is set, you get a Wilson confidence interval. If you look carefully at the chart, you can see that the error bars are asymmetric.
A couple things to notice about this chart:
+This chart shows monthly closes of the Dow Jones Industrial Average, both in nominal and real (i.e. adjusted for inflation) dollars. The shaded areas show its monthly high and low. CPI values with a base from 1982-84 are used to adjust for inflation.
- + +Display: + + + + + + +
+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 | -Values | -Default | -Description | -
---|---|---|---|
includeZero | -boolean |
- 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 | -integer >= 1 |
- 1 |
- Number of days over which to average data. Discussed extensively above. | -
showRoller | -boolean |
- false |
- If the rolling average period text box should be shown. | -
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 | -0.0 - 1.0 |
- 1.0 |
- If colors is not specified, saturation of the automatically-generated data series colors. | -
colorValue | -float (0.0 — 1.0) |
- 1.0 |
- 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){ |
- null |
- 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) | -
zoomCallback | -function(minDate, maxDate){} |
- null |
- A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch. | -
strokeWidth | -integer |
- 1 |
- Width of the data lines. This can be used to increase the contrast or some graphs. | -
dateWindow | -[ |
- Full range of the input is shown |
- Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch. | -
valueRange | -[10, 110] |
- Explicitly set the vertical range of the graph to [low, high]. | -|
labelsSeparateLines | -boolean |
- false |
- Put <br/> between lines in the label string. Often used in conjunction with labelsDiv. |
-
labelsDiv | -document.getElementById('foo') |
- null |
- Show data labels in an external div, rather than on the graph. | -
labelsKMB | -true |
- false |
- Show K/M/B for thousands/millions/billions on y-axis. | -
labelsDivWidth | -250 |
-
|
- Width (in pixels) of the div which shows information on the currently-highlighted points. | -
labelsDivStyles | -{} |
- null |
- Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold. | -
highlightCircleSize | -integer |
- 3 |
- The size in pixels of the dot drawn over highlighted points. | -
drawPoints | -boolean |
- false |
- Draw a small dot at each point, in addition to a line going through the point. This makes the individual data points easier to see, but can increase visual clutter in the chart. | -
pointSize | -interger |
- 1 |
- The size of the dot to draw on each point in pixels (see drawPoints). A dot is always drawn when a point is "isolated", i.e. there is a missing point on either side of it. This also controls the size of those dots. | -
pixelsPerXLabel | -integer |
- 60 |
- Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks. | -
pixelsPerYLabel | -30 |
- ||
xAxisLabelWidth | -integer |
-
|
- Width (in pixels) of the x- and y-axis labels. | -
yAxisLabelWidth | -
|
- ||
axisLabelFontSize | -integer |
- 14 |
- Size of the font (in pixels) to use in the axis labels, both x- and y-axis. | -
rightGap | -integer |
-
|
- 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 | -boolean |
- false |
- Does the data contain standard deviations? Setting this to true alters the input format (see above). | -
sigma | -integer |
-
|
- When errorBars is set, shade this many standard deviations above/below each point. | -
fractions | -boolean |
- 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 | -boolean |
- 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 | -boolean |
- 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. | -
In addition to the options mentioned above (showRoller
, rollPeriod
, errorBars
, valueRange
), there are many others.
For a full list, see the Dygraphs Options Reference page.
Here are a few problems that I've frequently run into while using the dygraphs library.
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 Dygraph, put it inside a table with align = center
set.dateWindow
property to a date. It expects milliseconds since epoch, which can be obtained from a JavaScript Date object's valueOf method.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 Dygraph, put it inside a table with align = center
set.dateWindow
property to a date. It expects milliseconds since epoch, which can be obtained from a JavaScript Date object's valueOf method.There is currently no GWT wrapper around Dygraphs, however there is a class that can be used to easily load Dygraphs into the browser. To use it, include the generated dygraph-gwt.jar file in your classpath and add the following line to your GWT module:
+ ++<inherits name="org.danvk.dygraphs"/> +-
Call org.danvk.Dygraphs.install() when your application starts to install the JavaScript code into the browser. You can use JSNI to call Dygraphs from your GWT code, as in the example below. The example uses the Visualization API for GWT and the Dygraphs GViz API.
+ ++public static native JavaScriptObject drawDygraph( + Element element, DataTable dataTable, double minY, double maxY) /*-{ + var chart = new $wnd.Dygraph.GVizChart(element); + chart.draw(dataTable, + { + valueRange: [minY, maxY] + }); + return chart; +}-*/; ++ + +
Since its public release in late 2009, dygraphs has found many users + across the web. This is a small collection of the uses that we know about. + If you're using dygraphs, please send Dan a link and he'll add it to this + list.
+ +dygraphs was originally developed at Google and has found wide use on + internal dashboards and servers there. There are also a few uses of + dygraphs on public Google products:
+ +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.
+dygraphs has also found use in other organizations:
+ +Created May 9, 2008 by Dan Vanderkam
-Are you using dygraphs? Please let Dan know and he'll add your link here!
+ + +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
+