Merge pull request #260 from klausw-g/resize-fix-2
[dygraphs.git] / docs / index.html
index c5917ce..cc3d1be 100644 (file)
@@ -1,14 +1,31 @@
 <!DOCTYPE html>
 <html>
   <head>
+    <meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7; IE=EmulateIE9">
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
     <title>dygraphs JavaScript Visualization Library</title>
     <!--[if IE]>
       <script type="text/javascript" src="excanvas.js"></script>
     <![endif]-->
     <script type="text/javascript" src="dygraph-combined.js"></script>
     <link rel="stylesheet" href="style.css">
+
+    <!-- Google Analytics -->
+    <script type="text/javascript">
+      var _gaq = _gaq || [];
+      _gaq.push(['_setAccount', 'UA-769809-2']);
+      _gaq.push(['_trackPageview']);
+      (function() {
+        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+      })();
+    </script>
   </head>
   <body>
+    <a href="http://github.com/danvk/dygraphs"><img style="position: absolute; top: 0; right: 0; border: 0; z-index: 1;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_green_007200.png" alt="Fork me on GitHub"></a>
+
     <div id="nav">
       <h2>Documentation</h2>
       <ul>
         <li><a href="#gviz">GViz Data</a></li>
         <li><a href="#baseball">Baseball chart</a></li>
         <li><a href="#stock">Stock chart</a></li>
-        <li><a href="#options">Options Reference</a></li>
         <li><a href="#gwt">GWT Compatibility</a></li>
         <li><a href="#policy">Data Policy</a></li>
-      </ul>
-
-      <h2>Features</h2>
-      <ul>
+        <li><a href="options.html">Options Reference</a></li>
+        <li><a href="jsdoc/symbols/Dygraph.html">JSDoc Reference</a></li>
         <li><a href="data.html">Data Formats</a></li>
         <li><a href="annotations.html">Annotations</a></li>
       </ul>
 
       <h2>Project</h2>
       <ul>
+        <li><a href="http://blog.dygraphs.com/">Blog</a></li>
         <li><a href="http://github.com/danvk/dygraphs">Source</a></li>
         <li><a href="http://code.google.com/p/dygraphs/issues/">Issues</a></li>
         <li><a href="http://code.google.com/p/dygraphs/issues/entry">Report Bug</a></li>
         <li><a href="mailto:dygraphs-users [at] googlegroups.com">Contact</a></li>
       </ul>
 
-      <h2>Gallery</h2>
+      <h2>Demos/Usage</h2>
       <ul>
+        <li><a href="#users">Known Users</a></li>
+        <hr/>
+        <li><span style="color: red;">New!</span> <a href="gallery/">(browse gallery)</a></li>
         <li><a href="tests/">(browse demos)</a></li>
         <li><a href="tests/demo.html">Basic Demo</a></li>
         <li><a href="tests/gviz.html">GViz Demo</a></li>
@@ -57,7 +75,6 @@
         <li><a href="tests/grid_dot.html">Crazy Styles</a></li>
         <li><a href="tests/spacing.html">Tick spacing</a></li>
         <li><a href="tests/callback.html">Callbacks</a></li>
-        <li><a href="tests/crosshair.html">Crosshairs</a></li>
         <li><a href="tests/hourly.html">Hourly/Minutely data</a></li>
         <li><a href="tests/isolated-points.html">Isolated Points</a></li>
         <li><a href="tests/missing-data.html">Missing Data</a></li>
@@ -66,8 +83,6 @@
         <li><a href="tests/customLabel.html">Custom Label Styles</a></li>
         <li><a href="tests/dygraph.html">Minimal Example</a></li>
         <li><a href="tests/negative.html">Negative Numbers</a></li>
-        <li><a href="tests/noise.html">Noisy Data</a></li>
-        <li><a href="tests/two-series.html">Multiple Series</a></li>
         <li><a href="tests/highlighted-region.html">Custom Underlay / background</a></li>
         <li><a href="tests/zoom.html">Tests for zoom operations</a></li>
         <li><a href="tests/logscale.html">Log scale tests</a></li>
       <h1>dygraphs JavaScript Visualization Library</h1>
 
       <p><a href="http://github.com/danvk/dygraphs">http://github.com/danvk/dygraphs</a></p>
-      <p>See <a href="http://groups.google.com/group/dygraphs-users">mailing list</a>, <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>For help, <a
+        href="http://stackoverflow.com/questions/ask?tags=dygraphs+javascript">ask
+        a question</a> on StackOverflow. You may also be interested in the <a
+        href="http://blog.dygraphs.com/">blog</a>, <a
+        href="http://groups.google.com/group/dygraphs-users">mailing list</a>, <a
+        href="tests/">demos</a> and <a
+        href="http://code.google.com/p/dygraphs/issues/">open issues</a>.</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>
 
 
       <p style="font-size:0.8em">(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.)</p>
 
-      <div id="title" style="width:800px; margin: 1em;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>
       <script type="text/javascript">
         g = new Dygraph(
             rollPeriod: 14,
             showRoller: true,
             customBars: true,
-            yAxisLabelWidth: 30
+            title: 'Daily Temperatures in New York vs. San Francisco',
+            ylabel: 'Temperature (F)',
+            legend: 'always',
+            labelsDivStyles: { 'textAlign': 'right' }
           }
         );
       </script>
 
       <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>
+      <p>For more demos, browse the dygraph <a href="tests/">tests</a>
+      directory. To see other people who are using dygraphs, check out the <a
+      href="#users">known users</a>.</p>
 
       <h3>Features</h3>
       <p>Some of the features of dygraphs:</p>
         <li>Plots time series without using an external server or Flash</li>
         <li>Works in Internet Explorer (using excanvas)</li>
         <li>Lightweight (69kb) and responsive</li>
-        <li>Displays values on mouseover (this makes it easily discoverable)</li>
+        <li>Displays values on mouseover, making interaction easily discoverable</li>
         <li>Supports error bands around data series</li>
         <li>Interactive zoom</li>
         <li>Displays Annotations on the chart</li>
 &lt;/head&gt;
 &lt;body&gt;
 &lt;div id=&quot;graphdiv4&quot;
-  style=&quot;width:600px; height:300px;&quot;&gt;&lt;/div&gt;
+  style=&quot;width:480px; height:320px;&quot;&gt;&lt;/div&gt;
 &lt;script type=&quot;text/javascript&quot;&gt;
   g4 = new Dygraph(
     document.getElementById(&quot;graphdiv4&quot;),
         </div>
         <div class="codeoutput" style="float:left;">
           <h3 style="text-align:center">OUTPUT</h3>
-          <div id="graphdiv4" style="width:600px; height:300px;"></div>
+          <div id="graphdiv4" style="width:480px; height:320px;"></div>
           <script type="text/javascript">
             g4 = new Dygraph(
               document.getElementById("graphdiv4"),
 
       <p>The dygraphs library relies heavily on the HTML5 <code>&lt;canvas&gt;</code> tag, which Microsoft Internet Explorer did not traditionally support. To use Microsoft's native canvas implementation in IE9, you need to set an HTML5 doctype on your page:</p>
 
-      <pre>
-      &lt;!DOCTYPE html&gt; 
-      </pre>
+<pre>
+&lt;!DOCTYPE html&gt;
+</pre>
 
       <p>When IE9 is in HTML5 mode, dygraphs works just like in other modern browsers.</p>
 
-      <p>If you want to support previous versions of Internet Explorer (IE6&ndash;IE8), you'll need to include the <a href="http://code.google.com/p/explorercanvas/">excanvas</a> library, which emulates the <code>&lt;canvas&gt;</code> tag using VML. You can add excanvas by including this snippet:</p>
+      <p>If you want to support previous versions of Internet Explorer (IE6&ndash;IE8), you'll need to include the <a href="http://code.google.com/p/explorercanvas/">excanvas</a> library, which emulates the <code>&lt;canvas&gt;</code> tag using VML. You can add excanvas by including the following snippet:</p>
 
 <pre>
-&lt;head&gt;
-  &lt;!--[if IE]&gt;&lt;script src="excanvas.js"&gt;&lt;/script&gt;&lt;![endif]--&gt;
-&lt;/head&gt;
+&lt;!DOCTYPE html&gt; 
+&lt;html&gt;
+  &lt;head&gt;
+    &lt;meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7; IE=EmulateIE9"&gt; 
+    &lt;!--[if IE]&gt;&lt;script src="path/to/excanvas.js"&gt;&lt;/script&gt;&lt;![endif]--&gt;
+  &lt;/head&gt;
 </pre>
 
-    <p>While this sounds like it would be slow, it works well in practice for most charts.</p>
+<p>(This is surprisingly tricky because the HTML5 doctype breaks excanvas in IE8. See <a href="https://groups.google.com/group/dygraphs-users/browse_thread/thread/c60709e04bc7fe5f#">this discussion</a> for details. Note that the &lt;meta http-equiv&hellip;&gt; line must appear <i>first</i> in the &lt;head&gt; section for this to work properly.)</p>
+
+    <p>While VML emulation sounds like it would be slow, it works well in practice for most charts.</p>
 
     <p>One common gotcha to look out for: make sure you don't have any trailing commas in parameter lists, e.g.</p>
 
@@ -385,6 +414,13 @@ new Dygraph(el, data, {
 
     <p>Most browsers will ignore the trailing comma, but it will break under IE.</p>
 
+    <p>You may also need to delay instantiating any dygraphs until after the DOM
+    content is ready, as there have been some <a
+      href="https://groups.google.com/d/topic/dygraphs-users/qPX4Syx2kz8/discussion">reports</a>
+    that excanvas won't work until this happens. If you're using jQuery, this
+    means drawing your charts inside of a <code>$(function() { ... })</code>
+    block.</p>
+
     <h2 id="gviz">GViz Data</h2>
 
     <p>The <a
@@ -458,7 +494,7 @@ new Dygraph(el, data, {
 
     <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:900px; height:350px;"></div>
+    <div id="dow_chart" style="width:750px; height:350px;"></div>
     <p><b>Display: </b>
     <input type=checkbox id=0 onClick="stockchange(this)" checked>
     <label for="0"> Nominal</label>
@@ -570,25 +606,111 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)
     <p>Call org.danvk.Dygraphs.install() when your application starts to install the JavaScript code into the browser.  You can use <a href="http://code.google.com/webtoolkit/doc/latest/DevGuideCodingBasicsJSNI.html">JSNI</a> to call Dygraphs from your GWT code, as in the example below.  The example uses the <a href="http://code.google.com/p/gwt-google-apis/wiki/VisualizationGettingStarted">Visualization API for GWT</a> and the <a href="#gviz">Dygraphs GViz API.</a></p>
 
 <pre>
-  public static native JavaScriptObject drawDygraph(Element element, DataTable dataTable, double minY, double maxY) /*-{
-    var chart = new $wnd.Dygraph.GVizChart(element);
-    chart.draw(dataTable,
-      {
-        valueRange: [minY, maxY]
-      });
-    return chart;
-  }-*/;
+public static native JavaScriptObject drawDygraph(
+    Element element, DataTable dataTable, double minY, double maxY) /*-{
+  var chart = new $wnd.Dygraph.GVizChart(element);
+  chart.draw(dataTable,
+    {
+      valueRange: [minY, maxY]
+    });
+  return chart;
+}-*/;
 </pre>
 
+    <a name="users" />
+    <h2>Known Users</h2>
+    <p>Since its public release in late 2009, dygraphs has found many users
+    across the web. This is a small collection of the uses that we know about.
+    If you're using dygraphs, please send <a
+    href="mailto:dan@dygraphs.com">Dan</a> a link and he'll add it to this
+    list.</p>
+
+    <p>dygraphs was originally developed at Google and has found wide use on
+    internal dashboards and servers there. There are also a few uses of
+    dygraphs on public Google products:</p>
+
+    <ul class='padded-list'>
+    <li><a href="http://www.google.com/trends/correlate/search?e=id:20xKcnNqHrk&t=weekly">Google Correlate</a><br/>
+    <span class="desc">Uses dygraphs for time series visualization. Mostly a standard configuration, with just a few tweaks to match Google style.</span></li>
+
+    <li><a href="http://www.google.com/trends/correlate/draw?p=us">Google Correlate - Search by Drawing</a><br/>
+    <span class="desc">This is a highly customized configuration which lets the user draw a time series. Based on <a href="tests/drawing.html">this demo</a>.</span></li>
+
+    <li><a href="https://www.google.com/latitude/b/0/history/manage">Google Latitude History Dashboard</a><br/>
+    <span class="desc">Uses mouse interaction callbacks to synchronize time series points with markers on a Google Map.</span></li>
+    </ul>
+
+    <p>dygraphs has also found use in other organizations:</p>
+
+    <ul class='padded-list'>
+  <li><a
+    href="http://iswa.ccmc.gsfc.nasa.gov:8080/IswaSystemWebApp/index.jsp?i_1=388&l_1=99&t_1=316&w_1=800&h_1=400&s_1=0!3!0!ACE.B_x!ACE.B_y!ACE.B_z!">Integrated
+    Space Weather Analysis System</a> (NASA)<br/>
+  <span class="desc">&ldquo;We use [dygraphs] in the Integrated Space Weather
+    Analysis System available from the Space Weather Laboratory at NASA Goddard
+    Space Flight Center. It works quite well for time series data from various
+    missions and simulations that we store.&rdquo;</span></li>
+
+
+  <li><a href="http://www.eutelsat.fr">Eutelsat</a><br/>
+  <span class="desc">&ldquo;Eutelsat uses dygraphs for charting spacecraft
+    telemetry for a fleet of 25 geostationary satellites. The spacecraft
+    engineers are very happy with it.  All satellite combined are producing
+    about 200 millions unique data points per day so we really appreciate the
+    excellent performance of dygraphs.&rdquo;</span></li>
+
+  <li><a href="http://www.10gen.com/mongodb-monitoring-service">10gen MongoDB
+    Monitoring Service</a><br/>
+  <span class="desc">A free monitoring service for MongoDB from 10gen (the
+    creators of MongoDB). Used by thousands of servers and users. Makes use of
+    <a href="tests/synchronize.html">synchronized charts</a> to display many
+    quantities simultaneously.</span></li>
+
+  <li><a href="http://duckduckgo.com/traffic.html">Duck Duck Go Traffic Dashboard</a><br/>
+  <span class="desc">DDG uses dygraphs to display a public chart of their daily traffic. They use annotations and the moving average features.</span></li>
+
+    <li><a href="http://toolserver.org/~dartar/moodbar/">Wikimedia Foundation - Moodbar data dashboard</a><br/>
+    <span class="desc">dygraphs is used internally at Wikimedia as a handy solution to monitor the
+    results of a bunch of small experiments.</span></li>
+
+  <li><a href="http://code.google.com/p/quadrant-framework/">quadrant-framework</a> (MySQL Load Testing Framework)<br/>
+  <span class="desc">A user friendly framework for creating and visualizing
+    MySQL database load test jobs. For more information on its use of dygraphs,
+    see <a href="http://themattreid.com/wordpress/2011/05/20/quadrant-framework-rev7-update-adds-dygraphs-support/">this post</a>.</span></li>
+
+  <li><a href="http://spinwave.wordpress.com/2011/03/28/spinwave-systems-enables-energy-efficiency-case-studies/">Spinwave Systems</a> (Home energy monitoring)<br/>
+  <span class="desc">dygraphs is used to chart energy usage over time.</span></li>
+
+
+    <li><a href="http://www.socib.es/jwebchart/?file=http://thredds.socib.es/thredds/dodsC/mooring/weather_station/mobims_calamillor-scb_met001/L1/dep0001_mobims-calamillor_scb-met001_L1_latest.nc">Jwebchart</a><br/>
+    <span class="desc">
+    jWebChart is a stand-alone and Thredds' embedded plotting system for
+    netCDF files. NetCDF is a common standard for the storage and
+    distribution of scientific data.
+    </span></li>
+
+    <li><a href="http://ngrams.cavorite.com/">n-gramas - Explore las tendencias en los artículos periodísticos de Colombia.</a><br/>
+
+
+    <span class="desc">(English: "Explore trends in newspaper articles of
+    Colombia"). dygraphs is used for displaying the results of this n-grams
+    viewer.  Uses an extension for exporting the plots as PNG images
+    (<a href="http://cavorite.com/labs/js/dygraphs-export/">[1]</a>, <a href="https://github.com/cavorite/dygraphs">[2]</a>).
+    </span></li>
+
+    <li><a href="http://www.glerl.noaa.gov/data/now/wlevels/dbd/altSite.html">NOAA Great Lakes Water Level Dashboard</a><br/>
+    <span class="desc">The Great Lakes Water Level dashboard was designed to help users view, understand, and compare Great Lakes surface water elevation data and forecasts from a variety of different sources, and across a variety of time scales ranging from monthly average values, to annual and multi-decadal values. First developed in Adobe Flash, a HTML 5 compatible version has been in the works and a functional draft is available here.</span></li>
+
+    </ul>
+
+    <p>Are you using dygraphs? Please let <a href="mailto:dan@dygraphs.com">Dan</a> know and he'll add your link here!</p>
+
+
     <h2 id="policy">Data Policy</h2>
     <p>dygraphs is purely client-side JavaScript. It does not send your data to any servers &ndash; the data is processed entirely in the client's browser.</p>
 
     <p style="font-size:0.8em">Created May 9, 2008 by <a href=mailto:danvdk@gmail.com>Dan Vanderkam</a></p>
   </div>
 
-
-  <!-- Google Analytics -->
-  <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-  <script type="text/javascript">_uacct = "UA-769809-1";urchinTracker();</script>
 </body>
 </html>