Edit

RouteGetRouteRangeOptionalParams interface

  • Reference
Package:
azure-maps-rest

Optional Parameters.

Extends

RequestOptionsBase

Properties

accelerationEfficiency

Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter. Must be paired with decelerationEfficiency.

The range of values allowed are 0.0 to 1/decelerationEfficiency.

Sensible Values : for Combustion Model : 0.33, for Electric Model : 0.66
auxiliaryPowerInkW

Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW). It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

Sensible Values : 1.7
auxiliaryPowerInLitersPerHour

Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour. It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

Sensible Values : 0.2
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'
constantSpeedConsumptionInkWhPerHundredkm

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:

  • by linear interpolation, if the given speed lies in between two speeds in the list

  • by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list

The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.

Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.

Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.

The valid range for the consumption values(expressed in kWh/100km) is between 0.01 and 100000.0.

Sensible Values : 50,8.2:130,21.3

This parameter is required for Electric consumption model.
constantSpeedConsumptionInLitersPerHundredkm

Specifies the speed-dependent component of consumption. Provided as an unordered list of colon-delimited speed & consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:

  • by linear interpolation, if the given speed lies in between two speeds in the list

  • by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list

The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.

Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.

Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.

The valid range for the consumption values(expressed in l/100km) is between 0.01 and 100000.0.

Sensible Values : 50,6.3:130,11.5

Note : This parameter is required for The Combustion Consumption Model.
currentChargeInkWh

Specifies the current electric energy supply in kilowatt hours (kWh). This parameter co-exists with maxChargeInkWh parameter.

The range of values allowed are 0.0 to maxChargeInkWh.

Sensible Values : 43
currentFuelInLiters

Specifies the current supply of fuel in liters. Sensible Values : 55
decelerationEfficiency

Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter. Must be paired with accelerationEfficiency.

The range of values allowed are 0.0 to 1/accelerationEfficiency.

Sensible Values : for Combustion Model : 0.83, for Electric Model : 0.91
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).
downhillEfficiency

Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter. Must be paired with uphillEfficiency.

The range of values allowed are 0.0 to 1/uphillEfficiency.

Sensible Values : for Combustion Model : 0.51, for Electric Model : 0.73
energyBudgetInkWh

Electric energy budget in kilowatt hours (kWh) that determines maximal range which can be travelled using the specified Electric Consumption Model. This parameter is required if vehicleEngineType is Electric and timeBudgetInSec is not used. Either fuelBudgetInLiters, energyBudgetInkWh or timeBudgetInSec must be provided.
fuelBudgetInLiters

Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion Consumption Model. This parameter is required if vehicleEngineType is Combustion and timeBudgetInSec is not used. Either fuelBudgetInLiters, energyBudgetInkWh or timeBudgetInSec must be provided.
fuelEnergyDensityInMJoulesPerLiter

Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the *Efficiency parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel. This parameter is required if any *Efficiency parameter is set.

Sensible Values : 34.2
hilliness

Degree of hilliness for thrilling route. This parameter can only be used in conjunction with routeType=thrilling. Possible values include: 'low', 'normal', 'high'
maxChargeInkWh

Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery. This parameter co-exists with currentChargeInkWh parameter.

Minimum value has to be greater than or equal to currentChargeInkWh.

Sensible Values : 85
routeType

The type of route requested. Possible values include: 'fastest', 'shortest', 'eco', 'thrilling'
timeBudgetInSec

Time budget in seconds that determines maximal range which can be travelled using driving time. The consumption parameters will only affect eco-routes and thereby indirectly the driving time. This parameter is required if fuelBudgetInLiters or energyBudgetInkWh are not used. Either fuelBudgetInLiters, energyBudgetInkWh or timeBudgetInSec must be provided.
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.
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'
uphillEfficiency

Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter. Must be paired with downhillEfficiency.

The range of values allowed are 0.0 to 1/downhillEfficiency.

Sensible Values : for Combustion Model : 0.27, for Electric Model : 0.74
vehicleAxleWeight

Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.
vehicleCommercial

Vehicle is used for commercial purposes and thus may not be allowed to drive on some roads.
vehicleEngineType

Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of vehicleEngineType. Possible values include: 'combustion', 'electric'
vehicleHeight

Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.
vehicleLength

Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.
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'
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.
vehicleWeight

Weight of the vehicle in kilograms.

  • It is mandatory if any of the *Efficiency parameters are set.

  • It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered.

  • If no detailed Consumption Model is specified and the value of vehicleWeight is non-zero, then weight restrictions are considered.

  • In all other cases, this parameter is ignored.

Sensible Values : for Combustion Model : 1600, for Electric Model : 1900
vehicleWidth

Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.
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

abortSignal

The signal which can be used to abort requests.
customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
onDownloadProgress

Callback which fires upon download progress.
onUploadProgress

Callback which fires upon upload progress.
timeout

The number of milliseconds a request can take before automatically being terminated.

Property Details

accelerationEfficiency

Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter. Must be paired with decelerationEfficiency.

The range of values allowed are 0.0 to 1/decelerationEfficiency.

Sensible Values : for Combustion Model : 0.33, for Electric Model : 0.66

accelerationEfficiency?: number

Property Value

number

auxiliaryPowerInkW

Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW). It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

Sensible Values : 1.7

auxiliaryPowerInkW?: string

Property Value

string

auxiliaryPowerInLitersPerHour

Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour. It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

Sensible Values : 0.2

auxiliaryPowerInLitersPerHour?: number

Property Value

number

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[]

constantSpeedConsumptionInkWhPerHundredkm

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:

  • by linear interpolation, if the given speed lies in between two speeds in the list

  • by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list

The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.

Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.

Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.

The valid range for the consumption values(expressed in kWh/100km) is between 0.01 and 100000.0.

Sensible Values : 50,8.2:130,21.3

This parameter is required for Electric consumption model.

constantSpeedConsumptionInkWhPerHundredkm?: string

Property Value

string

constantSpeedConsumptionInLitersPerHundredkm

Specifies the speed-dependent component of consumption. Provided as an unordered list of colon-delimited speed & consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:

  • by linear interpolation, if the given speed lies in between two speeds in the list

  • by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list

The list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.

Consumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.

Similarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.

The valid range for the consumption values(expressed in l/100km) is between 0.01 and 100000.0.

Sensible Values : 50,6.3:130,11.5

Note : This parameter is required for The Combustion Consumption Model.

constantSpeedConsumptionInLitersPerHundredkm?: number

Property Value

number

currentChargeInkWh

Specifies the current electric energy supply in kilowatt hours (kWh). This parameter co-exists with maxChargeInkWh parameter.

The range of values allowed are 0.0 to maxChargeInkWh.

Sensible Values : 43

currentChargeInkWh?: string

Property Value

string

currentFuelInLiters

Specifies the current supply of fuel in liters. Sensible Values : 55

currentFuelInLiters?: number

Property Value

number

decelerationEfficiency

Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter. Must be paired with accelerationEfficiency.

The range of values allowed are 0.0 to 1/accelerationEfficiency.

Sensible Values : for Combustion Model : 0.83, for Electric Model : 0.91

decelerationEfficiency?: number

Property Value

number

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

downhillEfficiency

Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter. Must be paired with uphillEfficiency.

The range of values allowed are 0.0 to 1/uphillEfficiency.

Sensible Values : for Combustion Model : 0.51, for Electric Model : 0.73

downhillEfficiency?: number

Property Value

number

energyBudgetInkWh

Electric energy budget in kilowatt hours (kWh) that determines maximal range which can be travelled using the specified Electric Consumption Model. This parameter is required if vehicleEngineType is Electric and timeBudgetInSec is not used. Either fuelBudgetInLiters, energyBudgetInkWh or timeBudgetInSec must be provided.

energyBudgetInkWh?: number

Property Value

number

fuelBudgetInLiters

Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion Consumption Model. This parameter is required if vehicleEngineType is Combustion and timeBudgetInSec is not used. Either fuelBudgetInLiters, energyBudgetInkWh or timeBudgetInSec must be provided.

fuelBudgetInLiters?: number

Property Value

number

fuelEnergyDensityInMJoulesPerLiter

Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the *Efficiency parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel. This parameter is required if any *Efficiency parameter is set.

Sensible Values : 34.2

fuelEnergyDensityInMJoulesPerLiter?: number

Property Value

number

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

Hilliness

maxChargeInkWh

Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery. This parameter co-exists with currentChargeInkWh parameter.

Minimum value has to be greater than or equal to currentChargeInkWh.

Sensible Values : 85

maxChargeInkWh?: string

Property Value

string

routeType

The type of route requested. Possible values include: 'fastest', 'shortest', 'eco', 'thrilling'

routeType?: RouteType

Property Value

RouteType

timeBudgetInSec

Time budget in seconds that determines maximal range which can be travelled using driving time. The consumption parameters will only affect eco-routes and thereby indirectly the driving time. This parameter is required if fuelBudgetInLiters or energyBudgetInkWh are not used. Either fuelBudgetInLiters, energyBudgetInkWh or timeBudgetInSec must be provided.

timeBudgetInSec?: number

Property Value

number

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

TravelMode

uphillEfficiency

Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter. Must be paired with downhillEfficiency.

The range of values allowed are 0.0 to 1/downhillEfficiency.

Sensible Values : for Combustion Model : 0.27, for Electric Model : 0.74

uphillEfficiency?: number

Property Value

number

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

vehicleCommercial

Vehicle is used for commercial purposes and thus may not be allowed to drive on some roads.

vehicleCommercial?: boolean

Property Value

boolean

vehicleEngineType

Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of vehicleEngineType. Possible values include: 'combustion', 'electric'

vehicleEngineType?: VehicleEngineType

Property Value

VehicleEngineType

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

VehicleLoadType

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.

  • It is mandatory if any of the *Efficiency parameters are set.

  • It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered.

  • If no detailed Consumption Model is specified and the value of vehicleWeight is non-zero, then weight restrictions are considered.

  • In all other cases, this parameter is ignored.

Sensible Values : for Combustion Model : 1600, for Electric Model : 1900

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

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

Windingness

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