-<html>
- <head>
- <title>dygraphs JavaScript Library</title>
- <!--[if IE]>
- <script type="text/javascript" src="excanvas.js"></script>
- <![endif]-->
- <script type="text/javascript" src="dygraph-combined.js"></script>
- <style type="text/css">
- .thinborder {
- border-width: 1px;
- border-spacing: 0px;
- border-style: solid;
- border-color: black;
- border-collapse: collapse;
- }
- .thinborder td, .thinborder th {
- border-width: 1px;
- padding: 5px;
- border-style: solid;
- border-color: black;
- }
- </style>
- </head>
-<body>
- <center>
- <p><span style="font-size:28pt;">dygraphs JavaScript Library</span><br/>
- <a href="http://code.google.com/p/dygraphs/">code.google.com/p/dygraphs</a></p>
- </center>
-
-<p>The dygraphs JavaScript library produces produces interactive, zoomable charts of time series based on CSV files.</p>
-
-<h3>Features</h3>
-<ul>
- <li>Plots time series without using an external server or Flash</li>
- <li>Supports multiple data series</li>
- <li>Supports error bands around data series</li>
- <li>Displays values on mouseover</li>
- <li>Interactive zoom</li>
- <li>Adjustable averaging period</li>
- <li>Customizable click-through actions</li>
-</ul>
-
-<h3>Caveats</h3>
-<ul>
- <li>Requires Firefox 1.5+ or Safari/WebKit 1.3+.</li>
- <li>Internet Explorer is poorly supported.</li>
-</ul>
-
-<h2>Demo</h2>
-<font size=-1>(Mouse over to highlight individual values. Click and drag to zoom. Double-click to zoom out.)</font><br/>
-<table><tr><td>
-<div id="demodiv" style="width:480px; height:320px;"></div>
-</td><td valign=top>
-<div id="status" style="width:200px; font-size:0.8em; padding-top:5px;"></div>
-</td>
-</tr></table>
-<script type="text/javascript">
- g = new DateGraph(
- document.getElementById("demodiv"),
- function() {
- var r = "date,parabola,line,another line,sine wave\n";
- for (var i=1; i<=31; i++) {
- r += "200610" + i;
- r += "," + 10*(i*(31-i));
- r += "," + 10*(8*i);
- r += "," + 10*(250 - 8*i);
- r += "," + 10*(125 + 125 * Math.sin(0.3*i));
- r += "\n";
- }
- return r;
- },
- null,
- {
- rollPeriod: 1,
- labelsDiv: document.getElementById('status'),
- labelsSeparateLines: true,
- labelsKMB: true,
- colors: ["hsl(180,60,50)",
- "rgb(255,100,100)",
- "#00DD55",
- "rgba(50,50,200,0.4)"],
- padding: {left: 40, right: 30, top: 15, bottom: 15}
- }
- );
-</script>
-
-<h2>Usage</h2>
-
-<p>The DateGraph library depends on two other JS libraries: <a href="http://www.mochikit.com/">MochiKit</a> and <a href="http://www.liquidx.net/plotkit/">PlotKit</a>. Rather than tracking down copies of these libraries, I recommend using a packed version of dygraphs that combines all three libraries into a single JS file. Either grab this file from dygraph project's <a href="http://code.google.com/p/dygraphs/downloads/list">downloads</a> page or create it yourself by <a href="http://code.google.com/p/dygraphs/source/checkout">checking out</a> a copy of the code and running:
-
-<pre>./generate-combined.sh</pre>
-
-<p>The combined JS file is now in <code>dygraph-combined.js</code>. Here's a basic example to get things started:</p>
-
-<table>
- <tr><th>HTML</th>
- <td rowspan=2><img src=arrow.gif /></td>
- <th>Output</th></tr>
-<tr>
-<td valign=top><pre>
-<html>
-<head>
-<script type="text/javascript" src="combined.js"></script>
-</head>
-<body>
-<div id="graphdiv" style="width:400px; height:300px;"></div>
-<script type="text/javascript">
- g = new DateGraph(
- document.getElementById("graphdiv"), // containing div
- function() { // function or path to CSV file.
- return "20080507,75\n" +
- "20080508,70\n" +
- "20080509,80\n";
- },
- [ "Temperature" ], // names of data series
- {} // additional options (see below)
- );
-</script>
-</body>
-</html>
-</pre>
-</td><td valign=top>
- <div id="graphdiv" style="width:400px; height:300px;"></div>
- <script type="text/javascript">
- g = new DateGraph(
- document.getElementById("graphdiv"),
- function() { // function or path to CSV file.
- return "20080507,75\n" +
- "20080508,70\n" +
- "20080509,80\n";
- },
- [ "Temperature" ], // names of data series
- {} // additional options
- );
- </script>
-</td></tr></table>
-
-<p>In order to keep this example self-contained, the second parameter is a function that returns CSV data. These lines <i>must</i> begin with a date in the form <i>YYYYMMDD</i>. In most applications, it makes more sense to include a CSV file instead. If the second parameter to the constructor is a string, it will be interpreted as the path to a CSV file. The DateGraph will perform an XMLHttpRequest to retrieve this file and display the data when it becomes available. Make sure your CSV file is readable and serving from a place that understands XMLHttpRequest's! In particular, you cannot specify a CSV file using <code>"file:///"</code>. Here's an example: (data from <a href="http://www.wunderground.com/history/airport/KNUQ/2007/1/1/CustomHistory.html?dayend=31&monthend=12&yearend=2007&req_city=NA&req_state=NA&req_statename=NA">Weather Underground</a>)</p>
-
-<table>
- <tr><th>HTML</th>
- <td rowspan=2><img src=arrow.gif /></td>
- <th>Output</th></tr>
-<tr>
-<td valign=top><pre>
-<html>
-<head>
-<script type="text/javascript" src="combined.js"></script>
-</head>
-<body>
-<div id="graphdiv" style="width:600px; height:300px;"></div>
-<script type="text/javascript">
- g = new DateGraph(
- document.getElementById("graphdiv"),
- "temperatures.csv", // path to CSV file
- null, // labels in top line of CSV file
- {}
- );
-</script>
-</body>
-</html>
-</pre>
-</td><td valign=top>
- <div id="graphdiv2" style="width:600px; height:300px;"></div>
- <script type="text/javascript">
- g2 = new DateGraph(
- document.getElementById("graphdiv2"),
- "temperatures.csv", null, {}
- );
- </script>
-</td></tr></table>
-
-<p>Click <a href="temperatures.csv">here</a> to view the <code>temperatures.csv</code> file. There are a few things to note here:</p>
-
-<ul>
- <li>Because the third parameter to the DateGraph constructor was <code>null</code>, the labels were taken from the first line of the data instead. The first line of <code>temperatures.csv</code> is <code>Date,High,Low</code>.</li>
- <li>DateGraph automatically chose two different, easily-distinguishable colors for the two data series.</li>
- <li>The labels on the x-axis have switched from days to months. If you zoom in, they'll switch to weeks and then days.</li>
- <li>Some heuristics are used to determine a good vertical range for the data. The idea is to make all the data visible and have human-friendly values on the axis (i.e. 200 instead of 193.4). Generally this works well, but in this case the vertical range is way too large.</li>
- <li>The data is very spiky. A moving average would be easier to interpret.</li>
-</ul>
+<!--#include virtual="header.html" -->
+
+<style>
+pre.prettyprint {
+ margin-top: 28px;
+}
+</style>
+
+ <h4>dygraphs is a fast, flexible open source JavaScript charting library.</h4>
+ <p>It allows users to explore and interpret dense data sets. Here's how it works:</p>
+
+ <div class="row">
+ <div class="col-lg-4">
+ <b>This JavaScript…</b>
+ <pre class="prettyprint">new Dygraph(div, "ny-vs-sf.txt", {
+ legend: 'always',
+ title: 'NYC vs. SF',
+ showRoller: true,
+ rollPeriod: 14,
+ customBars: true,
+ ylabel: 'Temperature (F)',
+});</pre>
+ </div>
+ <div class="col-lg-8">
+ <b>…makes this chart!</b>
+ <div id="demodiv"></div>
+ </div>
+ </div>
-<p>These last two problems can be fixed by specifying the appropriate options in the fourth parameter to the DateGraph constructor. To set the number of days for a moving average, use the <b>rollPeriod</b> option. To set the range of the y-axis, use the <b>valueRange</b> option. Here's how it's done:</p>
-<table>
- <tr><th>HTML</th>
- <td rowspan=2><img src=arrow.gif /></td>
- <th>Output</th></tr>
-<tr>
-<td valign=top><pre>
-<html>
-<head>
-<script type="text/javascript" src="combined.js"></script>
-</head>
-<body>
-<div id="graphdiv" style="width:600px; height:300px;"></div>
-<script type="text/javascript">
- g = new DateGraph(
- document.getElementById("graphdiv"),
- "temperatures.csv", null,
- { rollPeriod: 7,
- showRoller: true,
- valueRange: [25, 100]
- }
- );
-</script>
-</body>
-</html>
-</pre>
-</td><td valign=top>
- <div id="graphdiv3" style="width:600px; height:300px;"></div>
<script type="text/javascript">
- g3 = new DateGraph(
- document.getElementById("graphdiv3"),
- "temperatures.csv", null,
- { rollPeriod: 7,
- showRoller: true,
- valueRange: [25, 100]
- }
- );
- </script>
-</td></tr></table>
-
-<p>A rolling average can be set using the text box in the lower left-hand corner of the graph (the showRoller attribute is what makes this appear).</p>
-
-<h2>Error Bars</h2>
-<p>Another significant feature of the dygraphs library is the ability to display error bars around data series. One standard deviation must be specified for each data point. A +/-<i>n</i> sigma band will be drawn around the data series at that point. If a moving average is being displayed, DateGraph will compute the standard deviation of the average at each point. (i.e. <i>σ</i> = sqrt((<i>σ_1</i>^2 + <i>σ_2</i>^2 + ... + <i>σ_n</i>^2)/<i>n</i>))</p>
-
-<p>Here's a demonstration. There are two data series. One is <code>N(100,10)</code> with a standard deviation of 10 specified at each point. The other is <code>N(80,20)</code> with a standard deviation of 20 specified at each point. The CSV file was generated using Octave and can be viewed <a href="twonormals.csv">here</a>.</p>
-
-<table>
- <tr><th>HTML</th>
- <td rowspan=2><img src=arrow.gif /></td>
- <th>Output</th></tr>
-<tr>
-<td valign=top><pre>
-<html>
-<head>
-<script type="text/javascript"
- src="combined.js"></script>
-</head>
-<body>
-<div id="graphdiv"
- style="width:800px; height:400px;"
- ></div>
-<script type="text/javascript">
-$ = document.getElementById;
-g = new DateGraph(
- $("graphdiv"),
- "twonormals.csv",
- null,
- { rollPeriod: 7,
- showRoller: true,
- errorBars: true,
- valueRange: [50,125]
- }
-);
-</script>
-</body>
-</html>
-</pre>
-</td><td valign=top>
- <div id="graphdiv4" style="width:800px; height:400px;"></div>
- <script type="text/javascript">
-$ = document.getElementById;
-new DateGraph(
- document.getElementById("graphdiv4"),
- "twonormals.csv",
- null,
- { rollPeriod: 14,
- showRoller: true,
- errorBars: true,
- valueRange: [50, 125]
- }
-);
+ g = new Dygraph(
+ document.getElementById("demodiv"),
+ "ny-vs-sf.txt",
+ {
+ rollPeriod: 14,
+ showRoller: true,
+ customBars: true,
+ title: 'NYC vs. SF',
+ ylabel: 'Temperature (F)',
+ legend: 'always'
+ }
+ );
</script>
-</td></tr></table>
-
-<p>Things to note here:</p>
-<ul>
- <li>The <b>errorBars</b> option affects both the interpretation of the CSV file and the display of the graph. When <b>errorBars</b> is set to true, each line is interpreted as <i>YYYYMMDD</i>,<i>A</i>,<i>sigma_A</i>,<i>B</i>,<i>sigma_B</i>,...</li>
- <li>The first line of the CSV file doesn't mention the error columns. In this case, it's just "Date,Series1,Series2".</li>
- <li>The averaging visibly affects the error bars. This is most clear if you crank up the rolling period to something like 100 days. For the earliest dates, there won't be 100 data points to average so the signal will be noisier. The error bars get smaller like sqrt(N) going forward in time until there's a full 100 points to average.</li>
- <li>The error bars are partially transparent. This can be seen when they overlap one another.</li>
-</ul>
-
-<h2>One last demo</h2>
-
-<p>This chart shows monthly closes of the Dow Jones Industrial Average, both in nominal and real (i.e. adjusted for inflation) dollars. The shaded areas show its monthly high and low. CPI values with a base from 1982-84 are used to adjust for inflation.</p>
-
-<div id=dow_chart style="width:1000px; height:400px;"></div>
-<script type="text/javascript">
- // From http://www.econstats.com/eqty/eq_d_mi_3.csv
- dow = new DateGraph(
- document.getElementById('dow_chart'),
- "dow.txt",
- null,
- {
- showRoller: true,
- customBars: true,
- labelsKMB: true,
- padding: {left:30, right:30, top:5, bottom:5}
- });
-</script>
+ <p>The chart is <i>interactive</i>: you can mouse over to highlight individual values. You can click and drag to zoom. Double-clicking will zoom you back out. Shift-drag will pan. You can change the number and hit enter to adjust the averaging period.</p>
-<h2>Other Options</h2>
-<p>These are the options that can be passed in through the fourth parameter of the DateGraph constructor.</p>
+ <div class="row smalltop">
+ <div class="col-lg-8">
+ <h3>Features</h3>
+ <ul>
+ <li>Handles <strong>huge data sets</strong>: dygraphs plots millions of points without getting bogged down.
+ <li><strong>Interactive out of the box</strong>: zoom, pan and mouseover are on by default.
+ <li>Strong support for <strong>error bars</strong> / confidence intervals.
+ <li><strong>Highly customizable</strong>: using options and custom callbacks, you can make dygraphs do almost anything.
+ <li>dygraphs is works in all recent browsers. You can even <strong>pinch to zoom</strong> on mobile/tablet devices!
+ <li>There's an <strong>active community</strong> developing and supporting dygraphs.</li>
+ </ul>
-<table class=thinborder width=1000>
- <tr><th>Name</th><th>Sample Value</th><th>Description</th></tr>
- <tr>
- <td><b>rollPeriod</b></td>
- <td><code>7</code></td>
- <td>Number of days over which to average data. Discussed extensively above.</td>
- </tr><tr>
- <td><b>showRoller</b></td>
- <td><code>true</code></td>
- <td>Should the rolling average period text box be shown? Default is false.</td>
- </tr><tr>
- <td><b>colors</b></td>
- <td><code>['red', '#00FF00']</code></td>
- <td>List of colors for the data series. These can be of the form "#AABBCC"
- or "rgb(255,100,200)" or "yellow", etc. If not specified, equally-spaced
- points around a color wheel are used.</td>
- </tr><tr>
- <td><b>colorSaturation</b></td>
- <td><code>1.0</code></td>
- <td>If <b>colors</b> is not specified, saturation of the
- automatically-generated data series colors. (0.0-1.0, default:
- 1.0)</td>
- </tr><tr>
- <td><b>colorValue</b></td>
- <td><code>0.5</code></td>
- <td>If colors is not specified, value of the data series colors, as in
- hue/saturation/value. (0.0-1.0, default 0.5)</td>
- </tr><tr>
- <td><b>clickCallback</b></td>
- <td><code>function(e,date){ alert(date); }</code></td>
- <td>A function to call when a data point is clicked. The function should take
- two arguments, the event object for the click and the date that was
- clicked. (default null)</td>
- </tr><tr>
- <td><b>errorBars</b></td>
- <td><code>false</code></td>
- <td>Does the data contain standard deviations? Setting this to true alters
- the input format (see above). (default false)</td>
- </tr><tr>
- <td><b>strokeWidth</b></td>
- <td><code>2.0</code></td>
- <td>Width of the data lines. This can be used to increase the contrast or
- some graphs. (default 1.0)</td>
- </tr><tr>
- <td><b>dateWindow</b></td>
- <td><code>[(new Date('2006-01-01')).valueOf(),<br/>
- (new Date()).valueOf()]</code></td>
- <td>Initially zoom in on a section of the graph. Is of the form [earliest,
- latest], where earliest/latest are millis since epoch. By default, the
- full range of the input is shown.</td>
- </tr><tr>
- <td><b>valueRange</b></td>
- <td><code>[10, 110]</code></td>
- <td>Explicitly set the vertical range of the graph to [low, high]. By
- default, some clever heuristics are used (see above).</td>
- </tr><tr>
- <td><b>minTickSize</b></td>
- <td><code>1</code</td>
- <td>The difference between ticks on the y-axis can be greater than or equal
- to this, but no less. If you set it to 1, for instance, you'll never get
- nonintegral gaps between ticks.</td>
- </tr><tr>
- <td><b>labelsSeparateLines</b></td>
- <td><code>true</code></td>
- <td>Put <br/> between lines in the label string. Often used in
- conjunction with <b>labelsDiv</b>. (default false)</td>
- </tr><tr>
- <td><b>labelsDiv</b></td>
- <td><code>document.getElementById('foo')</code></td>
- <td>Show data labels in an external div, rather than on the graph. (default
- null)</td>
- </tr><tr>
- <td><b>labelsKMB</b></td>
- <td><code>true</code></td>
- <td>Show K/M/B for thousands/millions/billions on y-axis (default
- false).</td>
- </tr>
- <tr>
- <td><b>padding</b></td>
- <td><code>{left: 40, right: 30,<br/>top: 5,
- bottom: 15}</code></td>
- <td>Adds extra pixels of padding around the graph. Sometimes a dygraph
- gets clipped by surrounding text (see the Demo at the top of this page).
- Setting this property appropriately will fix this problem.</td>
- </tr>
-</table>
+ <h3>Getting Started</h3>
+ <p>Start by <a href="download.html">downloading dygraphs</a>. Then read the <a href="tutorial.html">Tutorial</a> to learn how to use it, or just <a href="http://dygraphs.com/fiddle">play with dygraphs</a> on jsFiddle.</p>
-<p>Any options you specify also get passed on to PlotKit's <a href="http://media.liquidx.net/js/plotkit-doc/PlotKit.Renderer.html">Renderer</a> class. DateGraph will override some of these (e.g. strokeColor), but others may be useful. The <code>padding</code> property is an example of this.</p>
+ <p>Once you've got your feet wet, look for inspiration in the <a href="gallery/">demo gallery</a> or check out our <a href="users.html">list of users</a>.</p>
-<h2>Common Gotchas</h2>
-<p>Here are a few problems that I've frequently run into while using the
-dygraphs library.</p>
+ <p>If you're using npm and a bundler like webpack, browserify or rollup, you can install dygraphs via:</p>
-<ul>
- <li>Make sure your CSV files are readable! If your graph isn't showing up,
- the XMLHttpRequest for the CSV file may be failing. You can determine whether
- this is the case using tools like <a
- href="http://www.getfirebug.com/">Firebug</a>.</li>
+ <pre>npm install --save dygraphs</pre>
- <li>Make sure your CSV files are in the correct format. They must be of the
- form <code>YYYYMMDD,series1,series2,...</code>. If you're specifying the
- names of each data series in the CSV file itself, make sure that you pass
- <code>null</code> as the third parameter to the DateGraph constructor to let
- the library know that. And if you set the <code>errorBars</code> property,
- make sure you alternate data series and standard deviations.</li>
+ and use it via:
- <li>dygraphs are not happy when placed inside a <code><center></code>
- tag. This applies to the CSS <code>text-align</code> property as well. If you
- want to center a DateGraph, put it inside a table with "align=center"
- set.</li>
+ <pre class="prettyprint">import Dygraph from 'dygraphs';
+// or: const Dygraph = require('dygraphs');
+const g = new Dygraph(div, data, {});</pre>
- <li>If you specify the <code>colors</code> property or name the data series
- using the third parameter of the DateGraph constructor, make sure the number
- of data series agree in all places: <code>colors</code>, third parameter and
- in each line of the CSV file itself.</li>
+ <p>Check out the <a href="https://github.com/danvk/dygraphs-es6">dygraphs ES6 sample project</a> for more details on this approach.</p>
+ </div>
- <li>Don't set the <code>dateWindow</code> property to a date. It expects
- milliseconds since epoch, which can be obtained from a JavaScript Date
- object's valueOf method.</li>
-</ul>
+ <div class="col-lg-4">
+ <h3>Quick Links</h3>
+ <ul>
+ <li><a href="tutorial.html">Tutorial</a>
+ <li><a href="options.html">Options Reference</a>
+ <li><a href="jsdoc/symbols/Dygraph.html">API Reference</a>
+ <li><a href="css.html">CSS Reference</a>
+ <li><a href="data.html">Data format</a> documentation
+ <li><a href="http://stackoverflow.com/questions/ask?tags=dygraphs+javascript">Ask a Question</a> on Stack Overflow.</a>
+ <li><a href="https://groups.google.com/forum/#!forum/dygraphs-users">Mailing List</a>
+ <li><a href="http://blog.dygraphs.com/">dygraphs blog</a>
+ <li><a href="legal.html">Policy & Licensing</a>
+ </ul>
+ </div>
-<p><font size=-1>Created May 9, 2008 by <a href=mailto:danvdk@gmail.com>Dan Vanderkam</a></font></p>
+ </div>
-</body>
-</html>
+<!--#include virtual="footer.html" -->
projects / dygraphs.git / blobdiff