Add a:visited style to link-interaction (#819)
[dygraphs.git] / README.md
CommitLineData
9f3f36f8 1[![Build Status](https://travis-ci.org/danvk/dygraphs.svg?branch=markdown-readme)](https://travis-ci.org/danvk/dygraphs) [![Coverage Status](https://img.shields.io/coveralls/danvk/dygraphs.svg)](https://coveralls.io/r/danvk/dygraphs)
215e9e97
DV
2# dygraphs JavaScript charting library
3
4The dygraphs JavaScript library produces interactive, zoomable charts of time series:
5
067641c1 6<img src="https://cloud.githubusercontent.com/assets/98301/5311286/eb760eea-7c10-11e4-9a59-1d144e51a15b.png" width="618" height="322">
215e9e97
DV
7
8Learn more about it at [dygraphs.com](http://www.dygraphs.com).
9
10Get help with dygraphs on
11[Stack Overflow](http://stackoverflow.com/questions/tagged/dygraphs) (preferred) and
12[Google Groups](http://groups.google.com/group/dygraphs-users)
13
14## Features
15* Plots time series without using an external server or Flash
16* Supports [error bands](http://dygraphs.com/tests/legend-values.html) around data series
067641c1 17* Interactive [pan and zoom](http://dygraphs.com/tests/link-interaction.html)
215e9e97
DV
18* Displays values [on mouseover](http://dygraphs.com/tests/legend-values.html)
19* Adjustable [averaging period](http://dygraphs.com/tests/temperature-sf-ny.html)
20* Extensive set of [options](http://www.dygraphs.com/options.html) for customization.
21* Compatible with the [Google Visualization API](http://dygraphs.com/data.html#datatable)
22
23## Minimal Example
24```html
25<html>
26<head>
fd6b8dad
DV
27<script type="text/javascript" src="dygraph.js"></script>
28<link rel="stylesheet" href="dygraph.css" />
215e9e97
DV
29</head>
30<body>
31<div id="graphdiv"></div>
32<script type="text/javascript">
33 g = new Dygraph(
34 document.getElementById("graphdiv"), // containing div
35 "Date,Temperature\n" + // the data series
36 "2008-05-07,75\n" +
37 "2008-05-08,70\n" +
38 "2008-05-09,80\n",
39 { } // the options
40 );
41</script>
42</body>
43</html>
44```
45
46Learn more by reading [the tutorial](http://www.dygraphs.com/tutorial.html) and
47seeing demonstrations of what dygraphs can do in the
48[gallery](http://www.dygraphs.com/gallery).
49
341a2d65
DV
50## Development
51
52To get going, clone the repo and run:
53
54 npm install
e4fd77b3
DV
55 npm run build
56
57Then open `tests/demo.html` in your browser.
341a2d65
DV
58
59Read more about the dygraphs development process in the [developer guide](/DEVELOP.md).
215e9e97
DV
60
61## License(s)
215e9e97 62dygraphs is available under the MIT license, included in LICENSE.txt.