Files
oopt-gnpy-web-gui/docs/module-main.html

806 lines
8.2 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: main</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: main</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description"><p>main.js
The main.js library describes UI actions. like show/hide and update the HTML element with style based on user interaction.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="~closeDrawer"><span class="type-signature">(inner) </span>closeDrawer<span class="signature">(node)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Close drawer based on node/fiber/patch/service.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>node</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type of component.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line208">line 208</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~modeHighLight"><span class="type-signature">(inner) </span>modeHighLight<span class="signature">(node)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Highlight node/fiber/patch/service menu by name.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>node</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type on component.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line351">line 351</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~openDrawer"><span class="type-signature">(inner) </span>openDrawer<span class="signature">(node)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Open drawer based on node/fiber/patch/service.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>node</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The type of component.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line30">line 30</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~showHideDrawerandMenu"><span class="type-signature">(inner) </span>showHideDrawerandMenu<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Show/Hide the context menu of node/fiber/patch/service.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line499">line 499</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~stepColor"><span class="type-signature">(inner) </span>stepColor<span class="signature">(index)</span><span class="type-signature"></span></h4>
<div class="description">
<p>Highlight the steper menu by selection.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The menu index.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line296">line 296</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">oopt-gnpy-web-gui-main</a></h2><h3>Modules</h3><ul><li><a href="module-alea.html">alea</a></li><li><a href="module-constraints.html">constraints</a></li><li><a href="module-exampleUtil.html">exampleUtil</a></li><li><a href="module-fiber.html">fiber</a></li><li><a href="module-filesaver.html">filesaver</a></li><li><a href="module-main.html">main</a></li><li><a href="module-mynetwork.html">mynetwork</a></li><li><a href="module-node.html">node</a></li><li><a href="module-patch.html">patch</a></li><li><a href="module-service.html">service</a></li><li><a href="module-validation.html">validation</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-LICENSE.html">LICENSE</a></li><li><a href="tutorial-technical_document.html">technical_document</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Wed Jul 06 2022 19:21:36 GMT+0530 (India Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>