Interface

ExternalDirectionsProvider

ExternalDirectionsProvider

What DirectionsService uses from an external directions provider, such as mapsindoors.directions.GoogleMapsProvider or mapsindoors.directions.MapboxProvider, to route to or from a place outside the venue.

Properties:
Name Type Attributes Description
ProviderName string <optional>

The provider's name.

Methods

# getDistanceMatrix(args) → {Promise:.<(ExternalDistanceMatrix:|DistanceMatrixError:)>|undefined}

Gets the distances and travel times from each origin to each destination.

Parameters:
Name Type Description
args Object
origins Array:.<Coordinate:>
destinations Array:.<Coordinate:>
travelMode string

The travel mode, such as WALKING.

The matrix, an error, or undefined when the provider doesn't support the travel mode.

Promise:.<(ExternalDistanceMatrix:|DistanceMatrixError:)> | undefined

# getRoute(args) → {Promise:.<{route:: (Route:|null:)}>}

Gets a route between two points.

Parameters:
Name Type Description
args Object
origin *

The origin, forwarded from a distance matrix element.

destination *

The destination, forwarded from a distance matrix element.

travelMode string

The travel mode, such as WALKING.

The route, or null when there is none.

Promise:.<{route:: (Route:|null:)}>