Skip to content

@smartmaps/routingDocs


@smartmaps/routing / RoutingTrip

Class: RoutingTrip

Extends

Constructors

new RoutingTrip()

new RoutingTrip(apiKey, options): RoutingTrip

Parameters

apiKey: string

options: Partial\<RoutingTripOptions> = {}

Returns

RoutingTrip

Inherited from

RoutingBase.constructor

Properties

apiKey

protected apiKey: string

Inherited from

RoutingBase.apiKey


options

options: RoutingTripOptions

Inherited from

RoutingBase.options

Methods

calcRoute()

calcRoute(latlngs, options): Promise\<RoutingResponseCollection>

Parameters

latlngs: SmartmapsPointExpression[]

options: Partial\<RoutingTripOptions & object> = {}

Returns

Promise\<RoutingResponseCollection>

Inherited from

RoutingBase.calcRoute


checkResponse()

protected checkResponse(response): CheckResponse

Parameters

response: unknown

Returns

CheckResponse

Inherited from

RoutingBase.checkResponse


fillRequestFeatures()

fillRequestFeatures(latlngs): RoutingRequestWaypoint[]

Parameters

latlngs: SmartmapsPointExpression[]

Returns

RoutingRequestWaypoint[]

Overrides

RoutingBase.fillRequestFeatures


fillRoutingParams()

fillRoutingParams(options): RoutingTripRequestParams

Parameters

options: Partial\<RoutingTripOptions>

Returns

RoutingTripRequestParams

Overrides

RoutingBase.fillRoutingParams


getRequestInfo()

protected getRequestInfo(request): Promise\<object>

Parameters

request: string

Returns

Promise\<object>

bodyPart

bodyPart: object

requestPart

requestPart: Partial\<RequestInit>

url

url: string

Inherited from

RoutingBase.getRequestInfo