Interface: LivemapRef
types.LivemapRef
Properties
centerTo
• centerTo: (center: Coordinates, zoom: Number) => void
Type declaration
▸ (center, zoom): void
Center the map on the given position and set the zoom level.
Parameters
| Name | Type | Description |
|---|---|---|
center | Coordinates | the new center. |
zoom | Number | the new zoom level. |
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:116
closeEvent
• closeEvent: () => void
Type declaration
▸ (): void
Close the current opened event. Go to the search view.
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:18
closePinpoint
• closePinpoint: () => void
Type declaration
▸ (): void
Close the current opened pinpoint. Go to the search view.
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:29
disableSidebar
• disableSidebar: () => void
Type declaration
▸ (): void
Deactivate the bar with several rows of content (of events, pinpoints, list, etc).
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:61
drawPolyline
• drawPolyline: (coordinatesList: [Coordinates], options: PolylineOptions) => Promise<String>
Type declaration
▸ (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
| Name | Type | Description |
|---|---|---|
coordinatesList | [Coordinates] | id of lists to be added to the map. |
options | PolylineOptions | the polyline options. Please refer to the JS documentation to check its default values. |
Returns
Promise<String>
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:97
enableSidebar
• enableSidebar: () => void
Type declaration
▸ (): void
Activate the bar with several rows of content (of events, pinpoints, list, etc).
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:56
getUserLocation
• getUserLocation: () => Promise<default>
Type declaration
▸ (): Promise<default>
Get the user location.
Returns
Promise<default>
a promise with the user location if the user accepts to share his location.
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:122
loadMapUrl
• loadMapUrl: () => void
Type declaration
▸ (): void
Load the map in the webview using default parameters.
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:66
navigateToPinpoint
• navigateToPinpoint: (id: number) => void
Type declaration
▸ (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
| Name | Type | Description |
|---|---|---|
id | number | the pinpoint id to navigate to |
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:46
openEvent
• openEvent: (id: number) => void
Type declaration
▸ (id): void
Open an event on the map. This can only be used for maps which use events.
Parameters
| Name | Type | Description |
|---|---|---|
id | number | the id of the event to open |
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:11
openPinpoint
• openPinpoint: (id: number) => void
Type declaration
▸ (id): void
Open a pinpoint on the map.
Parameters
| Name | Type | Description |
|---|---|---|
id | number | the id of the pinpoint to open |
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:24
removePolyline
• removePolyline: (id: string) => void
Type declaration
▸ (id): void
Remove a polyline from the map.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | id of polyline. |
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:103
setCenter
• setCenter: (center: Coordinates) => void
Type declaration
▸ (center): void
Center the map on the given position.
Parameters
| Name | Type | Description |
|---|---|---|
center | Coordinates | the new center. |
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:109
setFilters
• setFilters: (startDate: string, endDate: string, query: string, tags: string[]) => void
Type declaration
▸ (startDate, endDate, query, tags): void
Update search filters (dates, tags, text).
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:38
setPinpoints
• setPinpoints: (pinpoints: Pinpoint[]) => void
Type declaration
▸ (pinpoints): void
Populates the map with given pinpoints.
Parameters
| Name | Type | Description |
|---|---|---|
pinpoints | Pinpoint[] | the pinpoints to populate the map. |
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:83
setSourceLists
• setSourceLists: (sourceLists: [number]) => void
Type declaration
▸ (sourceLists): void
Define one or more lists to be displayed on the map in addition of the current pinpoints of the map.
Parameters
| Name | Type | Description |
|---|---|---|
sourceLists | [number] | id of lists to be added to the map. |
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:89
signInByToken
• signInByToken: (access_token: string) => void
Type declaration
▸ (access_token): void
Sign in to the Livemap with a Wemap token.
Parameters
| Name | Type | Description |
|---|---|---|
access_token | string | the acces_token property of your Wemap token |
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:72
signOut
• signOut: () => void
Type declaration
▸ (): void
Sign out the current user.
Returns
void
Defined in
react-native-wemap-livemap/src/types/LivemapRef.ts:77
stopNavigation
• stopNavigation: () => void
Type declaration
▸ (): void
Stop the currently running navigation.
Returns
void