working on JavaScript API

cornhundred · Feb 17, 2017 · 456c928 · 456c928
1 parent 982dccc
commit 456c928
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 3 deletions.
diff --git a/docs/_build_html/.doctrees/clustergrammer_js.doctree b/docs/_build_html/.doctrees/clustergrammer_js.doctree
diff --git a/docs/_build_html/.doctrees/environment.pickle b/docs/_build_html/.doctrees/environment.pickle
diff --git a/docs/_build_html/_sources/clustergrammer_js.rst.txt b/docs/_build_html/_sources/clustergrammer_js.rst.txt
@@ -62,6 +62,18 @@ Clustergrammer-JS' API allows users to pass options to the front-end visualizati
 
   :args: The visualization JSON as well as optional arguments will be passed here.
 
+    .. js:attribute:: args.network_data
+
+      This is where the visualization JSON should be passed.
+
+    .. js:attribute:: args.root
+
+      This required attribute is the ``id`` of the container where Clustergrammer will be built. Each Clustergrammer visualization in a page should be passed a unique ``id``.
+
+    .. :attribute:: args.about
+
+      This op
+
   Clustergrammer functions:
 
   .. js:function:: update_cats(row_data)

diff --git a/docs/_build_html/clustergrammer_js.html b/docs/_build_html/clustergrammer_js.html
@@ -202,7 +202,20 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Args:</th><td class="field-body">The visualization JSON as well as optional arguments will be passed here.</td>
+<tr class="field-odd field"><th class="field-name">Args:</th><td class="field-body"><p class="first">The visualization JSON as well as optional arguments will be passed here.</p>
+<dl class="attribute">
+<dt id="args.network_data">
+<code class="descclassname">args.</code><code class="descname">network_data</code><a class="headerlink" href="#args.network_data" title="Permalink to this definition">¶</a></dt>
+<dd><p>This is where the visualization JSON should be passed.</p>
+</dd></dl>
+
+<dl class="last attribute">
+<dt id="args.root">
+<code class="descclassname">args.</code><code class="descname">root</code><a class="headerlink" href="#args.root" title="Permalink to this definition">¶</a></dt>
+<dd><p>This required attribute is the <code class="docutils literal"><span class="pre">id</span></code> of the container where Clustergrammer will be built. Each Clustergrammer visualization in a page should be passed a unique <code class="docutils literal"><span class="pre">id</span></code>.</p>
+</dd></dl>
+
+</td>
 </tr>
 </tbody>
 </table>

diff --git a/docs/_build_html/genindex.html b/docs/_build_html/genindex.html
@@ -143,7 +143,8 @@
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#C"><strong>C</strong></a>
+ <a href="#A"><strong>A</strong></a>
+ | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
@@ -156,6 +157,18 @@ <h1 id="index">Index</h1>
  | <a href="#W"><strong>W</strong></a>
 
 </div>
+<h2 id="A">A</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="clustergrammer_js.html#args.network_data">args.network_data (args attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="clustergrammer_js.html#args.root">args.root (args attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>

diff --git a/docs/_build_html/objects.inv b/docs/_build_html/objects.inv
diff --git a/docs/_build_html/searchindex.js b/docs/_build_html/searchindex.js
diff --git a/docs/clustergrammer_js.rst b/docs/clustergrammer_js.rst
@@ -62,6 +62,18 @@ Clustergrammer-JS' API allows users to pass options to the front-end visualizati
 
   :args: The visualization JSON as well as optional arguments will be passed here.
 
+    .. js:attribute:: args.network_data
+
+      This is where the visualization JSON should be passed.
+
+    .. js:attribute:: args.root
+
+      This required attribute is the ``id`` of the container where Clustergrammer will be built. Each Clustergrammer visualization in a page should be passed a unique ``id``.
+
+    .. :attribute:: args.about
+
+      This op
+
   Clustergrammer functions:
 
   .. js:function:: update_cats(row_data)