Interface: LivemapRef
Properties
centerTo
centerTo: (
center,zoom) =>void
Center the map on the given position and set the zoom level.
Parameters
center
the new center.
zoom
Number
the new zoom level.
Returns
void
closeEvent
closeEvent: () =>
void
Close the current opened event. Go to the search view.
Returns
void
closePinpoint
closePinpoint: () =>
void
Close the current opened pinpoint. Go to the search view.
Returns
void
disableSidebar
disableSidebar: () =>
void
Deactivate the bar with several rows of content (of events, pinpoints, list, etc).
Returns
void
drawPolyline
drawPolyline: (
coordinatesList,options) =>Promise<String>
Draw a polyline on the map between multiple coordinates. You can either draw a raw array of coordinates or use our itinerary service to draw a route between multiple points.
Parameters
coordinatesList
id of lists to be added to the map.
options
the polyline options. Please refer to the Embed SDK documentation to check its default values.
Returns
Promise<String>
enableSidebar
enableSidebar: () =>
void
Activate the bar with several rows of content (of events, pinpoints, list, etc).
Returns
void
getUserLocation
getUserLocation: () =>
Promise<UserLocation>
Get the user location.
Returns
Promise<UserLocation>
a promise with the user location if the user accepts to share his location.
loadMapUrl
loadMapUrl: () =>
void
Load the map in the webview using default parameters.
Returns
void
navigateToPinpoint
navigateToPinpoint: (
id) =>void
Start navigation to a pinpoint. Can be an absolute navigation (start location based on phone sensors) or a relative navigation (given start location & heading). If start location and initialHeading are not provided, the navigation will start with the user location
Parameters
id
number
the pinpoint id to navigate to
Returns
void
openEvent
openEvent: (
id) =>void
Open an event on the map. This can only be used for maps which use events.
Parameters
id
number
the id of the event to open
Returns
void
openPinpoint
openPinpoint: (
id) =>void
Open a pinpoint on the map.
Parameters
id
number
the id of the pinpoint to open
Returns
void
removePolyline
removePolyline: (
id) =>void
Remove a polyline from the map.
Parameters
id
string
id of polyline.
Returns
void
setCenter
setCenter: (
center) =>void
Center the map on the given position.
Parameters
center
the new center.
Returns
void
setFilters
setFilters: (
startDate,endDate,query,tags) =>void
Update search filters (dates, tags, text).
Parameters
startDate
string
start date at YYYY-MM-DD format
endDate
string
end date at YYYY-MM-DD format
query
string
text query
tags
string[]
array of string tags
Returns
void
setPinpoints
setPinpoints: (
pinpoints) =>void
Populates the map with given pinpoints.
Parameters
pinpoints
Pinpoint[]
the pinpoints to populate the map.
Returns
void
setSourceLists
setSourceLists: (
sourceLists) =>void
Define one or more lists to be displayed on the map in addition of the current pinpoints of the map.
Parameters
sourceLists
[number]
id of lists to be added to the map.
Returns
void
signInByToken
signInByToken: (
access_token) =>void
Sign in to the Livemap with a Wemap token.
Parameters
access_token
string
the acces_token property of your Wemap token
Returns
void
signOut
signOut: () =>
void
Sign out the current user.
Returns
void
stopNavigation
stopNavigation: () =>
void
Stop the currently running navigation.
Returns
void