[dygraphs.git] / README

dygraphs JavaScript charting library
Version 1.0.0
Copyright (c) 2006-, Dan Vanderkam.

Documentation: http://dygraphs.com/
Support: http://groups.google.com/group/dygraphs-users
Source: http://github.com/danvk/dygraphs
Issues: http://code.google.com/p/dygraphs/


The dygraphs JavaScript library produces interactive, zoomable charts of time series.

Features
- Plots time series without using an external server or Flash
- Supports multiple data series
- Supports error bands around data series
- Displays values on mouseover
- Interactive zoom
- Adjustable averaging period
- Customizable click-through actions
- Compatible with the Google Visualization API

Demo
For a gallery and documentation, see http://dygraphs.com/

Minimal Example
<html>
<head>
<script type="text/javascript" src="dygraph-combined.js"></script>
</head>
<body>
<div id="graphdiv"></div>
<script type="text/javascript">
  g = new Dygraph(
        document.getElementById("graphdiv"),  // containing div
        "Date,Temperature\n" +                // the data series
        "2008-05-07,75\n" +
        "2008-05-08,70\n" +
        "2008-05-09,80\n",
        { }                                   // the options
      );
</script>
</body>
</html>

Making Changes
If you've made a change to dygraphs and would like to contribute it back to the
community, please follow the guide at http://dygraphs.com/changes.html.

License(s)
dygraphs uses:
 - rgbcolor.js (Public Domain)
 - strftime.js (BSD License)
 - excanvas.js (Apache License)
 - YUI compressor (BSD License)
 - JsDoc Toolkit (MIT license)
 - stacktrace.js is public domain

automated tests use:
 - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2)
 - auto_tests/lib/Asserts.js (Apache 2.0 License)
 - auto-tests/lib/JsTestDriver-1.3.3cjar (Apache 2.0 License

Linter uses:
 - JSHint (modified MIT license; prevents evil)

rgbcolor: http://www.phpied.com/rgb-color-parser-in-javascript/
strftime: http://tech.bluesmoon.info/2008/04/strftime-in-javascript.html
excanvas: http://code.google.com/p/explorercanvas/
yui compressor: http://developer.yahoo.com/yui/compressor/
jsdoc toolkit: http://code.google.com/p/jsdoc-toolkit/

jquery: http://code.jquery.com/jquery-1.4.2.js
Asserts.js: http://www.google.com/codesearch/p?#3tsINRJRCro/trunk/JsTestDriver/src/com/google/jstestdriver/javascript/Asserts.js
JSTestDriver: http://code.google.com/p/js-test-driver/

JSHint: jshint.com

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