@jibestream-dev/jmap-device-kit

<!DOCTYPE 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>  <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="global.html">Global</h1> <section> <header> <h2> </h2> </header> <article> <div class="container-overview"> <dl class="details"> </dl> </div> <h3 class="subsection-title">Type Definitions</h3> <dl> <dt> <div class="nameContainer"> <h4 class="name" id="DeviceViewConfig">DeviceViewConfig<span class="type-signature type object">Object</span> </h4> </div> </dt> <dd> <div class="description"> The configuration object for the creation and update of an asset </div> <dl class="details"> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 20 </td> <td class="description last">The width of the icon</td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 20 </td> <td class="description last">The height of the icon</td> </tr> <tr> <td class="name"><code>url</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The URL of the image to be used as the asset's icon</td> </tr> <tr> <td class="name"><code>scaleWithMap</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last">Whether the asset's icon should scale with the map</td> </tr> <tr> <td class="name"><code>iconColor</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">If no url is provided for the icon, the colour of the default icon</td> </tr> <tr> <td class="name"><code>confidenceMax</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The maximum radius of the confidence circle (in pixels)</td> </tr> <tr> <td class="name"><code>confidencePercent</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The confidence in the position of the item (between 0 and 1). 0 will hide the confidence circle; 1 will display the full circle</td> </tr> <tr> <td class="name"><code>confidenceColor</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The color of the confidence circle in hexadecimal format</td> </tr> <tr> <td class="name"><code>confidenceAlpha</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The transparency of the confidence circle (between 0 and 1)</td> </tr> <tr> <td class="name"><code>pulseColor</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The color of the pulse circle</td> </tr> <tr> <td class="name"><code>pulseStartAlpha</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The starting opacity of the pulse circle (between 0 and 1)</td> </tr> <tr> <td class="name"><code>pulseEndAlpha</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The ending opacity of the pulse circle (between 0 and 1)</td> </tr> <tr> <td class="name"><code>pulseDuration</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The length of time of the pulse animation (in seconds)</td> </tr> <tr> <td class="name"><code>pulseDelay</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">The delay between pulse animation (in seconds)</td> </tr> <tr> <td class="name"><code>pulseVisible</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last">Whether the pulse should be visible</td> </tr> </tbody> </table></dl> </dl> </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>