Class MPDirectionsService

Service used to generate a route between two MPPoints.

Export

Constructors

constructor

Properties

id

Methods

addAvoidWayType clearWayType getRoute setIsDeparture setTime setTravelMode create

Constructors

Private constructor

  • new MPDirectionsService(id): MPDirectionsService
  • Private

    Creates an instance of MPDirectionsService.

    Parameters

    • id: string

    Returns MPDirectionsService

Properties

Private Readonly id

id: string

Methods

addAvoidWayType

  • addAvoidWayType(wayType): Promise<void>

  • Add an avoidWayType, these are based on OSM highways.

    Supported types are defined in MPHighway.

    Parameters

    • wayType: string

    Returns Promise<void>

    Async

clearWayType

  • clearWayType(): Promise<void>

  • Clears all added avoidWayTypes.

    Returns Promise<void>

    Async

getRoute

  • getRoute(origin, destination): Promise<MPRoute>

  • Queries the routing network to generate a route from the origin to the destination.

    Parameters

    Returns Promise<MPRoute>

    Async

setIsDeparture

  • setIsDeparture(isDeparture): Promise<void>

  • Sets whether routes should use departure time or arrival time when using the transit travel mode.

    Parameters

    • isDeparture: boolean

    Returns Promise<void>

    Async

setTime

  • setTime(time): Promise<void>

  • sets the wanted arrival/departure time for routes generated with this [MPDirectionsService]

    this setting is used in conjunction with setIsDeparture and setTravelMode.

    Parameters

    • time: number

    Returns Promise<void>

    Async

setTravelMode

  • setTravelMode(travelMode): Promise<void>

  • defines the travel mode for routes, can be one of the following:

    • "walking"
    • "bicycling"
    • "driving"
    • "transit"

    Parameters

    • travelMode: string

    Returns Promise<void>

    Async

Static create

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc