RouteBeginPostRouteMatrixPreviewOptionalParams interface
Optional Parameters.
- Extends
-
RequestOptionsBase
Properties
arrive |
The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime. |
avoid | Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In calculateReachableRange requests, the value alreadyUsedRoads must not be used. Possible values include: 'tollRoads', 'motorways', 'ferries', 'unpavedRoads', 'carpools', 'alreadyUsedRoads', 'borderCrossings' |
compute |
Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. Possible values include: 'none', 'all' |
depart |
The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00). |
hilliness | Degree of hilliness for thrilling route. This parameter can only be used in conjunction with
|
route |
The type of route requested. Possible values include: 'fastest', 'shortest', 'eco', 'thrilling' |
section |
Specifies which of the section types is reported in the route response. |
traffic | Possible values:
|
travel |
The mode of travel for the requested route. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be other. Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In calculateReachableRange requests, the values bicycle and pedestrian must not be used. Possible values include: 'car', 'truck', 'taxi', 'bus', 'van', 'motorcycle', 'bicycle', 'pedestrian' |
vehicle |
Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered. |
vehicle |
Height of the vehicle in meters. A value of 0 means that height restrictions are not considered. |
vehicle |
Length of the vehicle in meters. A value of 0 means that length restrictions are not considered. |
vehicle |
Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. Possible values include: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3', 'USHazmatClass4', 'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8', 'USHazmatClass9', 'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater' |
vehicle |
Maximum speed of the vehicle in km/hour. A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. A non-zero value may be overridden during route planning. |
vehicle |
Weight of the vehicle in kilograms. |
vehicle |
Width of the vehicle in meters. A value of 0 means that width restrictions are not considered. |
wait |
Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. |
windingness | Level of turns for thrilling route. This parameter can only be used in conjunction with routeType=thrilling. Possible values include: 'low', 'normal', 'high' |
Inherited Properties
abort |
The signal which can be used to abort requests. |
custom |
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent. |
on |
Callback which fires upon download progress. |
on |
Callback which fires upon upload progress. |
timeout | The number of milliseconds a request can take before automatically being terminated. |
Property Details
arriveAt
The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime.
arriveAt?: Date
Property Value
Date
avoid
Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In calculateReachableRange requests, the value alreadyUsedRoads must not be used. Possible values include: 'tollRoads', 'motorways', 'ferries', 'unpavedRoads', 'carpools', 'alreadyUsedRoads', 'borderCrossings'
avoid?: Avoid[]
Property Value
Avoid[]
computeTravelTimeFor
Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. Possible values include: 'none', 'all'
computeTravelTimeFor?: ComputeTravelTimeFor
Property Value
departAt
The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00).
departAt?: Date
Property Value
Date
hilliness
Degree of hilliness for thrilling route. This parameter can only be used in conjunction with
routeType
=thrilling. Possible values include: 'low', 'normal', 'high'
hilliness?: Hilliness
Property Value
routeType
The type of route requested. Possible values include: 'fastest', 'shortest', 'eco', 'thrilling'
routeType?: RouteType
Property Value
sectionType
Specifies which of the section types is reported in the route response.
For example if
sectionType = pedestrian the sections which are suited for pedestrians only are returned.
Multiple types can be used. The default sectionType refers to the travelMode input. By default
travelMode is set to car. Possible values include: 'carTrain', 'country', 'ferry', 'motorway',
'pedestrian', 'tollRoad', 'tollVignette', 'traffic', 'travelMode', 'tunnel'
sectionType?: SectionType
Property Value
traffic
Possible values:
- true - Do consider all available traffic information during routing
- false - Ignore current traffic data during routing. Note that although the current traffic data is ignored during routing, the effect of historic traffic on effective road speeds is still incorporated.
traffic?: boolean
Property Value
boolean
travelMode
The mode of travel for the requested route. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be other. Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In calculateReachableRange requests, the values bicycle and pedestrian must not be used. Possible values include: 'car', 'truck', 'taxi', 'bus', 'van', 'motorcycle', 'bicycle', 'pedestrian'
travelMode?: TravelMode
Property Value
vehicleAxleWeight
Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.
vehicleAxleWeight?: number
Property Value
number
vehicleHeight
Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.
vehicleHeight?: number
Property Value
number
vehicleLength
Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.
vehicleLength?: number
Property Value
number
vehicleLoadType
Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck. Possible values include: 'USHazmatClass1', 'USHazmatClass2', 'USHazmatClass3', 'USHazmatClass4', 'USHazmatClass5', 'USHazmatClass6', 'USHazmatClass7', 'USHazmatClass8', 'USHazmatClass9', 'otherHazmatExplosive', 'otherHazmatGeneral', 'otherHazmatHarmfulToWater'
vehicleLoadType?: VehicleLoadType
Property Value
vehicleMaxSpeed
Maximum speed of the vehicle in km/hour. A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning. A non-zero value may be overridden during route planning.
vehicleMaxSpeed?: number
Property Value
number
vehicleWeight
Weight of the vehicle in kilograms.
vehicleWeight?: number
Property Value
number
vehicleWidth
Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.
vehicleWidth?: number
Property Value
number
waitForResults
Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response.
waitForResults?: boolean
Property Value
boolean
windingness
Level of turns for thrilling route. This parameter can only be used in conjunction with routeType=thrilling. Possible values include: 'low', 'normal', 'high'
windingness?: Windingness
Property Value
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
AbortSignalLike
Inherited From RequestOptionsBase.abortSignal
customHeaders
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
customHeaders?: [key: string]: string
Property Value
[key: string]: string
Inherited From RequestOptionsBase.customHeaders
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From RequestOptionsBase.onDownloadProgress
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From RequestOptionsBase.onUploadProgress
timeout
The number of milliseconds a request can take before automatically being terminated.
timeout?: number
Property Value
number
Inherited From RequestOptionsBase.timeout