docs: add properties to Graph and re-generate and publish

julie-ng · Jun 20, 2019 · 246ae06 · 246ae06
1 parent 4695720
commit 246ae06
Show file tree

Hide file tree

Showing 17 changed files with 200 additions and 48 deletions.
diff --git a/docs/Graph.html b/docs/Graph.html
@@ -500,6 +500,147 @@ <h4 class="method-heading">Source</h4>
 
 
 
+        <h3 class="subtitle">Properties</h3>
+
+
+
+<ul class="method-params">
+
+
+    <li>
+
+            <span class="param-name">labels</span>
+
+
+
+
+
+
+    <span class="param-type">
+        <code><a href="Labels.html">Labels</a></code>
+    </span>
+
+
+
+
+
+
+
+
+        <div class="param-description">
+            <p>reference to Labels used for UI interactions</p>
+        </div>
+
+    </li>
+
+</ul>
+
+
+
+
+<ul class="method-params">
+
+
+    <li>
+
+            <span class="param-name">links</span>
+
+
+
+
+
+
+    <span class="param-type">
+        <code><a href="Links.html">Links</a></code>
+    </span>
+
+
+
+
+
+
+
+
+        <div class="param-description">
+            <p>reference to Links used for UI interactions</p>
+        </div>
+
+    </li>
+
+</ul>
+
+
+
+
+<ul class="method-params">
+
+
+    <li>
+
+            <span class="param-name">nodes</span>
+
+
+
+
+
+
+    <span class="param-type">
+        <code><a href="Nodes.html">Nodes</a></code>
+    </span>
+
+
+
+
+
+
+
+
+        <div class="param-description">
+            <p>reference to Nodes used for UI interactions</p>
+        </div>
+
+    </li>
+
+</ul>
+
+
+
+
+<ul class="method-params">
+
+
+    <li>
+
+            <span class="param-name">renders</span>
+
+
+
+
+
+
+    <span class="param-type">
+        <code>Integer</code>
+    </span>
+
+
+
+
+
+
+
+
+        <div class="param-description">
+            <p>internal counter used to help decide whether to re-render a layout</p>
+        </div>
+
+    </li>
+
+</ul>
+
+
+
+
+
         <h3 class="subtitle">Methods</h3>
 
 
@@ -730,7 +871,7 @@ <h4 class="method-heading">Parameters</h4>
     <h4 class="method-heading">Source</h4>
     <ul>
         <li class="method-source">
-            <a href="graph_graph.js.html">graph/graph.js</a><a href="graph_graph.js.html#source.263">, line 263</a>
+            <a href="graph_graph.js.html">graph/graph.js</a><a href="graph_graph.js.html#source.278">, line 278</a>
         </li>
     </ul>
 
@@ -853,7 +994,7 @@ <h4 class="method-heading">Listens to events</h4>
     <h4 class="method-heading">Source</h4>
     <ul>
         <li class="method-source">
-            <a href="graph_graph.js.html">graph/graph.js</a><a href="graph_graph.js.html#source.67">, line 67</a>
+            <a href="graph_graph.js.html">graph/graph.js</a><a href="graph_graph.js.html#source.82">, line 82</a>
         </li>
     </ul>
 
@@ -999,7 +1140,7 @@ <h4 class="method-heading">Parameters</h4>
     <h4 class="method-heading">Source</h4>
     <ul>
         <li class="method-source">
-            <a href="graph_graph.js.html">graph/graph.js</a><a href="graph_graph.js.html#source.235">, line 235</a>
+            <a href="graph_graph.js.html">graph/graph.js</a><a href="graph_graph.js.html#source.250">, line 250</a>
         </li>
     </ul>
 
@@ -1101,7 +1242,7 @@ <h4 class="method-name" id="resetStyles">resetStyles<span class="signature">()</
     <h4 class="method-heading">Source</h4>
     <ul>
         <li class="method-source">
-            <a href="graph_graph.js.html">graph/graph.js</a><a href="graph_graph.js.html#source.276">, line 276</a>
+            <a href="graph_graph.js.html">graph/graph.js</a><a href="graph_graph.js.html#source.291">, line 291</a>
         </li>
     </ul>
 
@@ -1392,7 +1533,7 @@ <h4 class="method-heading">Example</h4>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/Labels.html b/docs/Labels.html
@@ -301,6 +301,8 @@ <h4 class="method-heading">Source</h4>
 
 
 
+
+
         <h3 class="subtitle">Methods</h3>
 
 
@@ -1344,7 +1346,7 @@ <h4 class="method-heading">Type</h4>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/Links.html b/docs/Links.html
@@ -308,6 +308,8 @@ <h4 class="method-heading">Source</h4>
 
 
 
+
+
         <h3 class="subtitle">Methods</h3>
 
 
@@ -1741,7 +1743,7 @@ <h4 class="method-heading">Type</h4>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/Network.html b/docs/Network.html
@@ -305,6 +305,8 @@ <h4 class="method-heading">Source</h4>
 
 
 
+
+
         <h3 class="subtitle">Methods</h3>
 
 
@@ -3387,7 +3389,7 @@ <h4 class="method-heading">Listeners of this event</h4>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/Nodes.html b/docs/Nodes.html
@@ -301,6 +301,8 @@ <h4 class="method-heading">Source</h4>
 
 
 
+
+
         <h3 class="subtitle">Methods</h3>
 
 
@@ -2057,7 +2059,7 @@ <h4 class="method-heading">Listeners of this event</h4>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/View.html b/docs/View.html
@@ -290,6 +290,8 @@ <h4 class="method-heading">Source</h4>
 
 
 
+
+
         <h3 class="subtitle">Methods</h3>
 
 
@@ -1127,7 +1129,7 @@ <h4 class="method-heading">Source</h4>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/d3.js.html b/docs/d3.js.html
@@ -104,7 +104,7 @@ <h1 class="page-title">d3.js</h1>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/global.html b/docs/global.html
@@ -111,12 +111,6 @@ <h1 class="page-title">Global</h1>
 
 
 
-
-
-
-
-
-
 
 
 
@@ -453,7 +447,7 @@ <h4 class="method-heading">Properties</h4>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/graph_graph.js.html b/docs/graph_graph.js.html
@@ -85,10 +85,25 @@ <h1 class="page-title">graph/graph.js</h1>
 
 		this._setNetwork(opts)
 
+		/**
+		 * @property {Labels} labels - reference to Labels used for UI interactions
+		 */
 		this.labels = new Labels()
+
+		/**
+		 * @property {Links} links - reference to Links used for UI interactions
+		 */
 		this.links = new Links()
+
+		/**
+		 * @property {Nodes} nodes - reference to Nodes used for UI interactions
+		 */
 		this.nodes = new Nodes()
 
+
+		/**
+		 * @property {Integer} renders - internal counter used to help decide whether to re-render a layout
+		 */
 		this.renders = 0
 	}
 
@@ -354,7 +369,7 @@ <h1 class="page-title">graph/graph.js</h1>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/graph_views_labels.js.html b/docs/graph_views_labels.js.html
@@ -129,7 +129,7 @@ <h1 class="page-title">graph/views/labels.js</h1>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/graph_views_links.js.html b/docs/graph_views_links.js.html
@@ -243,7 +243,7 @@ <h1 class="page-title">graph/views/links.js</h1>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/graph_views_nodes.js.html b/docs/graph_views_nodes.js.html
@@ -213,7 +213,7 @@ <h1 class="page-title">graph/views/nodes.js</h1>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/graph_views_view.js.html b/docs/graph_views_view.js.html
@@ -154,7 +154,7 @@ <h1 class="page-title">graph/views/view.js</h1>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>
 

diff --git a/docs/index.html b/docs/index.html
@@ -181,7 +181,7 @@ <h3>Preview</h3>
 
 <footer class="layout-footer">
   <div class="container">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Sun Jun 02 2019 21:55:48 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.1</a> on Thu Jun 20 2019 10:56:38 GMT+0200 (Central European Summer Time)
   </div>
 </footer>