X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=docs%2Findex.html;h=a4fb76c1c951b9bf3c251c3767f689fa2b1d96c9;hb=7ca60bd1161dc1e4c623fb9def484fa20854149c;hp=ab6d92b99f52a828f53029500317a38b62dd3c4c;hpb=fe57a69b082bf92bad82593c8801caa367516ae4;p=dygraphs.git

diff --git a/docs/index.html b/docs/index.html
index ab6d92b..a4fb76c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -31,14 +31,16 @@
         top: 0px;
         border-left: 2px solid rgb(229, 236, 249);
         padding-left: 10px;
+        margin-left: 0px;
       }
 
       #nav ul {
         list-style: none;
         padding-left: 20px;
+        margin-left: 0px;
       }
       #nav ul ul {
-        padding-left: 1em;
+        padding-left: 0.5em;
         padding-bottom: 1em;
       }
       #nav ul ul li {
@@ -54,6 +56,9 @@
   <ul>
   <li><a href="#demo">Demo</a>
   <li><a href="#usage">Usage</a>
+  <li><a href="#ie">IE Compatibility</a>
+  <li><a href="#gviz">GViz Data</a>
+  <li><a href="#baseball">Baseball chart</a>
   <li><a href="#stock">Stock chart</a>
   <li><a href="#options">Options Reference</a>
   <li><a href="#policy">Data Policy</a>
@@ -74,6 +79,7 @@
   <li><a href="tests/gviz.html">GViz Demo</a>
   <li><a href="tests/plotter.html">Equation Plotter</a>
   <li><a href="tests/perf.html">Performance Test</a>
+  <li><a href="tests/perf.html">Fractions</a>
 
   <li><a href="tests/label-div.html">Labels in a DIV</a>
   <li><a href="tests/numeric-axis.html">Numeric Axis</a>
@@ -103,25 +109,13 @@
 <div id="content">
 <p><span style="font-size:28pt;">dygraphs JavaScript Visualization Library</span><br/>
 <a href="http://github.com/danvk/dygraphs">http://github.com/danvk/dygraphs</a><br/>
-See <a href="tests/">gallery</a> and <a href="http://code.google.com/p/dygraphs/issues/">open issues</a></p>
+See <a href="http://github.com/danvk/dygraphs/downloads/">downloads</a>, <a href="tests/">gallery</a> and <a href="http://code.google.com/p/dygraphs/issues/">open issues</a></p>
 
-<p>The dygraphs JavaScript library produces produces interactive, zoomable charts of time series. It is designed to display dense data sets and enable users to explore and interpret them.</p>
+<p>dygraphs is an open source JavaScript library that produces produces interactive, zoomable charts of time series. It is designed to display dense data sets and enable users to explore and interpret them.</p>
 
-<h3>Features</h3>
-<ul>
-  <li>Plots time series without using an external server or Flash</li>
-  <li>Supports error bands around data series</li>
-  <li>Displays values on mouseover (this makes it easily discoverable)</li>
-  <li>Interactive zoom</li>
-  <li>Adjustable averaging period</li>
-  <li>Customizable click-through actions</li>
-  <li>Compatible with the Google Visualization API</li>
-  <li>Works in Internet Explorer (using excanvas)</li>
-  <li>Intelligent defaults make it easy to use</li>
-  <li>Lightweight (45kb) and responsive</li>
-</ul>
+<a name="demo">
+<p>A demo is worth a thousand words:</p>
 
-<a name="demo"><h2>Demo</h2>
 <p><font size=-1>(Mouse over to highlight individual values. Click and drag to zoom. Double-click to zoom back out. Change the number and hit enter to adjust the averaging period.)</font></p>
 <div id="title" style="width:800px; text-align:center; font-weight: bold; font-size: 125%;">Temperatures in New York vs. San Francisco</div>
 <div id="demodiv" style="width:800px; height:320px;"></div>
@@ -149,11 +143,29 @@ See <a href="tests/">gallery</a> and <a href="http://code.google.com/p/dygraphs/
 <li>There is a <i>lot</i> of data in this chart: low, average and high for each city on each day of a three year period &asymp; 6000 data points in all.
 </ul>
 
+<p>dygraphs allows the user to explore the data and discover these facts.</p>
+
 <p>For more demos, browse the dygraph <a href="tests/">tests</a> directory.</p>
 
+<h3>Features</h3>
+<p>Some of the features of dygraphs:</p>
+<ul>
+  <li>Plots time series without using an external server or Flash</li>
+  <li>Works in Internet Explorer (using excanvas)</li>
+  <li>Lightweight (45kb) and responsive</li>
+  <li>Displays values on mouseover (this makes it easily discoverable)</li>
+  <li>Supports error bands around data series</li>
+  <li>Interactive zoom</li>
+  <li>Adjustable averaging period</li>
+  <li>Can intelligently chart fractions</li>
+  <li>Customizable click-through actions</li>
+  <li>Compatible with the Google Visualization API</li>
+  <li>Intelligent defaults make it easy to use</li>
+</ul>
+
 <a name="usage"><h2>Usage</h2>
 
-<p>To use dygraphs, include the <code>dygraph-combined.js</code> JavaScript file and instantiate a <code>Dygraph</code> object.</p>
+  <p>To use dygraphs, include the <code><a href="http://github.com/danvk/dygraphs/downloads/">dygraph-combined.js</a></code> JavaScript file and instantiate a <code>Dygraph</code> object.</p>
 
 <p>Here's a basic example to get things started:</p>
 
@@ -178,7 +190,7 @@ See <a href="tests/">gallery</a> and <a href="http://code.google.com/p/dygraphs/
         "Date,Temperature\n" +
         "2008-05-07,75\n" +
         "2008-05-08,70\n" +
-        "2008-05-09,80\n",
+        "2008-05-09,80\n"
       );
 &lt;/script&gt;
 &lt;/body&gt;
@@ -186,17 +198,18 @@ See <a href="tests/">gallery</a> and <a href="http://code.google.com/p/dygraphs/
 </pre>
 </td><td valign=top>
   <div id="graphdiv"></div>
-  <script type="text/javascript">
-    g = new Dygraph(
-        document.getElementById("graphdiv"),  // containing div
-        "Date,Temperature\n" +                // CSV or path to a CSV file.
-        "2008-05-07,75\n" +
-        "2008-05-08,70\n" +
-        "2008-05-09,80\n"
-      );
-  </script>
 </td></tr></table>
 
+<script type="text/javascript">
+  g1 = new Dygraph(
+       document.getElementById("graphdiv"),  // containing div
+       "Date,Temperature\n" +                // CSV or path to a CSV file.
+       "2008-05-07,75\n" +
+       "2008-05-08,70\n" +
+       "2008-05-09,80\n"
+     );
+</script>
+
 <p>In order to keep this example self-contained, the second parameter is raw CSV data. The dygraphs library parses this data (including column headers), resizes the its container to a reasonable default, calculates appropriate axis ranges and tick marks and draws the graph.</p>
 
 <p>In most applications, it makes more sense to include a CSV file instead. If the second parameter to the constructor doesn't contain a newline, it will be interpreted as the path to a CSV file. The Dygraph 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>
@@ -227,14 +240,15 @@ See <a href="tests/">gallery</a> and <a href="http://code.google.com/p/dygraphs/
 </pre>
 </td><td valign=top>
   <div id="graphdiv2" style="width:500px; height:300px;"></div>
-  <script type="text/javascript">
-    g2 = new Dygraph(
-          document.getElementById("graphdiv2"),
-          "temperatures.csv", {}
-        );
-  </script>
 </td></tr></table>
 
+<script type="text/javascript">
+  g2 = new Dygraph(
+        document.getElementById("graphdiv2"),
+        "temperatures.csv", {}
+      );
+</script>
+
 <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>
@@ -276,17 +290,16 @@ See <a href="tests/">gallery</a> and <a href="http://code.google.com/p/dygraphs/
 </pre>
 </td><td valign=top>
   <div id="graphdiv3" style="width:500px; height:300px;"></div>
-  <script type="text/javascript">
-    g3 = new Dygraph(
-          document.getElementById("graphdiv3"),
-          "temperatures.csv",
-          { rollPeriod: 7,
-            showRoller: true,
-          }
-        );
-  </script>
 </td></tr></table>
 
+<script type="text/javascript">
+  g3 = new Dygraph(
+        document.getElementById("graphdiv3"),
+        "temperatures.csv",
+        { rollPeriod: 7,
+          showRoller: true });
+</script>
+
 <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). Also note that we've explicitly set the size of the chart div.</p>
 
 <h2>Error Bars</h2>
@@ -326,7 +339,9 @@ g = new Dygraph(
 </pre>
 </td><td valign=top>
   <div id="graphdiv4" style="width:600px; height:300px;"></div>
-  <script type="text/javascript">
+</td></tr></table>
+
+<script type="text/javascript">
 $ = document.getElementById;
 new Dygraph(
   document.getElementById("graphdiv4"),
@@ -337,8 +352,7 @@ new Dygraph(
     valueRange: [50, 125]
   }
 );
-  </script>
-</td></tr></table>
+</script>
 
 <p>Things to note here:</p>
 <ul>
@@ -348,6 +362,100 @@ new Dygraph(
   <li>The error bars are partially transparent. This can be seen when they overlap one another.</li>
 </ul>
 
+<a name="ie"><h2>Internet Explorer Compatibility</h2>
+
+<p>The dygraphs library relies heavily on HTML's &lt;canvas&gt; tag, which
+Microsoft Internet Explorer does not support. Fortunately, some clever engineers
+created the <a href="http://code.google.com/p/explorercanvas/">excanvas</a>
+library, which imlements the &lt;canvas&gt; tag in IE using VML.</p>
+
+<p>You can add IE support to any page using dygraphs by including the following
+in your page:</p>
+
+<pre>
+&lt;head&gt;
+&lt;!--[if IE]&gt;&lt;script src="excanvas.js"&gt;&lt;/script&gt;&lt;![endif]--&gt;
+&lt;/head&gt;
+</pre>
+
+<p>This works quite well in practice. Charts are responsive, even under VML
+emulation.</p>
+
+<p>One common gotcha to look out for: make sure you don't have any trailing
+commas in parameter lists, e.g.</p>
+
+<pre>new Dygraph(el, data, {
+  showRoller:true,  // &lt;-- note trailing comma
+})</pre>
+
+<p>Most browsers will ignore the trailing comma, but it will break under IE.</p>
+
+<a name="gviz"><h2>GViz Data</h2>
+<p>The <a
+  href="http://code.google.com/apis/visualization/documentation/index.html">Google
+  Visualization API</a> provides a standard interface for describing data. Once
+you've specified your data using this API, you can plug in any GViz-compatible
+visualization. dygraphs is such a visualization.</p>
+
+<p>For a simple demonstration of how to use dygraphs a GViz visualization, see
+<a href="http://danvk.org/dygraphs/tests/gviz.html">this page</a>. dygraphs can
+also be used as a GViz gadget. This allows it to be embedded inside of a Google
+Spreadsheet. For a demonstration of this, see <a
+  href="http://spreadsheets.google.com/ccc?key=0Anx1yCqeL8YUdDR1c3pPREhraGhkWmdhaURjOXRncXc&hl=en">this
+  spreadsheet</a>. The URL for the gadget is
+<code>http://danvk.org/dygraphs/gadget.xml</code>.</p>
+
+<p>Here's an example of a published gviz gadget using dygraphs:</p>
+<script src="http://spreadsheets.google.com/gpub?url=http%3A%2F%2Fkb8jbn8l90ocl9n4b14jrcvp61ceqis5.spreadsheets.gmodules.com%2Fgadgets%2Fifr%3Fup__table_query_url%3Dhttp%253A%252F%252Fspreadsheets.google.com%252Ftq%253Frange%253DA1%25253AC31%2526headers%253D-1%2526key%253D0Anx1yCqeL8YUdDR1c3pPREhraGhkWmdhaURjOXRncXc%2526gid%253D0%2526pub%253D1%26up__table_query_refresh_interval%3D300%26url%3Dhttp%253A%252F%252Fdanvk.org%252Fdygraphs%252Fgadget.xml%253Fnocache&height=215&width=530"></script>
+
+
+<a name="baseball"><h2>Charting Fractions</h2>
+<p>Situations often arise where you want to plot fractions, e.g. the fraction of respondents in a poll who said they'd vote for candidate X or the number of hits divided by at bats (baseball's batting average). Fractions require special treatment for two main reasons:</p>
+
+<ul>
+<li>The average of <code>a1/b1</code> and <code>a2/b2</code> is
+<code>(a1+a2)/(b1+b2)</code>, not <code>(a1/b1 + a2/b2)/2</code>.
+<li>The normal approximation is not always applicable and more sophisticated
+confidence intervals (e.g. the <a
+href="http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval">Wilson
+confidence interval</a>) must be employed to avoid ratios that exceed 100% or
+go below 0%.
+</ul>
+
+<p>Fortunately, dygraphs handles both of these for you! Here's a chart and the command that generated it:</p>
+
+<div style="width:750px; text-align:center; font-weight: bold; font-size: 125%;">Batting Average for Ichiro Suzuki vs. Mariners (2004)</div>
+<div id="baseballdiv" style="width:750px; height:300px;"></div>
+<script type="text/javascript">
+new Dygraph(document.getElementById("baseballdiv"),
+            "suzuki-mariners.txt", {
+              fractions: true,
+              errorBars: true,
+              showRoller: true,
+              rollPeriod: 15
+            });
+</script>
+
+<p>Command:</p>
+<pre>
+new Dygraph(
+  document.getElementById("baseballdiv"), "suzuki-mariners.txt",
+  {
+    fractions: true, errorBars: true,
+    showRoller: true, rollPeriod: 15
+  });
+</pre>
+
+<p>The <code>fractions</code> option indicates that the values in each column should be parsed as fractions (e.g. "1/2" instead of "0.5"). The <code>errorBars</code> option indicates that we'd like to see a confidence interval around each data point. By default, when <code>fractions</code> is set, you get a Wilson confidence interval. If you look carefully at the chart, you can see that the error bars are asymmetric.</p>
+
+<p>A couple things to notice about this chart:</p>
+<ul>
+<li>The error bars for Ichiro's batting average are larger than for the Mariners', since he has far fewer at bats than his team.
+<li>dygraphs makes it easy to see "batting average over the last 30 games". This is ordinarily quite difficult to compute. It makes it clear where the "hot" and "cold" part of Suzuki's season were.
+<li>If you set the averaging period to something large, like 200, you'll see the team's and player's batting average through that game. The final number is the overall batting average for the season.
+<li>Where the error bars do not overlap, we can say with 95% confidence that the series differ. There is a better than 95% chance that Ichiro was a better hitter than his team as a whole in 2004, the year he won the batting title.
+</ul>
+
 <a name="stock"><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>
@@ -361,9 +469,7 @@ new Dygraph(
     {
       showRoller: true,
       customBars: true,
-      labelsKMB: true,
-      padding: {left:30, right:30, top:5, bottom:5}
-    });
+      labelsKMB: true });
 </script>
 <!--
 
@@ -598,8 +704,6 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)
   </tr>
 </table>
 
-<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. dygraphs will override some of these (e.g. strokeColor), but others may be useful. The <code>padding</code> property is an example of this.</p>
-
 <h2>Common Gotchas</h2>
 <p>Here are a few problems that I've frequently run into while using the
 dygraphs library.</p>
@@ -623,6 +727,10 @@ dygraphs library.</p>
   <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>
+
+  <li>Make sure you don't have any trailing commas in your call to the Dygraph
+  constructor or in the options parameter. Firefox, Chrome and Safari ignore
+  these but they can cause a graph to not display in Internet Explorer.</li>
 </ul>
 
 <a name="policy">