doc/global.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">Type Definitions</h3>
<h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">($elements)</span><span class="type-signature"> → {jQuery}</span></h4>
<div class="description">
Frees up the space of the data
</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>$elements</code></td>
<td class="type">
<span class="param-type">jQuery</span>
</td>
<td class="description last">The jQuery collection to work with</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jquery.auderoContextMenu.js.html">jquery.auderoContextMenu.js</a>, <a href="jquery.auderoContextMenu.js.html#line63">line 63</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">jQuery</span>
</dd>
</dl>
<h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">($elements, options)</span><span class="type-signature"> → {jQuery}</span></h4>
<div class="description">
Initializes the plugin
</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>$elements</code></td>
<td class="type">
<span class="param-type">jQuery</span>
</td>
<td class="description last">The jQuery collection to work with</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><a href="global.html#SettingsHash">SettingsHash</a></span>
|
<span class="param-type">string</span>
</td>
<td class="description last">An object of options or the ID of the menu to show</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jquery.auderoContextMenu.js.html">jquery.auderoContextMenu.js</a>, <a href="jquery.auderoContextMenu.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">jQuery</span>
</dd>
</dl>
<h4 class="name" id="MethodsHash">MethodsHash</h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>init</code></td>
<td class="type">
<span class="param-type"><a href="global.html#init">init</a></span>
</td>
<td class="description last">The method to initialize the plugin</td>
</tr>
<tr>
<td class="name"><code>destroy</code></td>
<td class="type">
<span class="param-type"><a href="global.html#destroy">destroy</a></span>
</td>
<td class="description last">The method to free the space of the data</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jquery.auderoContextMenu.js.html">jquery.auderoContextMenu.js</a>, <a href="jquery.auderoContextMenu.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id="SettingsHash">SettingsHash</h4>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>idMenu</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
null
</td>
<td class="description last">The ID of the menu to show</td>
</tr>
<tr>
<td class="name"><code>posX</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
<nullable><br>
</td>
<td class="default">
null
</td>
<td class="description last">The X coordinate used to show the menu</td>
</tr>
<tr>
<td class="name"><code>posY</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
<nullable><br>
</td>
<td class="default">
null
</td>
<td class="description last">The Y coordinate used to show the menu</td>
</tr>
<tr>
<td class="name"><code>bindLeftClick</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">If the menu is shown when the left button of the mouse is clicked</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jquery.auderoContextMenu.js.html">jquery.auderoContextMenu.js</a>, <a href="jquery.auderoContextMenu.js.html#line29">line 29</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Externals</h3><ul><li><a href="external-_jQuery.fn_.html">jQuery.fn</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sun Jan 24 2016 23:36:30 GMT+0000 (GMT Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>