@jibestream-dev/jmap-device-kit
Version:
Kit for the Jibestream SDK to utilize Devices plotted in the CMS
881 lines (360 loc) • 15.7 kB
HTML
<html>
<head>
<meta charset="utf-8">
<title>Jibestream Device Kit Documentation</title>
<meta name="description" content="Documentation for JMap Device Kit" />
<meta name="keywords" content="jmap device kit" />
<meta name="keyword" content="jmap device kit" />
<meta property="og:title" content="Jibestream Device Kit Documentation"/>
<meta property="og:type" content="website"/>
<meta property="og:image" content=""/>
<meta property="og:url" content=""/>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<script src="scripts/jquery.min.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/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/jaguar.css">
<script>
var config = {"monospaceLinks":false,"cleverLinks":false,"applicationName":"Jibestream Device Kit Documentation","disqus":"","googleAnalytics":"","openGraph":{"title":"Jibestream Device Kit Documentation","type":"website","image":"","site_name":"","url":""},"meta":{"title":"Jibestream Device Kit Documentation","description":"Documentation for JMap Device Kit","keyword":"jmap device kit"},"linenums":true,"default":{}};
</script>
</head>
<body>
<div id="wrap" class="clearfix">
<div class="navigation">
<h3 class="applicationName"><a href="index.html">Jibestream Device Kit Documentation</a></h3>
<div class="search">
<input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
</div>
<ul class="list">
<li class="item" data-name="Device">
<span class="title">
<a href="Device.html">Device</a>
</span>
<ul class="members itemMembers">
<span class="subtitle">Members</span>
<li data-name="Device#heading"><a href="Device.html#heading">heading</a></li>
<li data-name="Device#mapId"><a href="Device.html#mapId">mapId</a></li>
<li data-name="Device#name"><a href="Device.html#name">name</a></li>
<li data-name="Device#waypointId"><a href="Device.html#waypointId">waypointId</a></li>
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="Device#_getLocation"><a href="Device.html#_getLocation">_getLocation</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="DeviceCollection">
<span class="title">
<a href="DeviceCollection.html">DeviceCollection</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="DeviceCollection#getByMap"><a href="DeviceCollection.html#getByMap">getByMap</a></li>
<li data-name="DeviceCollection#getByName"><a href="DeviceCollection.html#getByName">getByName</a></li>
<li data-name="DeviceCollection#getByWaypoint"><a href="DeviceCollection.html#getByWaypoint">getByWaypoint</a></li>
<li data-name="DeviceCollection#isDevice"><a href="DeviceCollection.html#isDevice">isDevice</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
<li class="item" data-name="DeviceKit">
<span class="title">
<a href="DeviceKit.html">DeviceKit</a>
</span>
<ul class="members itemMembers">
</ul>
<ul class="typedefs itemMembers">
</ul>
<ul class="methods itemMembers">
<span class="subtitle">Methods</span>
<li data-name="DeviceKit#addComponentOverDevice"><a href="DeviceKit.html#addComponentOverDevice">addComponentOverDevice</a></li>
<li data-name="DeviceKit#focusToDevice"><a href="DeviceKit.html#focusToDevice">focusToDevice</a></li>
<li data-name="DeviceKit#focusToDeviceWithHeading"><a href="DeviceKit.html#focusToDeviceWithHeading">focusToDeviceWithHeading</a></li>
<li data-name="DeviceKit#getDevices"><a href="DeviceKit.html#getDevices">getDevices</a></li>
<li data-name="DeviceKit#getWaypointFromDevice"><a href="DeviceKit.html#getWaypointFromDevice">getWaypointFromDevice</a></li>
<li data-name="DeviceKit#hideAllDevices"><a href="DeviceKit.html#hideAllDevices">hideAllDevices</a></li>
<li data-name="DeviceKit#hideDevice"><a href="DeviceKit.html#hideDevice">hideDevice</a></li>
<li data-name="DeviceKit#pingDevice"><a href="DeviceKit.html#pingDevice">pingDevice</a></li>
<li data-name="DeviceKit#removeComponentFromDevice"><a href="DeviceKit.html#removeComponentFromDevice">removeComponentFromDevice</a></li>
<li data-name="DeviceKit#showAllDevices"><a href="DeviceKit.html#showAllDevices">showAllDevices</a></li>
<li data-name="DeviceKit#showDevice"><a href="DeviceKit.html#showDevice">showDevice</a></li>
<li data-name="DeviceKit#wayfindFromDevice"><a href="DeviceKit.html#wayfindFromDevice">wayfindFromDevice</a></li>
<li data-name="DeviceKit#wayfindToDevice"><a href="DeviceKit.html#wayfindToDevice">wayfindToDevice</a></li>
</ul>
<ul class="events itemMembers">
</ul>
</li>
</ul>
</div>
<div class="main">
<h1 class="page-title" data-filename="DeviceCollection.html">Class: DeviceCollection</h1>
<section>
<header>
<h2>
DeviceCollection
</h2>
<div class="class-description">Class representing a collection of Devices.</div>
</header>
<article>
<div class="container-overview">
<dt>
<div class="nameContainer">
<h4 class="name" id="DeviceCollection">
new DeviceCollection<span class="signature">()</span>
</h4>
<div class="tag-source">
DeviceCollection.js, line 7
</div>
</div>
</dt>
<dd>
<div class="description">
Create a collection of Devices.
</div>
<dl class="details">
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>jmap.core.BaseCollection</li>
</ul>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<div class="nameContainer">
<h4 class="name" id="getByMap">
getByMap<span class="signature">(map)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array}</span>
</h4>
<div class="tag-source">
DeviceCollection.js, line 47
</div>
</div>
</dt>
<dd>
<div class="description">
Get a specific set of devices belonging to a map
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>map</code></td>
<td class="type">
<span class="param-type">jmap.core.Map</span>
</td>
<td class="description last">
Any map to query with</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Array
</td>
<td class="description last">an array of devices</td>
</tr>
</tbody>
</table>
</dd>
<dt>
<div class="nameContainer">
<h4 class="name" id="getByName">
getByName<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array}</span>
</h4>
<div class="tag-source">
DeviceCollection.js, line 29
</div>
</div>
</dt>
<dd>
<div class="description">
Get a specific set of devices belonging to a waypoint
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">
A device name</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Array
</td>
<td class="description last">an array of devices</td>
</tr>
</tbody>
</table>
</dd>
<dt>
<div class="nameContainer">
<h4 class="name" id="getByWaypoint">
getByWaypoint<span class="signature">(waypoint)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array}</span>
</h4>
<div class="tag-source">
DeviceCollection.js, line 38
</div>
</div>
</dt>
<dd>
<div class="description">
Get a specific set of devices belonging to a waypoint
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>waypoint</code></td>
<td class="type">
<span class="param-type">jmap.core.Waypoint</span>
</td>
<td class="description last">
Any waypoint to query with</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Array
</td>
<td class="description last">an array of devices</td>
</tr>
</tbody>
</table>
</dd>
<dt>
<div class="nameContainer">
<h4 class="name" id="isDevice">
isDevice<span class="signature">(item)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Boolean}</span>
</h4>
<div class="tag-source">
DeviceCollection.js, line 20
</div>
</div>
</dt>
<dd>
<div class="description">
Returns a boolean for weather or not argument is constructed as an Device object
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
Item to evaluate</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<table class="params">
<thead>
<tr>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="type">
Boolean
</td>
<td class="description last">Boolean based on evaluation result</td>
</tr>
</tbody>
</table>
</dd>
</dl>
</article>
</section>
<footer>
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.3</a> on Mon Jul 17 2017 21:06:02 GMT-0400 (EDT)
</footer>
</div>
</div>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
<script src="scripts/main.js"></script>
</body>
</html>