lcars-library-node
Version:
NodeJS module for creating a library for the LCARS dashboard system
798 lines (503 loc) • 21 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Set - lcars-library-node</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="lcars-library-node" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.0.0</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Circulation.html">Circulation</a></li>
<li><a href="../classes/Distress.html">Distress</a></li>
<li><a href="../classes/Edge.html">Edge</a></li>
<li><a href="../classes/Element.html">Element</a></li>
<li><a href="../classes/Event.html">Event</a></li>
<li><a href="../classes/Exception.html">Exception</a></li>
<li><a href="../classes/External.html">External</a></li>
<li><a href="../classes/LCARSLibrary.html">LCARSLibrary</a></li>
<li><a href="../classes/LCARSServer.html">LCARSServer</a></li>
<li><a href="../classes/Modification.html">Modification</a></li>
<li><a href="../classes/Random.html">Random</a></li>
<li><a href="../classes/Search.html">Search</a></li>
<li><a href="../classes/Session.html">Session</a></li>
<li><a href="../classes/Set.html">Set</a></li>
<li><a href="../classes/Storage.html">Storage</a></li>
<li><a href="../classes/Terminal.html">Terminal</a></li>
<li><a href="../classes/User.html">User</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Connections.html">Connections</a></li>
<li><a href="../modules/Elements.html">Elements</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Set Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/library_space_set.js.html#l12"><code>library\space\set.js:12</code></a>
</div>
Module: <a href="../modules/Elements.html">Elements</a>
</div>
<div class="box intro">
<p>Represents the set of links that connect elements. Various collections serve different
purposes for how they connect and can inherit from one another.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Set" class="method item">
<h3 class="name"><code>Set</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>session</code>
</li>
<li class="arg">
<code>description</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_set.js.html#l12"><code>library\space\set.js:12</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">session</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">description</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_checkAccess">checkAccess</a>
</li>
<li class="index-item method">
<a href="#method_emit">emit</a>
</li>
<li class="index-item method">
<a href="#method_propagating">propagating</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property">
<a href="#property_created">created</a>
</li>
<li class="index-item property">
<a href="#property_creater">creater</a>
</li>
<li class="index-item property">
<a href="#property_description">description</a>
</li>
<li class="index-item property">
<a href="#property_fields">fields</a>
</li>
<li class="index-item property">
<a href="#property_id">id</a>
</li>
<li class="index-item property">
<a href="#property_id">id</a>
</li>
<li class="index-item property">
<a href="#property_modified">modified</a>
</li>
<li class="index-item property">
<a href="#property_modifier">modifier</a>
</li>
<li class="index-item property">
<a href="#property_name">name</a>
</li>
<li class="index-item property">
<a href="#property_private">private</a>
</li>
<li class="index-item property">
<a href="#property_touched">touched</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_checkAccess" class="method item">
<h3 class="name"><code>checkAccess</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>session</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_set.js.html#l196"><code>library\space\set.js:196</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">session</code>
<span class="type"><a href="../classes/Session.html" class="crosslink">Session</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
</div>
</div>
</div>
<div id="method_emit" class="method item">
<h3 class="name"><code>emit</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>session</code>
</li>
<li class="arg">
<code>key</code>
</li>
<li class="arg">
<code>data</code>
</li>
<li class="arg">
<code>origin</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_set.js.html#l158"><code>library\space\set.js:158</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">session</code>
<span class="type"><a href="../classes/Session.html" class="crosslink">Session</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">key</code>
<span class="type">String</span>
<div class="param-description">
<p>Identifier for the event to emit, a key prefix of "ext-" indicating
external origin is required and added automatically if omitted.</p>
</div>
</li>
<li class="param">
<code class="param-name">data</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">origin</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="throws">
<h4>Throws:</h4>
<div class="throws-description">
<span class="type">Error</span>:
<p>On access denial</p>
</div>
</div>
</div>
<div id="method_propagating" class="method item">
<h3 class="name"><code>propagating</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code>event</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_set.js.html#l186"><code>library\space\set.js:186</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type">String</span>
<div class="param-description">
<p>The Element causing the event emission from this set.</p>
</div>
</li>
<li class="param">
<code class="param-name">event</code>
<span class="type"><a href="../classes/Event.html" class="crosslink">Event</a></span>
<div class="param-description">
<p>The Event that is propagating.</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_created" class="property item">
<h3 class="name"><code>created</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l74"><code>library\elements\page.js:74</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_creater" class="property item">
<h3 class="name"><code>creater</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l67"><code>library\elements\page.js:67</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_description" class="property item">
<h3 class="name"><code>description</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l46"><code>library\elements\page.js:46</code></a>
</p>
</div>
<div class="description">
<p>Markdown style string describing the purpose of the set.</p>
</div>
</div>
<div id="property_fields" class="property item">
<h3 class="name"><code>fields</code></h3>
<span class="type">Object</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l53"><code>library\elements\page.js:53</code></a>
</p>
</div>
<div class="description">
<p>Custom fields to use to tag the set for informational purposes.</p>
</div>
</div>
<div id="property_id" class="property item">
<h3 class="name"><code>id</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l25"><code>library\elements\page.js:25</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_id" class="property item">
<h3 class="name"><code>id</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_space_set.js.html#l23"><code>library\space\set.js:23</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_modified" class="property item">
<h3 class="name"><code>modified</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l88"><code>library\elements\page.js:88</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_modifier" class="property item">
<h3 class="name"><code>modifier</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l81"><code>library\elements\page.js:81</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_name" class="property item">
<h3 class="name"><code>name</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l32"><code>library\elements\page.js:32</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_private" class="property item">
<h3 class="name"><code>private</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l39"><code>library\elements\page.js:39</code></a>
</p>
</div>
<div class="description">
<p>When true, edges in this page are considered limited to the page and not the master list.</p>
</div>
</div>
<div id="property_touched" class="property item">
<h3 class="name"><code>touched</code></h3>
<span class="type">Array | String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_page.js.html#l60"><code>library\elements\page.js:60</code></a>
</p>
</div>
<div class="description">
<p>Array of page IDs that should be considered a subgroup of this page.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>