1.6
Javascript reference- IndoorRenderer class
- IndoorService class
- IndoorWidget class
- Building object Specification
- Feature object Specification
- FeatureCollection object Specification
- IndoorDirectionLeg object Specification
- IndoorDirectionRequest object Specification
- IndoorDirectionResult object Specification
- IndoorDirectionRoute object Specification
- IndoorDirectionsBounds object Specification
- IndoorDistance object Specification
- IndoorDuration object Specification
- IndoorGeometryType object Specification
- IndoorInstruction object Specification
- IndoorPosition object Specification
- IndoorRendererOptions object Specification
- IndoorRendererOptionsIcon object Specification
- IndoorStep object Specification
- IndoorWidgetOptions object Specification
- IndoorWidgetOptionsui object Specification
- LatLngLevel object Specification
- Level object Specification
- PolylineCoords object Specification
- Venue object Specification
- VenuesResult object Specification
IndoorRenderer class 🔗
woosmap.map.IndoorRenderer
Constructor | |
constructor( |
Creates an Indoor renderer. |
Methods | |
setMap( |
Sets the map where to render the Indoor map. |
getLevel( |
Return Value: Number Get the displayed level. |
getSelectedFeature( |
Return Value: ?Feature Get the selected feature. |
getVenue( |
Return Value: ?Venue Get the displayed venue. |
setDirections( |
Call this function to draw a polyline on map. |
highlightStep( |
Highlight the step of the directions |
setUserLocation( |
Set the current user location. A blue dot is going to be displayed. |
getUserLocation( |
Return Value: IndoorPosition Returns the current user location. |
isUserInsideVenue( |
Return Value: Boolean Detects whether user location is found inside venue’s bounding box |
setFloor( |
Sets the floor for the venue |
setVenue( |
Renders map with the selected venue |
highlightFeature( |
Renders a map with a POI highlighted by pk or id |
highlightFeatureByRef( |
Renders a map with a POI highlighted by ref |
Events | |
indoor_level_changed |
This event is fired when the indoor level is changed |
indoor_user_location |
This event is fired when the indoor user location is changed |
indoor_feature_selected |
This event is fired when any indoor feature on the map is clicked |
IndoorService class 🔗
woosmap.map.IndoorService
Methods | |
venues( |
Retrieve all the venues |
venue( |
Retrieve detailed venue data |
search( |
Search for features by their names |
directions( |
Gets indoor directions |
feature( |
Gets feature by feature id |
IndoorWidget class 🔗
woosmap.map.IndoorWidget
Constructor | |
constructor( |
Creates a new Indoor widget. |
Methods | |||
setMap( |
Sets the map where to render the Indoor. | ||
setVenue( |
Renders map with the selected venue | ||
highlightFeature( |
Renders a map with a POI highlighted by pk / id | ||
highlightFeatureByRef( |
Renders a map with a POI highlighted by its ref | ||
setDirections( |
Call this function to draw a polyline on map. | ||
setUnits( |
Sets the distance units. | ||
getUnits( |
Return Value: "imperial" | Gets the distance units. | ||
setDirectionsMode( |
| ||
getDirectionsMode( |
Return Value: ?String Gets the distance units. | ||
setUserLocation( |
Sets the current user location. | ||
setFloor( |
Sets the floor for the venue | ||
addListener( |
Return Value: MapEventListener Adds a listener for eventName. |
Building object Specification 🔗
Building of a venue.
Properties | |
ref |
Type: ?String
|
name |
Type: ?String
|
description |
Type: ?String
|
opening_hours |
Type: ?String
|
logo |
Type: ?String
|
cover |
Type: ?String
|
levels |
Type: Array<Level>
|
Feature object Specification 🔗
Feature
Properties | |
id |
Type: ?Number
|
properties |
Type: {}
|
geometry |
Type: {coordinates : any, type : IndoorGeometryType}
|
FeatureCollection object Specification 🔗
Collection of features
Properties | |
type |
Type: "FeatureCollection"
|
features |
Type: Array<Feature>
|
IndoorDirectionLeg object Specification 🔗
Indoor directions leg.
Properties | |
distance |
Type: IndoorDistance
|
duration |
Type: IndoorDuration
|
end_location |
Type: LatLngLevel
|
start_location |
Type: LatLngLevel
|
steps |
Type: Array<IndoorStep>
|
IndoorDirectionRequest object Specification 🔗
Request to get directions between an origin and a destination.
Properties | |
venueId |
Type: String
|
origin |
Type: LatLng
|
originLevel |
Type: Number
|
destination |
Type: LatLng
|
destinationLevel |
Type: Number
|
language |
Type: ?String
|
units |
Type: "metric" | |
mode |
Type: ?String
|
IndoorDirectionResult object Specification 🔗
Indoor directions result.
Properties | |
routes |
Type: Array<IndoorDirectionRoute>
|
IndoorDirectionRoute object Specification 🔗
Indoor directions route.
Properties | |
legs |
Type: Array<IndoorDirectionLeg>
|
bounds |
Type: IndoorDirectionsBounds
|
IndoorDirectionsBounds object Specification 🔗
This object specification extends Array<Number>.
Indoor directions bounds.
IndoorDistance object Specification 🔗
Indoor distance object.
Properties | |
value |
Type: Number
|
text |
Type: String
|
IndoorDuration object Specification 🔗
Indoor duration object.
Properties | |
value |
Type: Number
|
text |
Type: String
|
IndoorGeometryType object Specification 🔗
This object specification extends "Point" |
Type of Indoor geometry
IndoorInstruction object Specification 🔗
Indoor instrction object.
Properties | |
summary |
Type: String
|
instruction_type |
Type: String
|
IndoorPosition object Specification 🔗
Position indoor.
Properties | |
position |
Type: LatLngLiteral
|
level |
Type: Number
|
bearing |
Type: ?Number
|
forceFocus |
Type: ?Boolean
|
IndoorRendererOptions object Specification 🔗
Options to configure the Indoor Renderer.
Properties | |
centerMap |
Type: Boolean
Center the map on the venue when initializing. |
defaultFloor |
Type: Number
Set default floor for the venue |
venue |
Type: String
Set default venue |
highlightPOI |
Type: Number
Renders map with a POI selected by pk or id |
icon |
Type: IndoorRendererOptionsIcon
Sets custom icon for venue markers |
highlightPOIByRef |
Type: String
Renders map with a POI selected by ref |
IndoorRendererOptionsIcon object Specification 🔗
Icons to use to display venues on the map.
Properties | |
url |
Type: String
|
scaledSize |
Type: {height : Number, width : Number}
|
anchor |
Type: {x : Number, y : Number}
|
IndoorStep object Specification 🔗
Indoor directions step.
Properties | |
distance |
Type: IndoorDistance
|
duration |
Type: IndoorDuration
|
end_location |
Type: LatLngLevel
|
start_location |
Type: LatLngLevel
|
instruction |
Type: ?IndoorInstruction
|
polyline |
Type: PolylineCoords
|
IndoorWidgetOptions object Specification 🔗
Options of the Indoor widget.
Properties | |
ui |
Type: IndoorWidgetOptionsui
Set the custom colors of the indoor widget |
units |
Type: "imperial" | Set units to use to show distance in directions itinerary |
directionsMode |
Type: String
Set directions mode/routing profile |
IndoorWidgetOptionsui object Specification 🔗
UI Option of the Indoor widget.
Properties | |
primaryColor |
Type: String
|
secondaryColor |
Type: String
|
LatLngLevel object Specification 🔗
Indoor location composed of a latitude, a longitude and a level.
Properties | |
lat |
Type: Number
|
lng |
Type: Number
|
level |
Type: Number
|
Level object Specification 🔗
Level of a Venue
Properties | |
name |
Type: ?String
|
level |
Type: Number
|
bbox |
Type: Array<Number>
|
PolylineCoords object Specification 🔗
This object specification extends Array<ArrayType>.
Array of lat, lon coordinates.
Venue object Specification 🔗
Venue
Properties | |
name |
Type: ?String
|
levels |
Type: Array<Level>
|
bbox |
Type: Array<Number>
|
venue_id |
Type: String
|
buildings |
Type: ?Array<Building>
|
routing_profiles |
Type: ?Array<String>
|
categories |
Type: ?Array<String>
|
VenuesResult object Specification 🔗
List of venues.
Properties | |
venues |
Type: Array<Venue>
|