Class MPDirectionsRenderer

Renders a MPRoute on the map.

Export

Hierarchy

MPDirectionsRenderer

Index

Constructors

Properties

_defaultRouteStopIcon? eventEmitter? onLegSelectedSub?

Accessors

defaultRouteStopIcon

Methods

clear getSelectedLegFloorIndex nextLeg previousLeg selectLegIndex setAnimatedPolyline setCameraAnimationDuration setCameraViewFitMode setDefaultRouteStopIcon setOnLegSelectedListener setRoute showRouteLegButtons

Constructors

constructor

new MPDirectionsRenderer(nativeEventEmitter): MPDirectionsRenderer
Creates an instance of MPDirectionsRenderer.
Parameters
- nativeEventEmitter: typeof NativeEventEmitter
Returns MPDirectionsRenderer
- Defined in src/core/MPDirectionsRenderer.ts:43

Properties

`Private` `Optional` _defaultRouteStopIcon

_defaultRouteStopIcon?: RouteStopIconConfig

`Private` `Optional` eventEmitter

eventEmitter?: NativeEventEmitter

Event handler.

`Private` `Optional` onLegSelectedSub

onLegSelectedSub?: EmitterSubscription

Listener for leg selection events.

Accessors

defaultRouteStopIcon

get defaultRouteStopIcon(): RouteStopIconConfig
Returns RouteStopIconConfig
- Defined in src/core/MPDirectionsRenderer.ts:18

Methods

clear

clear(): Promise<void>
Clears the route from the map.

Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:54

getSelectedLegFloorIndex

getSelectedLegFloorIndex(): Promise<number>
Gets the currently selected leg's floor index.

Returns Promise<number>

Async
- Defined in src/core/MPDirectionsRenderer.ts:166

nextLeg

nextLeg(): Promise<void>
Selects the next leg if possible.

Has no effect if the last leg is selected.

Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:67

previousLeg

previousLeg(): Promise<void>
Selects the previous leg if possible.

Has no effect if the first leg is selected.

Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:80

selectLegIndex

selectLegIndex(legIndex): Promise<void>
Manually set the selected leg index on the route.

This may reject if the resulting internal state is invalid (parsed index is out of bounds).
Parameters
- legIndex: number
Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:153

setAnimatedPolyline

setAnimatedPolyline(animated, repeating, durationMs): Promise<void>
Enable/Disable the polyline animation when displaying a route element on the map.
Parameters
- animated: boolean
- repeating: boolean
- durationMs: number
Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:127

setCameraAnimationDuration

setCameraAnimationDuration(durationMs): Promise<void>
Set the duration of camera animations in ms.

If the duration < 0 then camera animations are disabled, and the camera will move instantly.

The value is 1000 ms by default
Parameters
- durationMs: number
Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:182

setCameraViewFitMode

setCameraViewFitMode(fitMode): Promise<void>
Set the fitmode of the camera, when displaying route elements on the map.
Parameters
- fitMode: MPCameraViewFitMode
Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:194

setDefaultRouteStopIcon

setDefaultRouteStopIcon(icon): Promise<void>
Set the default icon for route stops.
Parameters
- icon: RouteStopIconConfig
Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:112

setOnLegSelectedListener

setOnLegSelectedListener(listener?): Promise<void>
Set a listener, which will be invoked when a new leg has been selected.

This is used for when the forward/back markers are selected on the map.
Parameters
- Optional listener: OnLegSelectedListener
Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:228

setRoute

setRoute(route?, stopIcons?, legIndex?): Promise<void>
Set a route to be rendered. This also resets the selected leg and step indices to 0.
Parameters
- Optional route: MPRoute
- Optional stopIcons: Map<number, RouteStopIconConfig> = null
- Optional legIndex: number = 0
  
  Overwrites the starting leg index, when rendering the route
Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:94

showRouteLegButtons

showRouteLegButtons(show): Promise<void>
Enable/Disable the route end/start label buttons from showing on the route. Default is true
Parameters
- show: boolean
Returns Promise<void>

Async
- Defined in src/core/MPDirectionsRenderer.ts:139

Generated using TypeDoc