add licensing info
[dygraphs.git] / README
1 dygraphs JavaScript charting library
2 Copyright (c) 2006-, Dan Vanderkam.
3 http://code.google.com/p/dygraphs/
4
5 The dygraphs JavaScript library produces produces interactive, zoomable charts of time series based on CSV files.
6
7 Features
8 - Plots time series without using an external server or Flash
9 - Supports multiple data series
10 - Supports error bands around data series
11 - Displays values on mouseover
12 - Interactive zoom
13 - Adjustable averaging period
14 - Customizable click-through actions
15
16 Caveats
17 - Requires Firefox 1.5+ or Safari/WebKit? 1.3+.
18 - Internet Explorer is poorly supported.
19
20 Demo
21 For a gallery and documentation, see http://danvk.org/dygraphs/
22
23 Minimal Example
24 <html>
25 <head>
26 <script type="text/javascript" src="dygraph-combined.js"></script>
27 </head>
28 <body>
29 <div id="graphdiv" style="width:400px; height:300px;"></div>
30 <script type="text/javascript">
31   g = new DateGraph(
32         document.getElementById("graphdiv"),  // containing div
33         function() {                // function or path to CSV file.
34           return "20080507,75\n" +
35                  "20080508,70\n" +
36                  "20080509,80\n";
37         },
38         [ "Temperature" ],          // names of data series
39         {}                          // additional options (see wiki)
40       );
41 </script>
42 </body>
43 </html>
44
45 License(s)
46 dygraphs uses:
47  - MochiKit (MIT License)
48  - PlotKit (BSD License)
49  - excanvas.js (Apache License)
50
51 dygraphs is available under the MIT license, included in LICENSE.txt.