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