Class MPDirectionsRenderer

Renders a MPRoute on the map.

Export

MPDirectionsRenderer

Constructors

constructor

Accessors

defaultRouteStopIcon

Methods

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

Constructors

constructor

  • new MPDirectionsRenderer(nativeEventEmitter: any): MPDirectionsRenderer

    Creates an instance of MPDirectionsRenderer.

    Parameters

    • nativeEventEmitter: any

    Returns MPDirectionsRenderer

Accessors

defaultRouteStopIcon

Methods

clear

  • clear(): Promise<void>

    Clears the route from the map.

    Returns Promise<void>

    Async

getSelectedLegFloorIndex

  • getSelectedLegFloorIndex(): Promise<number>

    Gets the currently selected leg's floor index.

    Returns Promise<number>

    Async

nextLeg

  • nextLeg(): Promise<void>

    Selects the next leg if possible.

    Has no effect if the last leg is selected.

    Returns Promise<void>

    Async

previousLeg

  • previousLeg(): Promise<void>

    Selects the previous leg if possible.

    Has no effect if the first leg is selected.

    Returns Promise<void>

    Async

selectLegIndex

  • selectLegIndex(legIndex: number): 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

setAnimatedPolyline

  • setAnimatedPolyline(
        animated: boolean,
        repeating: boolean,
        durationMs: number,
    ): 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

setCameraAnimationDuration

  • setCameraAnimationDuration(durationMs: number): 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

setCameraViewFitMode

  • setCameraViewFitMode(fitMode: MPCameraViewFitMode): Promise<void>

    Set the fitmode of the camera, when displaying route elements on the map.

    Parameters

    Returns Promise<void>

    Async

setDefaultRouteStopIcon

  • setDefaultRouteStopIcon(icon: RouteStopIconConfig): Promise<void>

    Set the default icon for route stops.

    Parameters

    Returns Promise<void>

    Async

setOnLegSelectedListener

  • setOnLegSelectedListener(listener?: OnLegSelectedListener): 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

    Returns Promise<void>

    Async

setRoute

  • setRoute(
        route?: MPRoute,
        stopIcons?: Map<number, RouteStopIconConfig>,
        legIndex?: number,
    ): Promise<void>

    Set a route to be rendered. This also resets the selected leg and step indices to 0.

    Parameters

    • Optionalroute: MPRoute
    • OptionalstopIcons: Map<number, RouteStopIconConfig> = null
    • OptionallegIndex: number = 0

      Overwrites the starting leg index, when rendering the route

    Returns Promise<void>

    Async

showRouteLegButtons

  • showRouteLegButtons(show: boolean): 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

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods