Class MPDirectionsRenderer

Renders a MPRoute on the map.

Export

Hierarchy

MPDirectionsRenderer

Constructors

constructor

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

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:28

Methods

clear

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

Returns Promise<void>

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

finishGuidance

finishGuidance(usagePercentage?): Promise<void>
Signals that guidance on the current route has finished, either because the user arrived or because they ended navigation.

Has no effect when no route is set, or when guidance on the current route has already finished. clear finishes guidance implicitly, so there is no need to call both.
Parameters
- Optional usagePercentage: number
  
  How much of the route was travelled, from 0 to 100. Values outside that range are clamped. Omit it to let the SDK derive the figure from the route's own progress.
Returns Promise<void>

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

getOptions

getOptions(): Promise<MPDirectionsRendererOptions>
Gets the currently effective styling and camera options of the rendered route.

Each option is resolved as: the value set with setOptions, then the solution level default configured in the CMS, then the SDK's built-in default. An option reading back as undefined has no default in force for it yet.

Returns Promise<MPDirectionsRendererOptions>

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

getSelectedLegFloorIndex

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

Returns Promise<number>

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

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:77

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:90

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:243

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>

Deprecated
Use setOptions with animationType, animationRepeating and animationSpeed instead.

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

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:272

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:284

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:122

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:318

setOptions

setOptions(options): Promise<void>
Set the styling and camera options of the rendered route.

Applies immediately, restyling an already rendered route in place. Every option resolves on its own, in this order: the value set here, then the solution level default configured in the CMS, then the SDK's built-in default. Options left unset are therefore inherited rather than reset.
Parameters
- options: MPDirectionsRendererOptions
Returns Promise<void>

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

setPolylineColors

setPolylineColors(foregroundColor, backgroundColor): Promise<void>
Set the colors of the route polyline.

Colors are given as hex strings (e.g. "#3071D9").
Parameters
- foregroundColor: string
  
  the primary color (animated polyline)
- backgroundColor: string
  
  the secondary color (static polyline)
Returns Promise<void>

Deprecated
Use setOptions with animatedOverlayColor (foreground) and strokeColor (background) instead.

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

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:104

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:229

Class MPDirectionsRenderer

Export

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

nativeEventEmitter: any

Returns MPDirectionsRenderer

Properties

Private Optional _defaultRouteStopIcon

Private Optional eventEmitter

Private Optional onLegSelectedSub

Accessors

defaultRouteStopIcon

Returns RouteStopIconConfig

Methods

clear

Returns Promise<void>

Async

finishGuidance

Parameters

Optional usagePercentage: number

Returns Promise<void>

Async

getOptions

Returns Promise<MPDirectionsRendererOptions>

Async

getSelectedLegFloorIndex

Returns Promise<number>

Async

nextLeg

Returns Promise<void>

Async

previousLeg

Returns Promise<void>

Async

selectLegIndex

Parameters

legIndex: number

Returns Promise<void>

Async

setAnimatedPolyline

Parameters

animated: boolean

repeating: boolean

durationMs: number

Returns Promise<void>

Deprecated

Async

setCameraAnimationDuration

Parameters

durationMs: number

Returns Promise<void>

Async

setCameraViewFitMode

Parameters

fitMode: MPCameraViewFitMode

Returns Promise<void>

Async

setDefaultRouteStopIcon

Parameters

icon: RouteStopIconConfig

Returns Promise<void>

Async

setOnLegSelectedListener

Parameters

Optional listener: OnLegSelectedListener

Returns Promise<void>

Async

setOptions

Parameters

options: MPDirectionsRendererOptions

Returns Promise<void>

Async

setPolylineColors

`Private` `Optional` _defaultRouteStopIcon

`Private` `Optional` eventEmitter

`Private` `Optional` onLegSelectedSub

`Optional` usagePercentage: number

`Optional` listener: OnLegSelectedListener

`Optional` route: MPRoute

`Optional` stopIcons: Map<number, RouteStopIconConfig> = null

`Optional` legIndex: number = 0