lcars-library-node
Version:
NodeJS module for creating a library for the LCARS dashboard system
660 lines (406 loc) • 17.1 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Element - 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>Element Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/library_elements_element.js.html#l38"><code>library\elements\element.js:38</code></a>
</div>
Module: <a href="../modules/Elements.html">Elements</a>
</div>
<div class="box intro">
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Element" class="method item">
<h3 class="name"><code>Element</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_elements_element.js.html#l38"><code>library\elements\element.js:38</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 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 properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property">
<a href="#property_active">active</a>
</li>
<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_distress">distress</a>
</li>
<li class="index-item property">
<a href="#property_distress">distress</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_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_removed">removed</a>
</li>
<li class="index-item property">
<a href="#property_status">status</a>
</li>
<li class="index-item property">
<a href="#property_subtype">subtype</a>
</li>
<li class="index-item property">
<a href="#property_type">type</a>
</li>
</ul>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_active" class="property item">
<h3 class="name"><code>active</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_element.js.html#l118"><code>library\elements\element.js:118</code></a>
</p>
</div>
<div class="description">
<p>Indicates if the element should be considered active.</p>
<p>This does <em>NOT</em> affect it's availability for querying or graph linking,
this is simply an extension of the status.</p>
<p>An example would be taking a server offline for maintenance.</p>
<p>See for making an
element unavailable to searches and linking.</p>
</div>
</div>
<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_element.js.html#l163"><code>library\elements\element.js:163</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_element.js.html#l156"><code>library\elements\element.js:156</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_element.js.html#l83"><code>library\elements\element.js:83</code></a>
</p>
</div>
<div class="description">
<p>Markdown style string describing the element.</p>
</div>
</div>
<div id="property_distress" class="property item">
<h3 class="name"><code>distress</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_element.js.html#l97"><code>library\elements\element.js:97</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_distress" class="property item">
<h3 class="name"><code>distress</code></h3>
<span class="type"><a href="../classes/Distress.html" class="crosslink">Distress</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_element.js.html#l142"><code>library\elements\element.js:142</code></a>
</p>
</div>
<div class="description">
</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_element.js.html#l149"><code>library\elements\element.js:149</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_elements_element.js.html#l69"><code>library\elements\element.js:69</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_element.js.html#l177"><code>library\elements\element.js:177</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_element.js.html#l170"><code>library\elements\element.js:170</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_element.js.html#l76"><code>library\elements\element.js:76</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_removed" class="property item">
<h3 class="name"><code>removed</code></h3>
<span class="type">Boolean</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_element.js.html#l133"><code>library\elements\element.js:133</code></a>
</p>
</div>
<div class="description">
<p>When true, this element is no longer used when calculating support/dependency
trees or event propagation, but it will still appear in searches and show in
exploratory graphs and searches.</p>
</div>
</div>
<div id="property_status" class="property item">
<h3 class="name"><code>status</code></h3>
<span class="type">Number</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_element.js.html#l90"><code>library\elements\element.js:90</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_subtype" class="property item">
<h3 class="name"><code>subtype</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_element.js.html#l111"><code>library\elements\element.js:111</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_type" class="property item">
<h3 class="name"><code>type</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_element.js.html#l104"><code>library\elements\element.js:104</code></a>
</p>
</div>
<div class="description">
</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>