@situm/cordova 3.2.5 → 3.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -3
- package/docs/JSDoc/MapView.html +57 -3
- package/docs/JSDoc/MapViewController.html +935 -0
- package/docs/JSDoc/Situm.html +1 -1
- package/docs/JSDoc/android_Interfaces.js.html +7 -7
- package/docs/JSDoc/android_situm.js.html +1 -1
- package/docs/JSDoc/global.html +7 -7
- package/docs/JSDoc/index.html +1 -1
- package/docs/JSDoc/map-view-controller.js.html +178 -108
- package/docs/JSDoc/map-view.js.html +91 -32
- package/docs/JSDoc/styles/custom.css +41 -9
- package/docs/static/styles/custom.css +41 -9
- package/example/package-lock.json +1 -1
- package/example/src/app/wyf/wyf.page.html +1 -0
- package/example/src/app/wyf/wyf.page.ts +5 -0
- package/example/src/constants.ts.example +1 -0
- package/package.json +1 -1
- package/plugin.xml +1 -1
- package/src/ios/Podfile +1 -1
- package/www/android/Interfaces.js +2 -2
- package/www/map-view-controller.js +174 -106
- package/www/map-view.js +91 -32
- package/docs/JSDoc/MapViewControllerImpl.html +0 -755
package/README.md
CHANGED
|
@@ -2,9 +2,7 @@
|
|
|
2
2
|
<h1 align="center">Situm Cordova Plugin</h1>
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
|
-
<div align="center" style="text-align:center">
|
|
6
5
|
Situm Cordova Plugin is a set of utilities that allow any developer to build Cordova location based apps using Situm's indoor positioning system. Among many other capabilities, apps developed with Situm Cordova Plugin will be able to:
|
|
7
|
-
</div>
|
|
8
6
|
|
|
9
7
|
- Obtain information related to buildings where Situm's positioning system is already configured: floorplans, points of interest, geotriggered events, etc.
|
|
10
8
|
- Retrieve the location of the smartphone inside these buildings (position, orientation, and floor where the smartphone is).
|
|
@@ -70,7 +68,7 @@ Situm Cordova Plugin is licensed under [MIT License](https://opensource.org/lice
|
|
|
70
68
|
### Methods
|
|
71
69
|
|
|
72
70
|
> [!NOTE]
|
|
73
|
-
> This plugin is currently under development. There may be
|
|
71
|
+
> This plugin is currently under development. There may be methods not implemented yet. Also there may be some API changes as development progresses.
|
|
74
72
|
|
|
75
73
|
### Situm class
|
|
76
74
|
|
package/docs/JSDoc/MapView.html
CHANGED
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
<ul></ul>
|
|
39
39
|
</div>
|
|
40
40
|
|
|
41
|
-
<div class="lnb-api hidden"><h3>Namespaces</h3><ul><li><a href="MapView.html">MapView</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MapView_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MapView.html#.onLoad">onLoad</a></li></ul></div></li><li><a href="
|
|
41
|
+
<div class="lnb-api hidden"><h3>Namespaces</h3><ul><li><a href="MapView.html">MapView</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MapView_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MapView.html#.onLoad">onLoad</a></li></ul></div></li><li><a href="MapViewController.html">MapViewController</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="MapViewController_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="MapViewController.html#.navigateToPoi">navigateToPoi</a></li><li><a href="MapViewController.html#.onPoiDeselected">onPoiDeselected</a></li><li><a href="MapViewController.html#.onPoiSelected">onPoiSelected</a></li><li><a href="MapViewController.html#.selectPoi">selectPoi</a></li><li><a href="MapViewController.html#.setLanguage">setLanguage</a></li></ul></div></li><li><a href="Situm.html">Situm</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Situm_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Situm.html#.fetchBuildingInfo">fetchBuildingInfo</a></li><li><a href="Situm.html#.fetchBuildings">fetchBuildings</a></li><li><a href="Situm.html#.fetchEventsFromBuilding">fetchEventsFromBuilding</a></li><li><a href="Situm.html#.fetchFloorsFromBuilding">fetchFloorsFromBuilding</a></li><li><a href="Situm.html#.fetchGeofencesFromBuilding">fetchGeofencesFromBuilding</a></li><li><a href="Situm.html#.fetchIndoorPOIsFromBuilding">fetchIndoorPOIsFromBuilding</a></li><li><a href="Situm.html#.fetchMapFromFloor">fetchMapFromFloor</a></li><li><a href="Situm.html#.fetchOutdoorPOIsFromBuilding">fetchOutdoorPOIsFromBuilding</a></li><li><a href="Situm.html#.fetchPoiCategories">fetchPoiCategories</a></li><li><a href="Situm.html#.fetchPoiCategoryIconNormal">fetchPoiCategoryIconNormal</a></li><li><a href="Situm.html#.fetchPoiCategoryIconSelected">fetchPoiCategoryIconSelected</a></li><li><a href="Situm.html#.internalSetEventDelegate">internalSetEventDelegate</a></li><li><a href="Situm.html#.invalidateCache">invalidateCache</a></li><li><a href="Situm.html#.onEnterGeofences">onEnterGeofences</a></li><li><a href="Situm.html#.onExitGeofences">onExitGeofences</a></li><li><a href="Situm.html#.removeNavigationUpdates">removeNavigationUpdates</a></li><li><a href="Situm.html#.removeRealTimeUpdates">removeRealTimeUpdates</a></li><li><a href="Situm.html#.requestDirections">requestDirections</a></li><li><a href="Situm.html#.requestNavigationUpdates">requestNavigationUpdates</a></li><li><a href="Situm.html#.requestRealTimeUpdates">requestRealTimeUpdates</a></li><li><a href="Situm.html#.setApiKey">setApiKey</a></li><li><a href="Situm.html#.setCacheMaxAge">setCacheMaxAge</a></li><li><a href="Situm.html#.setUserPass">setUserPass</a></li><li><a href="Situm.html#.startPositioning">startPositioning</a></li><li><a href="Situm.html#.stopPositioning">stopPositioning</a></li><li><a href="Situm.html#.updateNavigationWithLocation">updateNavigationWithLocation</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><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#BuildingInfo">BuildingInfo</a></li><li><a href="global.html#CartesianCoordinate">CartesianCoordinate</a></li><li><a href="global.html#Circle">Circle</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#DirectionsOptions">DirectionsOptions</a></li><li><a href="global.html#DirectionsRequest">DirectionsRequest</a></li><li><a href="global.html#Floor">Floor</a></li><li><a href="global.html#Geofence">Geofence</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#LocationOptions">LocationOptions</a></li><li><a href="global.html#LocationRequest">LocationRequest</a></li><li><a href="global.html#LocationStatus">LocationStatus</a></li><li><a href="global.html#NavigationProgress">NavigationProgress</a></li><li><a href="global.html#NavigationRequest">NavigationRequest</a></li><li><a href="global.html#OutdoorLocationOptions">OutdoorLocationOptions</a></li><li><a href="global.html#POI">POI</a></li><li><a href="global.html#PoiCategory">PoiCategory</a></li><li><a href="global.html#PoiDeselectedResult">PoiDeselectedResult</a></li><li><a href="global.html#Point">Point</a></li><li><a href="global.html#PoiSelectedResult">PoiSelectedResult</a></li><li><a href="global.html#RealTimeData">RealTimeData</a></li><li><a href="global.html#RealTimeRequest">RealTimeRequest</a></li><li><a href="global.html#Route">Route</a></li><li><a href="global.html#RouteSegment">RouteSegment</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></div>
|
|
42
42
|
</nav>
|
|
43
43
|
<div id="resizer"></div>
|
|
44
44
|
|
|
@@ -62,6 +62,60 @@
|
|
|
62
62
|
<div class="container-overview">
|
|
63
63
|
|
|
64
64
|
|
|
65
|
+
<div class="description"><h4>CODE SNIPPET</h4>
|
|
66
|
+
|
|
67
|
+
Here's an example on how to implement this in your html view:
|
|
68
|
+
<div id="codeSnippet">
|
|
69
|
+
<pre id="textToCopy">
|
|
70
|
+
<p style="font-weight: bold;position: absolute;top: 10px;left: 10px;text-decoration: underline">HTML</p>
|
|
71
|
+
<map-view
|
|
72
|
+
situm-api-key="YOUR_SITUM_API_KEY"
|
|
73
|
+
building-identifier="YOUR_BUILDING_IDENTIFIER"
|
|
74
|
+
remote-identifier="YOUR_REMOTE_IDENTIFIER"
|
|
75
|
+
/>
|
|
76
|
+
</pre>
|
|
77
|
+
|
|
78
|
+
<button id="copySnippetButton">Copy</button>
|
|
79
|
+
</div>
|
|
80
|
+
|
|
81
|
+
<script>
|
|
82
|
+
document.getElementById("copySnippetButton").addEventListener("click", function() {
|
|
83
|
+
var textToCopy = document.getElementById("textToCopy");
|
|
84
|
+
|
|
85
|
+
var range = document.createRange();
|
|
86
|
+
range.selectNode(textToCopy);
|
|
87
|
+
window.getSelection().removeAllRanges();
|
|
88
|
+
window.getSelection().addRange(range);
|
|
89
|
+
|
|
90
|
+
document.execCommand("copy");
|
|
91
|
+
window.getSelection().removeAllRanges();
|
|
92
|
+
this.textContent = "Copied!";
|
|
93
|
+
});
|
|
94
|
+
</script>
|
|
95
|
+
|
|
96
|
+
<h4>ATTRIBUTES</h4>
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>situm-api-key</dt>
|
|
99
|
+
<dd>Your API Key to authenticate yourself in our plugin.
|
|
100
|
+
You can manage out your Situm API Key in <a href="https://dashboard.situm.com/accounts/profile"> https://dashboard.situm.com/accounts/profile</a>.</dd>
|
|
101
|
+
|
|
102
|
+
<dt>building-identifier</dt>
|
|
103
|
+
<dd>The identifier of the building you want to display on the map.
|
|
104
|
+
You can manage this identifier with this guide <a href="https://situm.com/docs/sdk-cartography/#building-details"> https://situm.com/docs/sdk-cartography/#building-details</a>.</dd>
|
|
105
|
+
|
|
106
|
+
<dt>remote-identifier</dt>
|
|
107
|
+
<dd>An identifier that allows you to remotely configure all map settings.</dd>
|
|
108
|
+
|
|
109
|
+
<dt>language</dt>
|
|
110
|
+
<dd>Choose the language that map-view will use to display its UI by specifying an ISO 639-1 code.
|
|
111
|
+
You can also change the language by calling MapViewController.setLanguage().
|
|
112
|
+
Checkout the <a href="https://situm.com/docs/13-internationalization/">Situm docs</a> to see the list of supported languages.</dd>
|
|
113
|
+
|
|
114
|
+
<dt>viewer-domain</dt>
|
|
115
|
+
<dd>A parameter that allows you to specify which domain will be displayed inside our webview.
|
|
116
|
+
Default is <a href="https://map-viewer.situm.com">https://map-viewer.situm.com</a></dd>
|
|
117
|
+
</dl></div>
|
|
118
|
+
|
|
65
119
|
|
|
66
120
|
|
|
67
121
|
|
|
@@ -134,7 +188,7 @@
|
|
|
134
188
|
|
|
135
189
|
<div class="container-source members">
|
|
136
190
|
<code><a href="map-view.js.html">map-view.js</a></code>,
|
|
137
|
-
<code><a href="map-view.js.html#
|
|
191
|
+
<code><a href="map-view.js.html#line137">line 137</a></code>
|
|
138
192
|
</div>
|
|
139
193
|
|
|
140
194
|
</h4>
|
|
@@ -147,7 +201,7 @@
|
|
|
147
201
|
|
|
148
202
|
<div class="description">
|
|
149
203
|
MapView was loaded.
|
|
150
|
-
The <a href="
|
|
204
|
+
The <a href="MapViewController.html">MapViewController</a> will be sent by the callback.
|
|
151
205
|
</div>
|
|
152
206
|
|
|
153
207
|
|