Class MPDirectionsService

Service used to generate a route between two MPPoints.

Export

Hierarchy

MPDirectionsService

Index

Constructors

Properties

Methods

addAvoidWayType addExcludeWayType clearExcludeWayType clearWayType getRoute setIsDeparture setTime setTravelMode create

Constructors

`Private` constructor

new MPDirectionsService(id): MPDirectionsService
Private
Creates an instance of MPDirectionsService.
Parameters
- id: string
Returns MPDirectionsService
- Defined in src/core/MPDirectionsService.ts:21

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
- Defined in src/core/MPDirectionsService.ts:45

addExcludeWayType

addExcludeWayType(wayType): Promise<void>
Add an excludeWayType, these are based on OSM highways.

Supported types are defined in MPHighway.
Parameters
- wayType: string
Returns Promise<void>

Async
- Defined in src/core/MPDirectionsService.ts:70

clearExcludeWayType

clearExcludeWayType(): Promise<void>
Clears all added excludeWayType.

Returns Promise<void>

Async
- Defined in src/core/MPDirectionsService.ts:81

clearWayType

clearWayType(): Promise<void>
Clears all added avoidWayTypes.

Returns Promise<void>

Async
- Defined in src/core/MPDirectionsService.ts:56

getRoute

getRoute(origin, destination, stops?, optimze?): Promise<MPRoute>
Queries the routing network to generate a route from the origin to the destination.
Parameters
- origin: MPPoint
- destination: MPPoint
- Optional stops: MPPoint[] = null
- Optional optimze: boolean = false
Returns Promise<MPRoute>

Async
- Defined in src/core/MPDirectionsService.ts:108

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
- Defined in src/core/MPDirectionsService.ts:93

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
- Defined in src/core/MPDirectionsService.ts:149

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
- Defined in src/core/MPDirectionsService.ts:135

`Static` create

create(): Promise<MPDirectionsService>
Creates a new service.

Returns Promise<MPDirectionsService>

Static

Async
- Defined in src/core/MPDirectionsService.ts:31

Generated using TypeDoc