JSDoc v0.2.1 4aa0693

haoming29 · Jan 1, 2023 · 47659c3 · 47659c3
1 parent d512b6b
commit 47659c3
Show file tree

Hide file tree

Showing 9 changed files with 106 additions and 10 deletions.
diff --git a/Button.html b/Button.html
@@ -282,7 +282,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Button.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 22 2022 23:29:24 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Jan 01 2023 03:02:10 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/ErrorIcon.html b/ErrorIcon.html
@@ -162,7 +162,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Button.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 22 2022 23:29:24 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Jan 01 2023 03:02:10 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/MultiStreamViewer.html b/MultiStreamViewer.html
@@ -709,7 +709,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Button.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 22 2022 23:29:24 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Jan 01 2023 03:02:10 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/MultiStreamViewer.js.html b/MultiStreamViewer.js.html
@@ -295,7 +295,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Button.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 22 2022 23:29:24 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Jan 01 2023 03:02:10 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/Viewer.html b/Viewer.html
@@ -901,6 +901,94 @@ <h4 class="name" id="draw"><span class="type-signature"></span>draw<span class="
 
 
 
+
+
+
+
+
+
+    <h4 class="name" id="unmount"><span class="type-signature"></span>unmount<span class="signature">()</span><span class="type-signature"></span></h4>
+
+
+
+
+
+
+<div class="description">
+    Remove interval and image src to close HTTP connection.
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Viewer.js.html">Viewer.js</a>, <a href="Viewer.js.html#line148">line 148</a>
+    </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 
@@ -923,7 +1011,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Button.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 22 2022 23:29:24 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Jan 01 2023 03:02:10 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/Viewer.js.html b/Viewer.js.html
@@ -99,7 +99,7 @@ <h1 class="page-title">Source: Viewer.js</h1>
     this.changeStream(this.topic);
 
     // call draw with the given interval or rate
-    setInterval(this.draw.bind(this), drawInterval);
+    this.timer = setInterval(this.draw.bind(this), drawInterval);
   }
 
   /**
@@ -169,6 +169,14 @@ <h1 class="page-title">Source: Viewer.js</h1>
     // emit an event for the change
     this.emit('change', topic);
   }
+
+  /**
+   * Remove interval and image src to close HTTP connection.
+   */
+  unmount() {
+    clearInterval(this.timer);
+    this.image.src = '';
+  }
 }
 
 export default Viewer;
@@ -188,7 +196,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Button.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 22 2022 23:29:24 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Jan 01 2023 03:02:10 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/index.html b/index.html
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Button.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 22 2022 23:29:24 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Jan 01 2023 03:02:10 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/models_Button.js.html b/models_Button.js.html
@@ -92,7 +92,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Button.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 22 2022 23:29:24 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Jan 01 2023 03:02:10 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/models_ErrorIcon.js.html b/models_ErrorIcon.js.html
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Button.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 22 2022 23:29:24 GMT+0000 (Coordinated Universal Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Jan 01 2023 03:02:10 GMT+0000 (Coordinated Universal Time)
 </footer>
 
 <script> prettyPrint(); </script>