X-Git-Url: https://adrianiainlam.tk/git/?a=blobdiff_plain;f=docs%2Findex.html;h=772ab2caaeb96cabddaabf6ff69aecd92f376d5f;hb=54425b14df388e9337a1d77876512bb60ba74c3b;hp=a36fd2e359b60cd2fd0dd498d7205e3f9cff0cc2;hpb=e17f6ca5747de4c634a9080693ea7e822ab5dd9c;p=dygraphs.git

diff --git a/docs/index.html b/docs/index.html
index a36fd2e..772ab2c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -23,20 +23,30 @@
         <li><a href="#policy">Data Policy</a></li>
       </ul>
 
+      <h2>Features</h2>
+      <ul>
+        <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://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="changes.html">Contribute a change</a></li>
         <li><a href="mailto:dygraphs-users [at] googlegroups.com">Contact</a></li>
       </ul>
 
       <h2>Gallery</h2>
       <ul>
+        <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>
         <li><a href="tests/plotter.html">Equation Plotter</a></li>
         <li><a href="tests/perf.html">Performance Test</a></li>
+        <li><a href="tests/annotation.html">Annotations</a></li>
+        <li><a href="tests/annotation-gviz.html">Annotations (GViz)</a></li>
         <li><a href="tests/fillGraph.html">Filled Chart</a></li>
         <li><a href="tests/perf.html">Fractions</a></li>
         <li><a href="tests/visibility.html">Visibility</a></li>
@@ -58,7 +68,9 @@
         <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">Custom Underlay / background</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>
       </ul>
     </div>
 
@@ -110,10 +122,11 @@
       <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>Lightweight (69kb) 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>Displays Annotations on the chart</li>
         <li>Adjustable averaging period</li>
         <li>Can intelligently chart fractions</li>
         <li>Customizable click-through actions</li>
@@ -368,7 +381,15 @@ new Dygraph(el, data, {
 
     <h2 id="gviz">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>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. In
+    particular, it can be used as a drop-in replacement for the
+    AnnotatedTimeline visualization used on Google Finance and other sites. To
+    see how this works, check out the <a href="tests/annotation-gviz.html">gviz
+      annotation demo.</a></p>
 
     <p>For a simple demonstration of how to use dygraphs a GViz visualization, see <a href="http://danvk.org/dygraphs/tests/gviz.html">http://danvk.org/dygraphs/tests/gviz.html</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&amp;hl=en">this spreadsheet</a>. The URL for the gadget is <code><a href="http://danvk.org/dygraphs/gadget.xml">http://danvk.org/dygraphs/gadget.xml</a></code>.</p>
 
@@ -437,9 +458,38 @@ new Dygraph(el, data, {
     <label for="0"> Nominal</label>
     <input type=checkbox id=1 onClick="stockchange(this)" checked>
     <label for="1"> Real</label>
+    <input type=checkbox id=ann onClick="annotationschange(this)" checked>
+    <label for="ann"> Annotations</label>
     </p>
 
     <script type="text/javascript">
+      var stock_annotations = [
+        {
+          series: "Real",
+          x: "1929-08-15",
+          shortText: "A",
+          text: "1929 Stock Market Peak"
+        },
+        {
+          series: "Nominal",
+          x: "1987-08-15",
+          shortText: "B",
+          text: "1987 Crash"
+        },
+        {
+          series: "Nominal",
+          x: "1999-12-15",
+          shortText: "C",
+          text: "1999 (.com) Peak"
+        },
+        {
+          series: "Nominal",
+          x: "2007-10-15",
+          shortText: "D",
+          text: "All-Time Market Peak"
+        }
+      ];
+
     // From http://www.econstats.com/eqty/eq_d_mi_3.csv
       stockchart = new Dygraph(
         document.getElementById('dow_chart'),
@@ -447,13 +497,25 @@ new Dygraph(el, data, {
         {
           showRoller: true,
           customBars: true,
-          labelsKMB: true
+          labelsKMB: true,
+          drawCallback: function(g, is_initial) {
+            if (!is_initial) return;
+            g.setAnnotations( stock_annotations );
+          }
         }
       );
 
       function stockchange(el) {
         stockchart.setVisibility(el.id, el.checked);
       }
+
+      function annotationschange(el) {
+        if (el.checked) {
+          stockchart.setAnnotations(stock_annotations);
+        } else {
+          stockchart.setAnnotations([]);
+        }
+      }
     </script>
 <!--
 
@@ -475,356 +537,9 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)
 
     <h2 id="options">Other Options</h2>
 
-    <p>These are the options that can be passed in through the optional third parameter of the Dygraph constructor. Under each option is a set of links to tests which demonstrate its use. While we attempt to keep this list up-to-date, a more complete list can be found in the <code>Dygraph.DEFAULT_ATTRS</code> map in <code>dygraph.js</code> and the <code>this.options</code> map in <code>dygraph-canvas.js</code>.</p>
-
-    <table class="thinborder" width="900">
-      <thead>
-        <tr>
-          <th width="150">Name</th>
-          <th width="200">Values</th>
-          <th width="150">Default</th>
-          <th>Description</th>
-        </tr>
-      </thead>
-      <tbody>
-        <tr>
-          <td><strong>includeZero</strong></td>
-          <td><code>boolean</code></td>
-          <td><code>false</code></td>
-        <td>Usually, dygraphs will use the range of the data plus some padding to set the range of the y-axis. If this option is set, the y-axis will always include zero, typically as the lowest value. This can be used to avoid exaggerating the variance in the data.
-        <div class="tests">Tests: <a href="tests/no-range.html">no-range</a> <a href="tests/numeric-gviz.html">numeric-gviz</a> <a href="tests/small-range-zero.html">small-range-zero</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>rollPeriod</strong></td>
-          <td><code>integer &gt;= 1</code></td>
-          <td><code>1</code></td>
-          <td>Number of days over which to average data. Discussed extensively above.
-        <div class="tests">Tests: <a href="tests/demo.html">demo</a> <a href="tests/two-series.html">two-series</a> <a href="tests/noise.html">noise</a> </div>
-        </td>
-        </tr>
-        <tr>
-          <td><strong>showRoller</strong></td>
-          <td><code>boolean</code></td>
-          <td><code>false</code></td>
-          <td>If the rolling average period text box should be shown.
-          <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> <a href="tests/fractions.html">fractions</a> <a href="tests/isolated-points.html">isolated-points</a> <a href="tests/numeric-gviz.html">numeric-gviz</a> <a href="tests/underlay-callback.html">underlay-callback</a> <a href="tests/highlighted-region.html">highlighted-region</a></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>colors</strong></td>
-          <td><code>['red', '#00FF00']</code></td>
-          <td><code></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.
-          <div class="tests">Tests: <a href="tests/color-visibility.html">color-visibility</a> <a href="tests/demo.html">demo</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>fillGraph</strong></td>
-          <td><code>boolean<br/></code></td>
-          <td><code>false</code></td>
-          <td>Should the area underneath the graph be filled? This option is not
-          compatible with error bars.
-          <div class="tests">Tests: <a href="tests/fillGraph.html">fillGraph</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>visibility</strong></td>
-          <td><code>Array of booleans<br/></code></td>
-          <td><code>[true, true, ...]</code></td>
-          <td>Which series should initially be visible? Once the Dygraph has
-          been constructed, you can access and modify the visibility of each
-          series using the <code>visibility</code> and
-          <code>setVisibility</code> methods.
-          <div class="tests">Tests: <a href="tests/visibility.html">visibility</a> <a href="tests/color-visibility.html">color-visibility</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>colorSaturation</strong></td>
-          <td><code>0.0 - 1.0</code></td>
-          <td><code>1.0</code></td>
-          <td>If <strong>colors</strong> is not specified, saturation of the automatically-generated data series colors.
-          <div class="tests">Tests: <font color=red>none</font></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>colorValue</strong></td>
-          <td><code>float (0.0 &mdash; 1.0)</code></td>
-          <td><code>1.0</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)
-          <div class="tests">Tests: <font color=red>none</font></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>clickCallback</strong></td>
-          <td><code>function(e, date){<br>&nbsp;&nbsp;&nbsp;&nbsp;alert(date);<br>}</code></td>
-          <td><code>null</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)
-          <div class="tests">Tests: <a href="tests/callback.html">callback</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>zoomCallback</strong></td>
-          <td><code>function(minDate,<br/>maxDate){}</code></td>
-          <td><code>null</code></td>
-          <td>A function to call when the zoom window is changed (either by zooming in or out). minDate and maxDate are milliseconds since epoch.
-          <div class="tests">Tests: <a href="tests/callback.html">callback</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>strokeWidth</strong></td>
-          <td><code>integer</code></td>
-          <td><code>1</code></td>
-          <td>Width of the data lines. This can be used to increase the contrast or some graphs.
-          <div class="tests">Tests: <font color=red>none</font></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>dateWindow</strong></td>
-          <td><code>[<br>&nbsp;&nbsp;Date.parse('2006-01-01'),<br>&nbsp;&nbsp;(new Date()).valueOf()<br>]</code></td>
-          <td rowspan="2"><code>Full range of the<br/> input is shown</code></td>
-          <td>Initially zoom in on a section of the graph. Is of the form [earliest, latest], where earliest/latest are milliseconds since epoch.
-          <div class="tests">Tests: <a href="tests/dateWindow.html">dateWindow</a> <a href="tests/link-interaction.html">link-interaction</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>valueRange</strong></td>
-          <td><code>[10, 110]</code></td>
-          <td>Explicitly set the vertical range of the graph to [low, high].
-          <div class="tests">Tests: <font color=red>none</font></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>labelsSeparateLines</strong></td>
-          <td><code>boolean</code></td>
-          <td><code>false</code></td>
-          <td>Put <code>&lt;br/&gt;</code> between lines in the label string. Often used in conjunction with <strong>labelsDiv</strong>.
-          <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> <a href="tests/demo.html">demo</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>labelsDiv</strong></td>
-          <td><code>document.<br/>getElementById('foo')</code></td>
-          <td><code>null</code></td>
-          <td>Show data labels in an external div, rather than on the graph.
-          <div class="tests">Tests: <a href="tests/demo.html">demo</a> <a href="tests/label-div.html">label-div</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>labelsKMB</strong></td>
-          <td><code>true</code></td>
-          <td><code>false</code></td>
-          <td>Show K/M/B for thousands/millions/billions on y-axis.
-          <div class="tests">Tests: <a href="tests/demo.html">demo</a> <a href="tests/labelsKMB.html">labelsKMB</a> <a href="tests/no-range.html">no-range</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>labelsKMG2</strong></td>
-          <td><code>true</code></td>
-          <td><code>false</code></td>
-          <td>Show k/M/G for kilo/Mega/Giga on y-axis. This is different than
-          <code>labelsKMB</code> in that it uses base 2, not 10.
-          <div class="tests">Tests: <a href="tests/labelsKMB.html">labelsKMB</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>labelsDivWidth</strong></td>
-          <td><code>250</code></td>
-          <td><code></code></td>
-          <td>Width (in pixels) of the div which shows information on the currently-highlighted points.
-          <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>labelsDivStyles</strong></td>
-          <td><code>{}</code></td>
-          <td><code>null</code></td>
-          <td>Additional styles to apply to the currently-highlighted points div. For example, { 'font-weight': 'bold' } will make the labels bold.
-          <div class="tests">Tests: <a href="tests/border.html">border</a> <a href="tests/customLabel.html">customLabel</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>highlightCircleSize</strong></td>
-          <td><code>integer</code></td>
-          <td><code>3</code></td>
-          <td>The size in pixels of the dot drawn over highlighted points.
-          <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>drawPoints</strong></td>
-          <td><code>boolean</code></td>
-          <td><code>false</code></td>
-          <td>Draw a small dot at each point, in addition to a line going through the point. This makes the individual data points easier to see, but can increase visual clutter in the chart.
-          <div class="tests">Tests: <a href="tests/draw-points.html">draw-points</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>pointSize</strong></td>
-          <td><code>interger</code></td>
-          <td><code>1</code></td>
-          <td>The size of the dot to draw on each point in pixels (see drawPoints). A dot is always drawn when a point is "isolated", i.e. there is a missing point on either side of it. This also controls the size of those dots.
-          <div class="tests">Tests: <font color=red>none</font></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>pixelsPerXLabel</strong></td>
-          <td rowspan="2"><code>integer</code></td>
-          <td><code>60</code></td>
-          <td rowspan="2">Number of pixels to require between each x- and y-label. Larger values will yield a sparser axis with fewer ticks.
-          <div class="tests">Tests: <a href="tests/spacing.html">spacing</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>pixelsPerYLabel</strong></td>
-          <td><code>30</code></td>
-        </tr>
-        <tr>
-          <td><strong>xAxisLabelWidth</strong></td>
-          <td rowspan="2"><code>integer</code></td>
-          <td><code></code></td>
-          <td rowspan="2">Width (in pixels) of the x- and y-axis labels.
-          <div class="tests">Tests: <a href="tests/customLabel.html">customLabel</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>yAxisLabelWidth</strong></td>
-          <td><code></code></td>
-        </tr>
-        <tr>
-          <td><strong>axisLabelFontSize</strong></td>
-          <td><code>integer</code></td>
-          <td><code>14</code></td>
-          <td>Size of the font (in pixels) to use in the axis labels, both x- and y-axis.
-          <div class="tests">Tests: <font color=red>none</font></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>xAxisLabelFormatter</strong></td>
-          <td><code>function(date, granularity)</code></td>
-          <td><code>Dygraph.dateAxisFormatter</code></td>
-          <td>Function to call to format values along the x axis.
-            <div class="tests">Tests: <a href="tests/x-axis-formatter.html">xAxisLabelFormatter</a></div>
-          </td>
-        <tr>
-          <td><strong>rightGap</strong></td>
-          <td><code>integer</code></td>
-          <td><code></code></td>
-          <td>Number of pixels to leave blank at the right edge of the Dygraph. This makes it easier to highlight the right-most data point.
-          <div class="tests">Tests: <font color=red>none</font></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>errorBars</strong></td>
-          <td><code>boolean</code></td>
-          <td><code>false</code></td>
-          <td>Does the data contain standard deviations? Setting this to true alters the input format (see above).
-          <div class="tests">Tests: <a href="tests/noise.html">noise</a> <a href="tests/customLabel.html">customLabel</a> <a href="tests/draw-points.html">draw-points</a> <a href="tests/fillGraph.html">fillGraph</a> <a href="tests/fractions.html">fractions</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>sigma</strong></td>
-          <td><code>integer</code></td>
-          <td><code></code></td>
-          <td>When errorBars is set, shade this many standard deviations above/below each point.
-          <div class="tests">Tests: <font color=red>none</font></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>fractions</strong></td>
-          <td><code>boolean</code></td>
-          <td><code>false</code></td>
-          <td>When set, attempt to parse each cell in the CSV file as "a/b", where a and b are integers. The ratio will be plotted. This allows computation of Wilson confidence intervals (see below).
-          <div class="tests">Tests: <a href="tests/fractions.html">fractions</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>wilsonInterval</strong></td>
-          <td><code>boolean</code></td>
-          <td><code>true</code></td>
-          <td>Use in conjunction with the "fractions" option. Instead of plotting +/- N standard deviations, dygraphs will compute a Wilson confidence interval and plot that. This has more reasonable behavior for ratios close to 0 or 1.
-          <div class="tests">Tests: <font color=red>none</font></div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>customBars</strong></td>
-          <td><code>boolean</code></td>
-          <td><code>false</code></td>
-          <td>When set, parse each CSV cell as "low;middle;high". Error bars will be drawn for each point between low and high, with the series itself going through middle.
-          <div class="tests">Tests: <a href="tests/custom-bars.html">custom-bars</a> <a href="tests/zero-series.html">zero-series</a> </div>
-          </td>
-        </tr>
-
-        <tr>
-          <td><strong>drawCallback</strong></td>
-          <td><code>function(dygraph, is_initial)</code></td>
-          <td><code>null</code></td>
-          <td>When set, this callback gets called every time the dygraph is drawn. This includes the initial draw, after zooming and repeatedly while panning. The first parameter is the dygraph being drawn. The second is a boolean value indicating whether this is the initial draw.
-          <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/synchronize.html">synchronize</a> </div>
-          </td>
-        </tr>
-
-        <tr>
-          <td><strong>gridLineColor</strong></td>
-          <td><code>red, blue</code></td>
-          <td><code>rgb(128,128,128)</code></td>
-          <td>The color of the gridlines.
-          <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
-          </td>
-        </tr>
-
-        <tr>
-          <td><strong>highlightCallback</strong></td>
-          <td><code>function(event, x, points)</code></td>
-          <td><code>null</code></td>
-          <td>When set, this callback gets called every time a new point is highlighted. The parameters are the JavaScript mousemove event, the x-coordinate of the highlighted points and an array of highlighted points: <code>[ {name: 'series', yval: y-value}, &hellip; ]</code>
-          <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> </div>
-          </td>
-        </tr>
-
-        <tr>
-          <td><strong>unhighlightCallback</strong></td>
-          <td><code>function(event)</code></td>
-          <td><code>null</code></td>
-          <td>When set, this callback gets called every time the user stops highlighting any point by mousing out of the graph.  The parameter is the mouseout event.
-            <div class="tests">Tests: <a href="tests/callback.html">callback</a> <a href="tests/crosshair.html">crosshair</a> </div>
-          </td>
-        </tr>
-
-        <tr>
-          <td><strong>strokeWidth</strong></td>
-          <td><code>0.5, 2.0</code></td>
-          <td><code>1.0</code></td>
-          <td>The width of the lines connecting data points.
-          <div class="tests">Tests: <a href="tests/grid_dot.html">grid_dot</a> </div>
-          </td>
-        </tr>
-
-        <tr>
-          <td><strong>width</strong></td>
-          <td rowspan="2"><code>integer</code></td>
-          <td><code>480</code></td>
-          <td rowspan="2">Width/Height (in pixels) of the chart. If the container div has been explicitly sized, these attributes will be ignored.
-          <div class="tests">Tests: <a href="tests/demo.html">demo</a> <a href="tests/link-interaction.html">link-interaction</a> <a href="tests/no-range.html">no-range</a> </div>
-          </td>
-        </tr>
-        <tr>
-          <td><strong>height</strong></td>
-          <td><code>320</code></td>
-        </tr>
-
-        <tr>
-          <td><strong>stepPlot</strong></td>
-          <td><code>boolean</code></td>
-          <td><code>false</code></td>
-          <td>
-            When set, display the graph as a step plot instead of a line plot.
-            <div class="tests">Tests: <a href="tests/steps.html">steps</a></div>
-          </td>
-        </tr>
-
-      </tbody>
-    </table>
+    <p>In addition to the options mentioned above (<code>showRoller</code>, <code>rollPeriod</code>, <code>errorBars</code>, <code>valueRange</code>), there are <i>many</i> others.</p>
+
+    <p>For a full list, see the <a href="options.html">Dygraphs Options Reference</a> page.</p>
 
     <h2>Common Gotchas</h2>