lcars-library-node
Version:
NodeJS module for creating a library for the LCARS dashboard system
716 lines (441 loc) • 18.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Edge - 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>Edge Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/library_elements_edge.js.html#l5"><code>library\elements\edge.js:5</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_Edge" class="method item">
<h3 class="name"><code>Edge</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>source</code>
</li>
<li class="arg">
<code>target</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_edge.js.html#l5"><code>library\elements\edge.js:5</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">source</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">target</code>
<span class="type">String</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_contribution">contribution</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_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_page">page</a>
</li>
<li class="index-item property">
<a href="#property_private">private</a>
</li>
<li class="index-item property">
<a href="#property_removed">removed</a>
</li>
<li class="index-item property">
<a href="#property_source">source</a>
</li>
<li class="index-item property">
<a href="#property_subtype">subtype</a>
</li>
<li class="index-item property">
<a href="#property_target">target</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_contribution" class="property item">
<h3 class="name"><code>contribution</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_edge.js.html#l61"><code>library\elements\edge.js:61</code></a>
</p>
</div>
<div class="description">
<p>When determining if an element is "in distress" or not, the contribution of all supporting
elements is considered during an update.</p>
<p>This must result in a number to be considered valid and is passed the status of the "source"
and "target" as 0: Functional, 1: Warning, 2: Exception, or 3: Deactivated .</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_edge.js.html#l131"><code>library\elements\edge.js:131</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_edge.js.html#l124"><code>library\elements\edge.js:124</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_edge.js.html#l73"><code>library\elements\edge.js:73</code></a>
</p>
</div>
<div class="description">
<p>Markdown style string describing the element.</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_edge.js.html#l117"><code>library\elements\edge.js:117</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_edge.js.html#l30"><code>library\elements\edge.js:30</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_edge.js.html#l145"><code>library\elements\edge.js:145</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_edge.js.html#l138"><code>library\elements\edge.js:138</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_edge.js.html#l37"><code>library\elements\edge.js:37</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_page" class="property item">
<h3 class="name"><code>page</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_edge.js.html#l44"><code>library\elements\edge.js:44</code></a>
</p>
</div>
<div class="description">
<p>Links exist in distinct pages that may or may not be part of the master page.
This allows resources to be expressed in different manners and for those manners to inherit
a page or not.</p>
</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_edge.js.html#l54"><code>library\elements\edge.js:54</code></a>
</p>
</div>
<div class="description">
<p>When true, this link is considered limited to the set and not the master list.</p>
</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_edge.js.html#l94"><code>library\elements\edge.js:94</code></a>
</p>
</div>
<div class="description">
<p>When true, this edge 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_source" class="property item">
<h3 class="name"><code>source</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_edge.js.html#l103"><code>library\elements\edge.js:103</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_edge.js.html#l87"><code>library\elements\edge.js:87</code></a>
</p>
</div>
<div class="description">
</div>
</div>
<div id="property_target" class="property item">
<h3 class="name"><code>target</code></h3>
<span class="type">String</span>
<div class="meta">
<p>
Defined in
<a href="../files/library_elements_edge.js.html#l110"><code>library\elements\edge.js:110</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_edge.js.html#l80"><code>library\elements\edge.js:80</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>