finished JS API

docs/_build_html/_sources/clustergrammer_js.rst.txt

@@ -112,6 +112,10 @@ Clustergrammer-JS API
 
     :param row_data: Row category data.
 
+  .. js:function:: reset_cats()
+
+    Reset the row categories to their original state.
+
   .. js:function:: resize_viz:
 
     Call this function to resize the visualization to fit in its resized container (if the user has resized the container).
@@ -128,6 +132,31 @@ Clustergrammer-JS API
 
     :param inst_state: The value of the row filter, e.g. 500
 
+  .. js:function:: filter_viz_using_names(names)
+
+    Update the visualization to show the row and column names specified in the names object.
+
+    :param names: Object with ``row`` and ``col`` attributes that specify the row and column names that will be visible after updating.
+
+  .. js:function:: filter_viz_using_names(nodes)
+
+    Update the visualization to show the row and column names specified in the nodes object.
+
+    :param names: Object with ``row`` and ``col`` attributes that specify the row and column nodes that will be visible after updating.
+
+  .. js:function:: zoom(pan_x, pan_y, zoom)
+
+    Zoom and pan into the visualization.
+
+    :param pan_x: Panning in the `x` direction
+
+    :param pan_y: Panning in the `y` direction
+
+    :param zoom: The zoom level applied to the visualization.
+
+  .. js:function:: export_matrix()
+
+    Save the current matrix (e.g. after cropping) as a tab-separated-file.
 
 
 .. _visualization_json:

docs/_build_html/clustergrammer_js.html

@@ -284,6 +284,12 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="reset_cats">
+<code class="descname">reset_cats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#reset_cats" title="Permalink to this definition">¶</a></dt>
+<dd><p>Reset the row categories to their original state.</p>
+</dd></dl>
+
 <dl class="function">
 <dt id="resize_viz:">
 <code class="descname">resize_viz:</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#resize_viz:" title="Permalink to this definition">¶</a></dt>
@@ -314,6 +320,65 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="filter_viz_using_names">
+<code class="descname">filter_viz_using_names</code><span class="sig-paren">(</span><em>names</em><span class="sig-paren">)</span><a class="headerlink" href="#filter_viz_using_names" title="Permalink to this definition">¶</a></dt>
+<dd><p>Update the visualization to show the row and column names specified in the names object.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
+<li><strong>names</strong> &#8211; Object with <code class="docutils literal"><span class="pre">row</span></code> and <code class="docutils literal"><span class="pre">col</span></code> attributes that specify the row and column names that will be visible after updating.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt>
+<code class="descname">filter_viz_using_names</code><span class="sig-paren">(</span><em>nodes</em><span class="sig-paren">)</span></dt>
+<dd><p>Update the visualization to show the row and column names specified in the nodes object.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
+<li><strong>names</strong> &#8211; Object with <code class="docutils literal"><span class="pre">row</span></code> and <code class="docutils literal"><span class="pre">col</span></code> attributes that specify the row and column nodes that will be visible after updating.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="zoom">
+<code class="descname">zoom</code><span class="sig-paren">(</span><em>pan_x</em>, <em>pan_y</em>, <em>zoom</em><span class="sig-paren">)</span><a class="headerlink" href="#zoom" title="Permalink to this definition">¶</a></dt>
+<dd><p>Zoom and pan into the visualization.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
+<li><strong>pan_x</strong> &#8211; Panning in the <cite>x</cite> direction</li>
+<li><strong>pan_y</strong> &#8211; Panning in the <cite>y</cite> direction</li>
+<li><strong>zoom</strong> &#8211; The zoom level applied to the visualization.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="export_matrix">
+<code class="descname">export_matrix</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#export_matrix" title="Permalink to this definition">¶</a></dt>
+<dd><p>Save the current matrix (e.g. after cropping) as a tab-separated-file.</p>
+</dd></dl>
+
 </dd></dl>
 
 </div>

docs/_build_html/genindex.html

@@ -156,6 +156,7 @@ <h1 id="index">Index</h1>
  | <a href="#S"><strong>S</strong></a>
  | <a href="#U"><strong>U</strong></a>
  | <a href="#W"><strong>W</strong></a>
+ | <a href="#Z"><strong>Z</strong></a>
 
 </div>
 <h2 id="A">A</h2>
@@ -216,10 +217,12 @@ <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="clustergrammer_py.html#clustergrammer_py.Network.enrichr">enrichr() (clustergrammer_py.Network method)</a>
+</li>
+      <li><a href="clustergrammer_py.html#clustergrammer_py.Network.export_df">export_df() (clustergrammer_py.Network method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="clustergrammer_py.html#clustergrammer_py.Network.export_df">export_df() (clustergrammer_py.Network method)</a>
+      <li><a href="clustergrammer_js.html#export_matrix">export_matrix() (built-in function)</a>
 </li>
       <li><a href="clustergrammer_py.html#clustergrammer_py.Network.export_net_json">export_net_json() (clustergrammer_py.Network method)</a>
 </li>
@@ -231,11 +234,13 @@ <h2 id="F">F</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="clustergrammer_py.html#clustergrammer_py.Network.filter_N_top">filter_N_top() (clustergrammer_py.Network method)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="clustergrammer_py.html#clustergrammer_py.Network.filter_sum">filter_sum() (clustergrammer_py.Network method)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="clustergrammer_py.html#clustergrammer_py.Network.filter_threshold">filter_threshold() (clustergrammer_py.Network method)</a>
+</li>
+      <li><a href="clustergrammer_js.html#filter_viz_using_names">filter_viz_using_names() (built-in function)</a>, <a href="clustergrammer_js.html#filter_viz_using_names">[1]</a>
 </li>
   </ul></td>
 </tr></table>
@@ -299,6 +304,8 @@ <h2 id="R">R</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="clustergrammer_js.html#reset_cats">reset_cats() (built-in function)</a>
+</li>
       <li><a href="clustergrammer_js.html#resize_viz:">resize_viz:() (built-in function)</a>
 </li>
   </ul></td>
@@ -338,6 +345,14 @@ <h2 id="W">W</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="Z">Z</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="clustergrammer_js.html#zoom">zoom() (built-in function)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 
 
            </div>

docs/clustergrammer_js.rst

@@ -112,6 +112,10 @@ Clustergrammer-JS API
 
     :param row_data: Row category data.
 
+  .. js:function:: reset_cats()
+
+    Reset the row categories to their original state.
+
   .. js:function:: resize_viz:
 
     Call this function to resize the visualization to fit in its resized container (if the user has resized the container).
@@ -128,6 +132,31 @@ Clustergrammer-JS API
 
     :param inst_state: The value of the row filter, e.g. 500
 
+  .. js:function:: filter_viz_using_names(names)
+
+    Update the visualization to show the row and column names specified in the names object.
+
+    :param names: Object with ``row`` and ``col`` attributes that specify the row and column names that will be visible after updating.
+
+  .. js:function:: filter_viz_using_names(nodes)
+
+    Update the visualization to show the row and column names specified in the nodes object.
+
+    :param names: Object with ``row`` and ``col`` attributes that specify the row and column nodes that will be visible after updating.
+
+  .. js:function:: zoom(pan_x, pan_y, zoom)
+
+    Zoom and pan into the visualization.
+
+    :param pan_x: Panning in the `x` direction
+
+    :param pan_y: Panning in the `y` direction
+
+    :param zoom: The zoom level applied to the visualization.
+
+  .. js:function:: export_matrix()
+
+    Save the current matrix (e.g. after cropping) as a tab-separated-file.
 
 
 .. _visualization_json: