Update document reference; add docs for pointClickCallback, and clarify
[dygraphs.git] / README
CommitLineData
19e4f838
DV
1dygraphs JavaScript charting library
2Copyright (c) 2006-, Dan Vanderkam.
c5b6da49 3
727439b4 4Documentation: http://dygraphs.com/
c5b6da49
DV
5Support: http://groups.google.com/group/dygraphs-users
6Source: http://github.com/danvk/dygraphs
7Issues: http://code.google.com/p/dygraphs/
8af5b23b 8
19e4f838 9
285a6bda 10The dygraphs JavaScript library produces produces interactive, zoomable charts of time series.
19e4f838
DV
11
12Features
13- Plots time series without using an external server or Flash
14- Supports multiple data series
15- Supports error bands around data series
16- Displays values on mouseover
17- Interactive zoom
18- Adjustable averaging period
19- Customizable click-through actions
285a6bda 20- Compatible with the Google Visualization API
19e4f838 21
19e4f838 22Demo
727439b4 23For a gallery and documentation, see http://dygraphs.com/
19e4f838
DV
24
25Minimal Example
26<html>
27<head>
28<script type="text/javascript" src="dygraph-combined.js"></script>
29</head>
30<body>
285a6bda 31<div id="graphdiv"></div>
19e4f838 32<script type="text/javascript">
61b5e925 33 g = new Dygraph(
19e4f838 34 document.getElementById("graphdiv"), // containing div
285a6bda
DV
35 "Date,Temperature\n" + // the data series
36 "2008-05-07,75\n" +
37 "2008-05-08,70\n" +
aea23d5f 38 "2008-05-09,80\n",
916a000e 39 { } // the options
19e4f838
DV
40 );
41</script>
42</body>
43</html>
44
cd12bba0
DV
45Making Changes
46If you've made a change to dygraphs and would like to contribute it back to the
47community, please follow the guide at http://dygraphs.com/changes.html.
48
19e4f838
DV
49License(s)
50dygraphs uses:
1946f7ce
DV
51 - rgbcolor.js (Public Domain)
52 - strftime.js (BSD License)
19e4f838 53 - excanvas.js (Apache License)
f18986e5 54 - YUI compressor (BSD License)
b3d2a929
DV
55 - JsDoc Toolkit (MIT license)
56
19e4f838 57
916a000e
RK
58automated tests use:
59 - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2)
60 - auto_tests/lib/Asserts.js (Apache 2.0 License)
61 - auto-tests/lib/JsTestDriver-1.3.2.jar (Apache 2.0 License
62
1946f7ce
DV
63rgbcolor: http://www.phpied.com/rgb-color-parser-in-javascript/
64strftime: http://tech.bluesmoon.info/2008/04/strftime-in-javascript.html
65excanvas: http://code.google.com/p/explorercanvas/
f18986e5 66yui compressor: http://developer.yahoo.com/yui/compressor/
b3d2a929 67jsdoc toolkit: http://code.google.com/p/jsdoc-toolkit/
1946f7ce 68
916a000e
RK
69jquery: http://code.jquery.com/jquery-1.4.2.js
70Asserts.js: http://www.google.com/codesearch/p?#3tsINRJRCro/trunk/JsTestDriver/src/com/google/jstestdriver/javascript/Asserts.js
71JSTestDriver: http://code.google.com/p/js-test-driver/
72
19e4f838 73dygraphs is available under the MIT license, included in LICENSE.txt.