comty/out/global.html
2020-08-31 02:58:06 +02:00

2762 lines
29 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</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">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="time"><span class="type-signature">(constant) </span>time<span class="type-signature"></span></h4>
<div class="description">
Handle time basic functions
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line218">line 218</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="arrayRemoveByID"><span class="type-signature"></span>arrayRemoveByID<span class="signature">(array, id)</span><span class="type-signature"></span></h4>
<div class="description">
Remove an element by id from an array
</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>array</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line165">line 165</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
array
</div>
<h4 class="name" id="arrayRemoveByKEY"><span class="type-signature"></span>arrayRemoveByKEY<span class="signature">(array, key)</span><span class="type-signature"></span></h4>
<div class="description">
Remove an element by key from an array
</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>array</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line177">line 177</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
array
</div>
<h4 class="name" id="arrayToObject"><span class="type-signature"></span>arrayToObject<span class="signature">(object)</span><span class="type-signature"></span></h4>
<div class="description">
Object to array scheme RSA-YCORE-ARRAYPROTO.2
</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>object</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line120">line 120</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
array
</div>
<h4 class="name" id="arrayToTree"><span class="type-signature"></span>arrayToTree<span class="signature">(array, id, parentId, children)</span><span class="type-signature"> &rarr; {array}</span></h4>
<div class="description">
Convert an array to a tree-structured array.
</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>array</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">The Array need to Converted.</td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The alias of the unique ID of the object in the array.</td>
</tr>
<tr>
<td class="name"><code>parentId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The alias of the parent ID of the object in the array.</td>
</tr>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The alias of children of the object in the array.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line262">line 262</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Return a tree-structured array.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
<h4 class="name" id="booleanFix"><span class="type-signature"></span>booleanFix<span class="signature">(e)</span><span class="type-signature"></span></h4>
<div class="description">
Global fix for convert '1, 0' to string boolean 'true, false'
</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>e</code></td>
<td class="type">
<span class="param-type">int</span>
</td>
<td class="description last">Numeric boolean reference</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line189">line 189</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
bool
</div>
<h4 class="name" id="downloadEncodedURI"><span class="type-signature"></span>downloadEncodedURI<span class="signature">(payload)</span><span class="type-signature"></span></h4>
<div class="description">
Generate a download with encoded uri
</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>payload</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Generation Data</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line57">line 57</a>
</li></ul></dd>
</dl>
<h4 class="name" id="objectLast"><span class="type-signature"></span>objectLast<span class="signature">(array)</span><span class="type-signature"></span></h4>
<div class="description">
Return the last object from array
</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>array</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line84">line 84</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
object
</div>
<h4 class="name" id="objectRemoveByID"><span class="type-signature"></span>objectRemoveByID<span class="signature">(object, id)</span><span class="type-signature"></span></h4>
<div class="description">
Remove an element by id from an object array
</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>object</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line138">line 138</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
array
</div>
<h4 class="name" id="objectRemoveByKEY"><span class="type-signature"></span>objectRemoveByKEY<span class="signature">(object, key)</span><span class="type-signature"></span></h4>
<div class="description">
Remove an element by key from an object array
</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>object</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line151">line 151</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
array
</div>
<h4 class="name" id="objectToArray"><span class="type-signature"></span>objectToArray<span class="signature">(object)</span><span class="type-signature"></span></h4>
<div class="description">
Object to array scheme RSA-YCORE-ARRAYPROTO.2
</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>object</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line96">line 96</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
array
</div>
<h4 class="name" id="queryAncestors"><span class="type-signature"></span>queryAncestors<span class="signature">(array, current, parentId, id)</span><span class="type-signature"> &rarr; {array}</span></h4>
<div class="description">
In an array of objects, specify an object that traverses the objects whose parent ID matches.
</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>array</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">The Array need to Converted.</td>
</tr>
<tr>
<td class="name"><code>current</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Specify the object that needs to be queried.</td>
</tr>
<tr>
<td class="name"><code>parentId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The alias of the parent ID of the object in the array.</td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The alias of the unique ID of the object in the array.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line321">line 321</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Return a key array.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
<h4 class="name" id="queryArray"><span class="type-signature"></span>queryArray<span class="signature">(array, key, value)</span><span class="type-signature"> &rarr; {object|undefined}</span></h4>
<div class="description">
Query objects that specify keys and values in an array where all values are objects.
</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>array</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">An array where all values are objects, like [{key:1},{key:2}].</td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The key of the object that needs to be queried.</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The value of the object that needs to be queried.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line247">line 247</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Return frist object when query success.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
|
<span class="param-type">undefined</span>
</dd>
</dl>
<h4 class="name" id="queryLayout"><span class="type-signature"></span>queryLayout<span class="signature">(layouts, pathname)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Query which layout should be used for the current path based on the configuration.
</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>layouts</code></td>
<td class="type">
<span class="param-type">layouts</span>
</td>
<td class="description last">Layout configuration.</td>
</tr>
<tr>
<td class="name"><code>pathname</code></td>
<td class="type">
<span class="param-type">pathname</span>
</td>
<td class="description last">Path name to be queried.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line344">line 344</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Return frist object when query success.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="queryPathKeys"><span class="type-signature"></span>queryPathKeys<span class="signature">(array, current, parentId, id)</span><span class="type-signature"> &rarr; {array}</span></h4>
<div class="description">
In an array object, traverse all parent IDs based on the value of an object.
</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>array</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">The Array need to Converted.</td>
</tr>
<tr>
<td class="name"><code>current</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Specify the value of the object that needs to be queried.</td>
</tr>
<tr>
<td class="name"><code>parentId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The alias of the parent ID of the object in the array.</td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The alias of the unique ID of the object in the array.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line296">line 296</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Return a key array.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
<h4 class="name" id="requestFullscreen"><span class="type-signature"></span>requestFullscreen<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Request FullScreen mode
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line198">line 198</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#arrayRemoveByID">arrayRemoveByID</a></li><li><a href="global.html#arrayRemoveByKEY">arrayRemoveByKEY</a></li><li><a href="global.html#arrayToObject">arrayToObject</a></li><li><a href="global.html#arrayToTree">arrayToTree</a></li><li><a href="global.html#booleanFix">booleanFix</a></li><li><a href="global.html#downloadEncodedURI">downloadEncodedURI</a></li><li><a href="global.html#objectLast">objectLast</a></li><li><a href="global.html#objectRemoveByID">objectRemoveByID</a></li><li><a href="global.html#objectRemoveByKEY">objectRemoveByKEY</a></li><li><a href="global.html#objectToArray">objectToArray</a></li><li><a href="global.html#queryAncestors">queryAncestors</a></li><li><a href="global.html#queryArray">queryArray</a></li><li><a href="global.html#queryLayout">queryLayout</a></li><li><a href="global.html#queryPathKeys">queryPathKeys</a></li><li><a href="global.html#requestFullscreen">requestFullscreen</a></li><li><a href="global.html#time">time</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sun Aug 30 2020 19:34:02 GMT+0200 (hora de verano de Europa central)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>