Updated noZoomFlagChange related documentation.

[dygraphs.git] / docs / index.html

diff --git a/docs/index.html b/docs/index.html
index e06f7e9..9e652b5 100644 (file)
--- a/docs/index.html
+++ b/docs/index.html
@@ -527,6 +527,17 @@ new Dygraph(el, data, {
 
     <p>The <a href="tests/zoom.html">Tests for zoom operations</a> show a full example of this in action.</p>
 
+    <h3>Programmatic Zoom</h3>
+    <p>
+      When a chart is programmatically zoomed by updating either the <code>dateWindow</code>
+      or <code>valueRange</code> option, by default the zoomed flags are also updated correspondingly.
+      It is possible to prevent this by specifying the <code>noZoomFlagChange</code> in the same
+      call to the <code>updateOptions</code> method.
+    </p>
+    <p>
+      The <a href="tests/no-zoom-change.html">no-zoom-change</a> test shows this in operation.
+    </p>
+
     <h2 id="stock">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>
@@ -736,6 +747,13 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)
           </td>
         </tr>
         <tr>
+          <td colspan="4">
+            Changing either of two the above options will cause the corresponding zoom
+            flag (<code>isZoomed()</code>) to be set, unless the <code>noZoomFlagChange</code>
+            option is also specified.
+          </td>
+        </tr>
+        <tr>
           <td><strong>labelsSeparateLines</strong></td>
           <td><code>boolean</code></td>
           <td><code>false</code></td>
@@ -1027,15 +1045,6 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)
         </tr>
 
         <tr>
-<<<<<<< HEAD
-          <td><strong>noZoomFlagChange</strong></td>
-          <td><code></code></td>
-          <td><code></code></td>
-          <td>
-            When this flag is passed along with either the <code>dateWindow</code> or <code>valueRange</code> options, the zoom flags are not changed to reflect a zoomed state.
-            This is primarily useful for when the display area of a chart is changed programmatically and also where manual zooming is allowed and use is made of the <code>isZoomed</code> method to determine this.
-            <div class="tests">Tests: <a href="tests/no-zoom-change.html">no-zoom-change</a></div>
-=======
           <td><strong>logscale</strong></td>
           <td><code>boolean</code></td>
           <td><code>false</code></td>
@@ -1048,10 +1057,18 @@ perl -ne 'BEGIN{print "Month,Nominal,Real\n"} chomp; ($m,$cpi,$low,$close,$high)
 
             <div class="tests">Tests: <a href="tests/logscale.html">logscale</a>,
             <a href="tests/stock.html"> stock</div>
->>>>>>> a6a505d1759f087a1e29ad84fc8510aa4cbc4f6e
           </td>
         </tr>
 
+        <tr>
+          <td><strong>noZoomFlagChange</strong></td>
+          <td><code></code></td>
+          <td><code></code></td>
+          <td>
+            When this flag is passed along with either the <code>dateWindow</code> or <code>valueRange</code> options, the zoom flags are not changed to reflect a zoomed state.
+            This is primarily useful for when the display area of a chart is changed programmatically and also where manual zooming is allowed and use is made of the <code>isZoomed</code> method to determine this.
+            <div class="tests">Tests: <a href="tests/no-zoom-change.html">no-zoom-change</a></div>
+        </tr>
       </tbody>
     </table>