situm-cordova-plugin-official
Version:
Situm Cordova-based Plugin for hybrid apps.
4,757 lines • 67.5 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.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/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="Angle"><span class="type-signature"></span>Angle<span class="type-signature"></span></h4>
<div class="description">
Representation of an angle.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>degrees</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Angle in degrees, increasing in counter-clockwise</td>
</tr>
<tr>
<td class="name"><code>degreesClockwise</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Angle in radians, increasing in clockwise</td>
</tr>
<tr>
<td class="name"><code>radians</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Angle in radians, increasing in counter-clockwise</td>
</tr>
<tr>
<td class="name"><code>radiansMinusPiPi</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Angle in radians in range (-pi,pi)</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line256">line 256</a>
</li></ul></dd>
</dl>
<h4 class="name" id="BeaconFilter"><span class="type-signature"></span>BeaconFilter<span class="type-signature"></span></h4>
<div class="description">
Represents a BLE filter. Now the only field is the BLE proximity UUID
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>uuid</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line466">line 466</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Bounds"><span class="type-signature"></span>Bounds<span class="type-signature"></span></h4>
<div class="description">
Represents a rectangle bounds in a greographic 2D space.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>northEast</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Coordinate">Coordinate</a></span>
</td>
<td class="description last">The coordinate of the north-east corner of the bound.</td>
</tr>
<tr>
<td class="name"><code>northWest</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Coordinate">Coordinate</a></span>
</td>
<td class="description last">The coordinate of the north-west corner of the bound.</td>
</tr>
<tr>
<td class="name"><code>southEast</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Coordinate">Coordinate</a></span>
</td>
<td class="description last">The coordinate of the south-east corner of the bound.</td>
</tr>
<tr>
<td class="name"><code>southWest</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Coordinate">Coordinate</a></span>
</td>
<td class="description last">The coordinate of the south-east corner of the bound.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line77">line 77</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Building"><span class="type-signature"></span>Building<span class="type-signature"></span></h4>
<div class="description">
A Building object definition
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>buildingIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The unique identifier of the resource</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The building name that is appropriate for display to the user.</td>
</tr>
<tr>
<td class="name"><code>address</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Te building address.</td>
</tr>
<tr>
<td class="name"><code>bounds</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Bounds">Bounds</a></span>
</td>
<td class="description last">Compute corners of this building, without rotation, in earth coordinates.</td>
</tr>
<tr>
<td class="name"><code>boundsRotated</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Bounds">Bounds</a></span>
</td>
<td class="description last">Compute corners of this building, with rotation, in earth coordinates.</td>
</tr>
<tr>
<td class="name"><code>center</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Coordinate">Coordinate</a></span>
</td>
<td class="description last">Center of the building's base, as geographical coordinate.</td>
</tr>
<tr>
<td class="name"><code>Dimensions</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Dimensions">Dimensions</a></span>
</td>
<td class="description last">Dimensions of building's base (height and width) in meters.</td>
</tr>
<tr>
<td class="name"><code>infoHtml</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Additional information about building, formatted with HTML</td>
</tr>
<tr>
<td class="name"><code>pictureThumbUrl</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The URL of building thumbnail image</td>
</tr>
<tr>
<td class="name"><code>pictureUrl</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The URL of building image</td>
</tr>
<tr>
<td class="name"><code>rotation</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Rotation angle of the building's base, relative to the west-east axis, increasing in counter-clockwise, being 0 the west-east axis.</td>
</tr>
<tr>
<td class="name"><code>userIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Unique identifier of the owner user of the building</td>
</tr>
<tr>
<td class="name"><code>customFields</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Map of custom fields, indexed by their name.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
<h4 class="name" id="CartesianCoordinate"><span class="type-signature"></span>Cartesian Coordinate<span class="type-signature"></span></h4>
<div class="description">
A structure that contains cartesian coordinate.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Value of coordinate at x-axis</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Value of coordinate at y-axis</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line112">line 112</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Coordinate"><span class="type-signature"></span>Coordinate<span class="type-signature"></span></h4>
<div class="description">
A structure that contains geographical coordinate.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>latitude</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Latitude in degrees</td>
</tr>
<tr>
<td class="name"><code>longitude</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Longitude in degrees</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line96">line 96</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Dimensions"><span class="type-signature"></span>Dimensions<span class="type-signature"></span></h4>
<div class="description">
Define 2D dimensions of a rectangular area.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</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="description last">Width of rectangle in meters</td>
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Height of rectangle in meters.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line62">line 62</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Floor"><span class="type-signature"></span>Floor<span class="type-signature"></span></h4>
<div class="description">
Floor of a building.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>altitude</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Altitude of the floor above ground level, in meters.</td>
</tr>
<tr>
<td class="name"><code>buildingIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The identifier of building which this floor belongs.</td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The number of the floor.</td>
</tr>
<tr>
<td class="name"><code>mapUrl</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The floor map image url</td>
</tr>
<tr>
<td class="name"><code>scale</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The scale of the floor image, in px/meters</td>
</tr>
<tr>
<td class="name"><code>floorIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The unique identifier of the resource</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Indication"><span class="type-signature"></span>Indication<span class="type-signature"></span></h4>
<div class="description">
Represents the instruction that a user should follow when on a RouteStep to continue the route.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>distance</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The distance between the origin and destination</td>
</tr>
<tr>
<td class="name"><code>distanceToNextLevel</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The number of levels between the origin and destination</td>
</tr>
<tr>
<td class="name"><code>indicationType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The Indication.Action of the instruction as String</td>
</tr>
<tr>
<td class="name"><code>orientation</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The angle a user should change his direction in order to go from the origin to the destination.</td>
</tr>
<tr>
<td class="name"><code>orientationType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The Indication.Orientation of the instruction as String</td>
</tr>
<tr>
<td class="name"><code>stepIdxDestination</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The index of the indication's step of destination.</td>
</tr>
<tr>
<td class="name"><code>stepIdxOrigin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The index of the indication's step of origin</td>
</tr>
<tr>
<td class="name"><code>neededLevelChange</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">If the user should change the level in order to arrive to destination</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line332">line 332</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Location"><span class="type-signature"></span>Location<span class="type-signature"></span></h4>
<div class="description">
A location. It can be indoor or outdoor, check isIndoor and isOutdoor. A valid indoor location has floorIdentifier and cartesianCoordinate.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>accuracy</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The accuracy radius (in meters)</td>
</tr>
<tr>
<td class="name"><code>bearing</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Angle">Angle</a></span>
</td>
<td class="description last">The bearing (in degrees) with respect to the Earth North.</td>
</tr>
<tr>
<td class="name"><code>bearingQuality</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The quality of the cartesian bearing.</td>
</tr>
<tr>
<td class="name"><code>buildingIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Only used in indoor.</td>
</tr>
<tr>
<td class="name"><code>cartesianBearing</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Angle">Angle</a></span>
</td>
<td class="description last">Only used in indoor. In <a href="global.html#Angle">Angle</a> object.</td>
</tr>
<tr>
<td class="name"><code>cartesianCoordinate</code></td>
<td class="type">
<span class="param-type">CartesianCoordinate</span>
</td>
<td class="description last">Only used in indoor. In CartesianCoordinate object.</td>
</tr>
<tr>
<td class="name"><code>coordinate</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Coordinate">Coordinate</a></span>
</td>
<td class="description last">The <a href="global.html#Coordinate">Coordinate</a> of the location</td>
</tr>
<tr>
<td class="name"><code>floorIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Only used in indoor.</td>
</tr>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Point">Point</a></span>
</td>
<td class="description last">The position of the location as <a href="global.html#Point">Point</a>.</td>
</tr>
<tr>
<td class="name"><code>provider</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The device identifier that has generated the location</td>
</tr>
<tr>
<td class="name"><code>quality</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Only used in indoor.</td>
</tr>
<tr>
<td class="name"><code>hasBearing</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">True if the location has bearing and the bearing quality is Location.Quality.HIGH, false otherwise.</td>
</tr>
<tr>
<td class="name"><code>timestamp</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">The timestamp of the location.</td>
</tr>
<tr>
<td class="name"><code>hasCartesianBearing</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Only used in indoor.</td>
</tr>
<tr>
<td class="name"><code>isIndoor</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">True if the location is indoor</td>
</tr>
<tr>
<td class="name"><code>isOutdoor</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">True if the location is outdoor</td>
</tr>
<tr>
<td class="name"><code>deviceId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line210">line 210</a>
</li></ul></dd>
</dl>
<h4 class="name" id="LocationRequest"><span class="type-signature"></span>LocationRequest<span class="type-signature"></span></h4>
<div class="description">
A data object that contains parameters for the location service, LocationManager.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>buildingIdentifier</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>interval</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Default interval (in milliseconds) to notify location updates</td>
</tr>
<tr>
<td class="name"><code>indoorProvider</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Default indoor provider</td>
</tr>
<tr>
<td class="name"><code>useBle</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>useWifi</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>motionMode</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Default motion mode</td>
</tr>
<tr>
<td class="name"><code>useForegroundService</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>useDeadReckoning</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>outdoorLocationOptions</code></td>
<td class="type">
<span class="param-type"><a href="global.html#OutdoorLocationOptions">OutdoorLocationOptions</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>beaconFilters</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#BeaconFilter">BeaconFilter</a>></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>smallestDisplacement</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Default smallest displacement to nofiy location updates</td>
</tr>
<tr>
<td class="name"><code>readtimeUpdateInterval</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Default interval (in milliseconds) to send locations to the Realtime</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line410">line 410</a>
</li></ul></dd>
</dl>
<h4 class="name" id="OutdoorLocationOptions"><span class="type-signature"></span>OutdoorLocationOptions<span class="type-signature"></span></h4>
<div class="description">
Outdoor location options used only in indoor-outdoor mode
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>userDefinedThreshold</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>computeInterval</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>averageSnrThreshold</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line446">line 446</a>
</li></ul></dd>
</dl>
<h4 class="name" id="POIPointofInterest"><span class="type-signature"></span>POI <span class="type-signature"></span></h4>
<div class="description">
Point of Interest, associated to a building, regardless of whether it's place inside or outside the building.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>identifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The unique identifier of the resource</td>
</tr>
<tr>
<td class="name"><code>buildingIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Identifier of building to which the POI belongs.</td>
</tr>
<tr>
<td class="name"><code>cartesianCoordinate</code></td>
<td class="type">
<span class="param-type">CartesianCoordinate</span>
</td>
<td class="description last">Cartesian coordinate of this position, relative to building Bounds.</td>
</tr>
<tr>
<td class="name"><code>coordinate</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Coordinate">Coordinate</a></span>
</td>
<td class="description last">Geographical coordinate of this position</td>
</tr>
<tr>
<td class="name"><code>floorIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">If this POI is outside the building (isOutdoor == true), this field has no meaning.</td>
</tr>
<tr>
<td class="name"><code>poiName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A name for the POI, appropriate for display to the user.</td>
</tr>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Point">Point</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>isIndoor</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether the POI is placed outside the building or not.</td>
</tr>
<tr>
<td class="name"><code>isOutdoor</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether the POI is placed outside the building or not.</td>
</tr>
<tr>
<td class="name"><code>category</code></td>
<td class="type">
<span class="param-type"><a href="global.html#PoiCategory">PoiCategory</a></span>
</td>
<td class="description last">Category of the POI</td>
</tr>
<tr>
<td class="name"><code>infoHtml</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Additional information about POI, in HTML</td>
</tr>
<tr>
<td class="name"><code>customFields</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">Map of custom fields, indexed by their name.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line128">line 128</a>
</li></ul></dd>
</dl>
<h4 class="name" id="PoiCategory"><span class="type-signature"></span>PoiCategory<span class="type-signature"></span></h4>
<div class="description">
Category of Point of Interest.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>poiCategoryCode</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Unique code of the category</td>
</tr>
<tr>
<td class="name"><code>poiCategoryName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The category name appropriate for display to the user</td>
</tr>
<tr>
<td class="name"><code>icon_selected</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The selected icon url</td>
</tr>
<tr>
<td class="name"><code>icon_unselected</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The unselected icon url</td>
</tr>
<tr>
<td class="name"><code>public</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether the category is public or not</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line164">line 164</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Point"><span class="type-signature"></span>Point<span class="type-signature"></span></h4>
<div class="description">
Associate geographical coordinate (Location) with Building and Floor (Cartography) and cartesian coordinate relative to that building.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>buildingIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Unique identifier for the building to which this point belongs</td>
</tr>
<tr>
<td class="name"><code>cartesianCoordinate</code></td>
<td class="type">
<span class="param-type">CartesianCoordinate</span>
</td>
<td class="description last">Cartesian coordinate (in meters) relative to the Bounds of building's base.</td>
</tr>
<tr>
<td class="name"><code>coordinate</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Coordinate">Coordinate</a></span>
</td>
<td class="description last">Geographic coordinate (latitude, longitude) of the point, regardless of whether it's placed inside or outside the building.</td>
</tr>
<tr>
<td class="name"><code>floorIdentifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Floor identifier (inside the building) where this point is placed.</td>
</tr>
<tr>
<td class="name"><code>isIndoor</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">If the POI is inside the building.</td>
</tr>
<tr>
<td class="name"><code>idOutdoor</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">If the POI is outside the building.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line186">line 186</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Route"><span class="type-signature"></span>Route<span class="type-signature"></span></h4>
<div class="description">
Route between two points.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>edges</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#RouteStep">RouteStep</a>></span>
</td>
<td class="description last">Ordered list of steps to go to the goal point</td>
</tr>
<tr>
<td class="name"><code>firstStep</code></td>
<td class="type">
<span class="param-type"><a href="global.html#RouteStep">RouteStep</a></span>
</td>
<td class="description last">First step</td>
</tr>
<tr>
<td class="name"><code>from</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Point">Point</a></span>
</td>
<td class="description last">Point where the route starts.</td>
</tr>
<tr>
<td class="name"><code>indications</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Indication">Indication</a></span>
</td>
<td class="description last">Ordered list of instructions to go to the destination</td>
</tr>
<tr>
<td class="name"><code>lastStep</code></td>
<td class="type">
<span class="param-type"><a href="global.html#RouteStep">RouteStep</a></span>
</td>
<td class="description last">Last step</td>
</tr>
<tr>
<td class="name"><code>nodes</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#Point">Point</a>></span>
</td>
<td class="description last">A collection of points of the route (not ordered)</td>
</tr>
<tr>
<td class="name"><code>points</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#Point">Point</a>></span>
</td>
<td class="description last">List of ordered points of the route</td>
</tr>
<tr>
<td class="name"><code>to</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Point">Point</a></span>
</td>
<td class="description last">Last point and goal of the route.</td>
</tr>
<tr>
<td class="name"><code>steps</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#RouteStep">RouteStep</a>></span>
</td>
<td class="description last">Ordered list of steps to go to the goal point</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line276">line 276</a>
</li></ul></dd>
</dl>
<h4 class="name" id="RouteStep"><span class="type-signature"></span>RouteStep<span class="type-signature"></span></h4>
<div class="description">
A fragment of a route, described by the initial point from and the last point to of the fragment, and some information about the step within the route.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>distance</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Distance between from and to in meters.</td>
</tr>
<tr>
<td class="name"><code>distanceToGoal</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Distance in meters between the start point of this step (from) and the last point in the route ('to' of the last step).</td>
</tr>
<tr>
<td class="name"><code>from</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Point">Point</a></span>
</td>
<td class="description last">Start point of this step.</td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Position of this RouteStep in the list of steps (Route.steps) of the route to which it belongs.</td>
</tr>
<tr>
<td class="name"><code>to:</code></td>
<td class="type">
<span class="param-type"><a href="global.html#Point">Point</a></span>
</td>
<td class="description last">End point of this step.</td>
</tr>
<tr>
<td class="name"><code>isFirst</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Returns true if this is the first step in the route.</td>
</tr>
<tr>
<td class="name"><code>isLast</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Returns true if this is the last step in the route.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line306">line 306</a>
</li></ul></dd>
</dl>
<h4 class="name" id="SitumConversionArea"><span class="type-signature"></span>SitumConversionArea<span class="type-signature"></span></h4>
<div class="description">
A rectangular area of a floor defining the conversion area of an event
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>floorIdentifier</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>topLeft</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>topRight</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>bottomLeft</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>bottomRight</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line388">line 388</a>
</li></ul></dd>
</dl>
<h4 class="name" id="SitumEvent"><span class="type-signature"></span>SitumEvent<span class="type-signature"></span></h4>
<div class="description">
An event: POI with radius, conversion area and asociated statistics. It is intended for usage in marketing apps.
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>buildingIdentifier</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>identifier</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>floorIdentifier</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>infoHtml</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>conversionArea</code></td>
<td class="type">
<span class="param-type"><a href="global.html#SitumConversionArea">SitumConversionArea</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>customFields</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>radius</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="interfaces.js.html">interfaces.js</a>, <a href="interfaces.js.html#line360">line 360</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="Situm.html">Situm</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Angle">Angle</a></li><li><a href="global.html#BeaconFilter">BeaconFilter</a></li><li><a href="global.html#Bounds">Bounds</a></li><li><a href="global.html#Building">Building</a></li><li><a href="global.html#CartesianCoordinate">Cartesian Coordinate</a></li><li><a href="global.html#Coordinate">Coordinate</a></li><li><a href="global.html#Dimensions">Dimensions</a></li><li><a href="global.html#Floor">Floor</a></li><li><a href="global.html#Indication">Indication</a></li><li><a href="global.html#Location">Location</a></li><li><a href="global.html#LocationRequest">LocationRequest</a></li><li><a href="global.html#OutdoorLocationOptions">OutdoorLocationOptions</a></li><li><a href="global.html#POIPointofInterest">POI </a></li><li><a href="global.html#PoiCategory">PoiCategory</a></li><li><a href="global.html#Point">Point</a></li><li><a href="global.html#Route">Route</a></li><li><a href="global.html#RouteStep">RouteStep</a></li><li><a href="global.html#SitumConversionArea">SitumConversionArea</a></li><li><a href="global.html#SitumEvent">SitumEvent</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 25 2018 14:56:40 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>