RouteGetRouteRangeOptionalParams interface

套件:

azure-maps-rest

選擇性參數。

Extends

RequestOptionsBase

屬性

accelerationEfficiency	指定當車輛加速 (即 KineticEnergyGained/FuelEnergyConsumed) 時，將儲存在燃料中的化學能源轉換為 kinetic 能源的效率。使用fuelEnergyDensityInMJoulesPerLiter，將已耗用的燃料轉換成化學能源，以取得化油。 必須與 decelerationEfficiency 配對。 允許的值範圍是 0.0 到 1/decelerationEfficiency。 合理值：適用於 電力模型 ：0.33，適用於 電力模型 ：0.66
auxiliaryPowerInkW	指定用於維持輔助系統的耗電量，以千瓦為單位 (kW) 。 它可用來指定因 AC 系統、無線電、熱等裝置和系統等裝置和系統而耗用量。 合理值：1.7
auxiliaryPowerInLitersPerHour	指定每小時的車輛輔助系統所耗用的燃料量。 它可用來指定因 AC 系統、無線電、熱等裝置和系統等裝置和系統而耗用量。 合理值：0.2
avoid	指定在判斷路由時，路由計算應該嘗試避免的事項。 可以在一個要求中多次指定，例如『&avoid=&avoid=tollRoads&avoid=feries』。 在 calculateReachableRange 要求中，不得使用已經使用值UsedRoads。 可能的值包括：'tollRoads'、'tolls'、'ferries'、'unpavedRoads'、'carpools'、'alreadyUsedRoads'、'borderCrossings'
constantSpeedConsumptionInkWhPerHundredkm	指定耗用量的速度相依元件。 以未排序的速度/耗用量率組清單的形式提供。 此清單會定義耗用量曲線上的點。 找到不在清單中的速度耗用量率，如下所示： 透過線性插補，如果指定的速度位於清單中的兩個速度之間，則為 依線性外推，否則假設常數 (ーSpeed/ЛSpeed) 由清單中的最接近兩個點所決定 此清單必須包含介於 1 到 25 點 (內含) ，而且可能不會包含相同速度的重複點。 如果它只包含單一點，則會使用該點的耗用量率，而不需進一步處理。 針對最大速度指定的耗用量必須大於或等於第二個最大速度的耗用量。 這可確保推斷不會導致負耗用量率。 同樣地，針對清單中的兩個最小速度所指定的耗用量值，不會導致任何較小速度的負耗用量率。 以 kWh/100km) 表示之耗用量值的有效範圍 (介於 0.01 到 100000.0 之間。 合理值：50,8.2：130,21.3 需要此參數才能用於 電力耗用量模型。
constantSpeedConsumptionInLitersPerHundredkm	指定耗用量的速度相依元件。 以未排序的冒號分隔速度清單提供，& 耗用量率組。 此清單會定義耗用量曲線上的點。 找到不在清單中的速度耗用量率，如下所示： 透過線性插補，如果指定的速度位於清單中的兩個速度之間，則為 依線性外推，否則假設常數 (ーSpeed/ЛSpeed) 由清單中的最接近兩個點所決定 此清單必須包含介於 1 到 25 點 (內含) ，而且可能不會包含相同速度的重複點。 如果它只包含單一點，則會使用該點的耗用量率，而不需進一步處理。 針對最大速度指定的耗用量必須大於或等於第二個最大速度的耗用量。 這可確保推斷不會導致負耗用量率。 同樣地，針對清單中的兩個最小速度所指定的耗用量值，不會導致任何較小速度的負耗用量率。 以 l/100km 表示 (取用值的有效範圍，) 介於 0.01 到 100000.0 之間。 合理值：50,6.3：130,11.5 注意 ：此參數是 必要條件取用模型。
currentChargeInkWh	指定以千瓦時為單位的目前電力供應 (kWh) 。 此參數與 MaxChargeInkWh 參數共存。 允許的值範圍是 0.0 到 maxChargeInkWh。 合理值：43
currentFuelInLiters	指定目前的燃料供應量。 合理值：55
decelerationEfficiency	指定當車輛減速 (時，將動態能源轉換成節省的 (不會耗用) 油的效率 ，亦即，在) 中減速/KineticEnergySaved/KineticEnergyLost。使用fuelEnergyDensityInMJoulesPerLiter，將已儲存的 (未耗用的) 燃料轉換為能源，以取得化化EnergySaved。 必須與 accelerationEfficiency 配對。 允許的值範圍是 0.0 到 1/accelerationEfficiency。 合理值：適用於 電力模型 ：0.83，適用於 電力模型 ：0.91
departAt	從原點出發的日期和時間。 目前以外的出發時間必須指定為 dateTime。 如果未指定時區位移，則會假設為原點的時差。 futureAt 值必須是日期時間格式 (1996-12-19T16：39：57-08：00) 。
downhillEfficiency	指定當車輛失去高度 (時，將潛在能源轉換為未耗用 () 燃料的效率 ，亦即，在) 中將可能能源轉換為節省的能源。使用fuelEnergyDensityInMJoulesPerLiter，將已儲存的 (未耗用的) 燃料轉換為能源，以取得化化EnergySaved。 必須與 uphillEfficiency 配對。 允許的值範圍是 0.0 到 1/uphillEfficiency。 合理值：適用於 電力模型 ：0.51，適用於 電力模型 ：0.73
energyBudgetInkWh	以千瓦時為單位的電力預算 (kWh) ，可決定可使用指定的電力耗用量模型來消耗的最大範圍。 如果 vehicleEngineType 為 Electric，且未使用 timeBudgetInSec，則需要此參數。 必須提供 fuelBudgetInLiters、energyBudgetInkWh 或 timeBudgetInSec。
fuelBudgetInLiters	油箱預算，決定可使用指定之耗用量模型來擷取的最大範圍。 如果 vehicleEngineType 為一個系統，且未使用 timeBudgetInSec，則需要此參數。 必須提供 fuelBudgetInLiters、energyBudgetInkWh 或 timeBudgetInSec。
fuelEnergyDensityInMJoulesPerLiter	指定在 MJ) (一次加油中儲存的化學能源量。 它會與 *效率 參數搭配使用，以在已儲存或耗用的能源和燃料之間進行轉換。 例如，能源密度是 34.2 MJ/l，而 35.8 MJ/l 則用於燃料。 如果已設定任何 *Efficiency 參數，則需要此參數。 合理值：34.2
hilliness	令人驚豔的路線程度。 此參數只能與 =ining 搭配 routeType使用。 可能的值包括：'low'、'normal'、'high'
maxChargeInkWh	指定可能儲存在車輛電池中 (kWh) 以千瓦時為單位的電力供應量上限。 此參數與 currentChargeInkWh 參數共存。 最小值必須大於或等於 currentChargeInkWh。 合理值：85
routeType	要求的路由類型。 可能的值包括：'fastest'、'shortest'、'eco'、'存留'
timeBudgetInSec	以秒為單位的時間預算，可決定可使用駕駛時間進行的最大範圍。 耗用量參數只會影響生態系統路線，進而間接影響駕駛時間。 如果未使用 fuelBudgetInLiters 或 energyBudgetInkWh，則需要此參數。 必須提供 fuelBudgetInLiters、energyBudgetInkWh 或 timeBudgetInSec。
traffic	可能的值： true - 在路由期間考慮所有可用的流量資訊 false - 在路由期間忽略目前的流量數據。 請注意，雖然在路由期間會忽略目前的交通數據，但有效道路速度的歷史交通影響仍會納入。
travelMode	所要求路線的行進模式。 請注意，要求的 travelMode 可能無法用於整個路線。 如果要求之 travelMode 不適用於特定區段，該區段之回應的 travelMode 元素將會是其他專案。 請注意，旅遊模式總線、車車、計程車和貨車都是 BETA 功能。 所有區域都無法使用完整限制數據。 在 calculateReachableRange 要求中，不得使用自行車和自行車的值。 可能的值包括：'car'、'truck'、'taxi'、'bus'、'van'、'truck'、'bicycle'、'儲存區'
uphillEfficiency	指定當車輛提升高度 (時，將儲存在燃料中的化學能源轉換為潛在能源的效率， 亦即 PotentialEnergyGained/FuelEnergyConsumed) 。使用fuelEnergyDensityInMJoulesPerLiter，將已耗用的燃料轉換成化學能源，以取得化油。 必須與 downhillEfficiency 配對。 允許的值範圍是 0.0 到 1/downhillEfficiency。 合理值：適用於 電力模型 ：0.27，適用於 電力模型 ：0.74
vehicleAxleWeight	每一車輛的重量，以公斤為單位。 值為 0 表示不會考慮每一個單位的權數限制。
vehicleCommercial	車輛用於商業用途，因此可能無法在某些道路上駕駛。
vehicleEngineType	車輛的引擎類型。 指定詳細的取用模型時，它必須與 vehicleEngineType 的值一致。 可能的值包括：'electricon'、'electric'
vehicleHeight	以公尺為單位的車輛高度。 值為 0 表示不會考慮高度限制。
vehicleLength	以公尺為單位的車輛長度。 值為 0 表示不會考慮長度限制。
vehicleLoadType	可能分類為危險材料且受限於某些道路的貨物類型。 可用的 vehicleLoadType 值是 US Hazmat 類別 1 到 9，加上用於其他國家/地區的一般分類。 以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以多次指定。 此參數目前只考慮 travelMode=truck。 可能的值包括：'USHazmatClass1'、 'USHazmatClass2'、'USHazmatClass3'、'USHazmatClass4'、'USHazmatClass5'、'USHazmatClass6'、'USHazmatClass7'、'USHazmatClass8'、'USHazmatClass9'、'otherHazmatExplosive'、'otherHazmatGeneral'、'otherHazmatHarmfulToWater'
vehicleMaxSpeed	以 km/小時為單位的車輛最大速度。 值為 0 表示將在路線規劃期間決定並套用車輛的適當值。 在路由規劃期間，可能會覆寫非零值。
vehicleWeight	車輛重量，以壓克為單位。 如果已設定任何 *效率參數，則為必要。 在取用模型的內容中使用時，它必須嚴格為正數。 系統會考慮權數限制。 如果未指定詳細的 取用模型 ， 且vehicleWeight 的值不是零，則會考慮重量限制。 在所有其他情況下，會忽略此參數。 Sensible 值：適用於 熱氣模型 ：1600，適用於 電力模型 ：1900
vehicleWidth	以公尺為單位的車輛寬度。 值為 0 表示不會考慮寬度限制。
windingness	令人興奮路線的回合層級。 此參數只能與 routeType=擷取搭配使用。 可能的值包括：'low'、'normal'、'high'

繼承的屬性

abortSignal	可用來中止要求的訊號。
customHeaders	{object}[customHeaders]使用者定義自定義要求標頭，將在傳送要求之前套用。
onDownloadProgress	下載進度時引發的回呼。
onUploadProgress	上傳進度時引發的回呼。
timeout	要求在自動終止之前可能需要的毫秒數。

屬性詳細資料

accelerationEfficiency

指定當車輛加速 (即 KineticEnergyGained/FuelEnergyConsumed) 時，將儲存在燃料中的化學能源轉換為 kinetic 能源的效率。使用fuelEnergyDensityInMJoulesPerLiter，將已耗用的燃料轉換成化學能源，以取得化油。 必須與 decelerationEfficiency 配對。

允許的值範圍是 0.0 到 1/decelerationEfficiency。

合理值：適用於 電力模型 ：0.33，適用於 電力模型 ：0.66

accelerationEfficiency?: number

屬性值

number

auxiliaryPowerInkW

指定用於維持輔助系統的耗電量，以千瓦為單位 (kW) 。 它可用來指定因 AC 系統、無線電、熱等裝置和系統等裝置和系統而耗用量。

合理值：1.7

auxiliaryPowerInkW?: string

屬性值

string

auxiliaryPowerInLitersPerHour

指定每小時的車輛輔助系統所耗用的燃料量。 它可用來指定因 AC 系統、無線電、熱等裝置和系統等裝置和系統而耗用量。

合理值：0.2

auxiliaryPowerInLitersPerHour?: number

屬性值

number

avoid

指定在判斷路由時，路由計算應該嘗試避免的事項。 可以在一個要求中多次指定，例如『&avoid=&avoid=tollRoads&avoid=feries』。 在 calculateReachableRange 要求中，不得使用已經使用值UsedRoads。 可能的值包括：'tollRoads'、'tolls'、'ferries'、'unpavedRoads'、'carpools'、'alreadyUsedRoads'、'borderCrossings'

avoid?: Avoid[]

屬性值

Avoid[]

constantSpeedConsumptionInkWhPerHundredkm

指定耗用量的速度相依元件。 以未排序的速度/耗用量率組清單的形式提供。 此清單會定義耗用量曲線上的點。 找到不在清單中的速度耗用量率，如下所示：

• 透過線性插補，如果指定的速度位於清單中的兩個速度之間，則為

• 依線性外推，否則假設常數 (ーSpeed/ЛSpeed) 由清單中的最接近兩個點所決定

此清單必須包含介於 1 到 25 點 (內含) ，而且可能不會包含相同速度的重複點。 如果它只包含單一點，則會使用該點的耗用量率，而不需進一步處理。

針對最大速度指定的耗用量必須大於或等於第二個最大速度的耗用量。 這可確保推斷不會導致負耗用量率。

同樣地，針對清單中的兩個最小速度所指定的耗用量值，不會導致任何較小速度的負耗用量率。

以 kWh/100km) 表示之耗用量值的有效範圍 (介於 0.01 到 100000.0 之間。

合理值：50,8.2：130,21.3

需要此參數才能用於 電力耗用量模型。

constantSpeedConsumptionInkWhPerHundredkm?: string

屬性值

string

constantSpeedConsumptionInLitersPerHundredkm

指定耗用量的速度相依元件。 以未排序的冒號分隔速度清單提供，& 耗用量率組。 此清單會定義耗用量曲線上的點。 找到不在清單中的速度耗用量率，如下所示：

• 透過線性插補，如果指定的速度位於清單中的兩個速度之間，則為

• 依線性外推，否則假設常數 (ーSpeed/ЛSpeed) 由清單中的最接近兩個點所決定

此清單必須包含介於 1 到 25 點 (內含) ，而且可能不會包含相同速度的重複點。 如果它只包含單一點，則會使用該點的耗用量率，而不需進一步處理。

針對最大速度指定的耗用量必須大於或等於第二個最大速度的耗用量。 這可確保推斷不會導致負耗用量率。

同樣地，針對清單中的兩個最小速度所指定的耗用量值，不會導致任何較小速度的負耗用量率。

以 l/100km 表示 (取用值的有效範圍，) 介於 0.01 到 100000.0 之間。

合理值：50,6.3：130,11.5

注意 ：此參數是 必要條件取用模型。

constantSpeedConsumptionInLitersPerHundredkm?: number

屬性值

number

currentChargeInkWh

指定以千瓦時為單位的目前電力供應 (kWh) 。 此參數與 MaxChargeInkWh 參數共存。

允許的值範圍是 0.0 到 maxChargeInkWh。

合理值：43

currentChargeInkWh?: string

屬性值

string

currentFuelInLiters

指定目前的燃料供應量。 合理值：55

currentFuelInLiters?: number

屬性值

number

decelerationEfficiency

指定當車輛減速 (時，將動態能源轉換成節省的 (不會耗用) 油的效率 ，亦即，在) 中減速/KineticEnergySaved/KineticEnergyLost。使用fuelEnergyDensityInMJoulesPerLiter，將已儲存的 (未耗用的) 燃料轉換為能源，以取得化化EnergySaved。 必須與 accelerationEfficiency 配對。

允許的值範圍是 0.0 到 1/accelerationEfficiency。

合理值：適用於 電力模型 ：0.83，適用於 電力模型 ：0.91

decelerationEfficiency?: number

屬性值

number

departAt

從原點出發的日期和時間。 目前以外的出發時間必須指定為 dateTime。 如果未指定時區位移，則會假設為原點的時差。 futureAt 值必須是日期時間格式 (1996-12-19T16：39：57-08：00) 。

departAt?: Date

屬性值

Date

downhillEfficiency

指定當車輛失去高度 (時，將潛在能源轉換為未耗用 () 燃料的效率 ，亦即，在) 中將可能能源轉換為節省的能源。使用fuelEnergyDensityInMJoulesPerLiter，將已儲存的 (未耗用的) 燃料轉換為能源，以取得化化EnergySaved。 必須與 uphillEfficiency 配對。

允許的值範圍是 0.0 到 1/uphillEfficiency。

合理值：適用於 電力模型 ：0.51，適用於 電力模型 ：0.73

downhillEfficiency?: number

屬性值

number

energyBudgetInkWh

以千瓦時為單位的電力預算 (kWh) ，可決定可使用指定的電力耗用量模型來消耗的最大範圍。 如果 vehicleEngineType 為 Electric，且未使用 timeBudgetInSec，則需要此參數。 必須提供 fuelBudgetInLiters、energyBudgetInkWh 或 timeBudgetInSec。

energyBudgetInkWh?: number

屬性值

number

fuelBudgetInLiters

油箱預算，決定可使用指定之耗用量模型來擷取的最大範圍。 如果 vehicleEngineType 為一個系統，且未使用 timeBudgetInSec，則需要此參數。 必須提供 fuelBudgetInLiters、energyBudgetInkWh 或 timeBudgetInSec。

fuelBudgetInLiters?: number

屬性值

number

fuelEnergyDensityInMJoulesPerLiter

指定在 MJ) (一次加油中儲存的化學能源量。 它會與 *效率 參數搭配使用，以在已儲存或耗用的能源和燃料之間進行轉換。 例如，能源密度是 34.2 MJ/l，而 35.8 MJ/l 則用於燃料。 如果已設定任何 *Efficiency 參數，則需要此參數。

合理值：34.2

fuelEnergyDensityInMJoulesPerLiter?: number

屬性值

number

hilliness

令人驚豔的路線程度。 此參數只能與 =ining 搭配 routeType使用。 可能的值包括：'low'、'normal'、'high'

hilliness?: Hilliness

屬性值

Hilliness

maxChargeInkWh

指定可能儲存在車輛電池中 (kWh) 以千瓦時為單位的電力供應量上限。 此參數與 currentChargeInkWh 參數共存。

最小值必須大於或等於 currentChargeInkWh。

合理值：85

maxChargeInkWh?: string

屬性值

string

routeType

要求的路由類型。 可能的值包括：'fastest'、'shortest'、'eco'、'存留'

routeType?: RouteType

屬性值

RouteType

timeBudgetInSec

以秒為單位的時間預算，可決定可使用駕駛時間進行的最大範圍。 耗用量參數只會影響生態系統路線，進而間接影響駕駛時間。 如果未使用 fuelBudgetInLiters 或 energyBudgetInkWh，則需要此參數。 必須提供 fuelBudgetInLiters、energyBudgetInkWh 或 timeBudgetInSec。

timeBudgetInSec?: number

屬性值

number

traffic

可能的值：

• true - 在路由期間考慮所有可用的流量資訊
• false - 在路由期間忽略目前的流量數據。 請注意，雖然在路由期間會忽略目前的交通數據，但有效道路速度的歷史交通影響仍會納入。

traffic?: boolean

屬性值

boolean

travelMode

所要求路線的行進模式。 請注意，要求的 travelMode 可能無法用於整個路線。 如果要求之 travelMode 不適用於特定區段，該區段之回應的 travelMode 元素將會是其他專案。 請注意，旅遊模式總線、車車、計程車和貨車都是 BETA 功能。 所有區域都無法使用完整限制數據。 在 calculateReachableRange 要求中，不得使用自行車和自行車的值。 可能的值包括：'car'、'truck'、'taxi'、'bus'、'van'、'truck'、'bicycle'、'儲存區'

travelMode?: TravelMode

屬性值

TravelMode

uphillEfficiency

指定當車輛提升高度 (時，將儲存在燃料中的化學能源轉換為潛在能源的效率， 亦即 PotentialEnergyGained/FuelEnergyConsumed) 。使用fuelEnergyDensityInMJoulesPerLiter，將已耗用的燃料轉換成化學能源，以取得化油。 必須與 downhillEfficiency 配對。

允許的值範圍是 0.0 到 1/downhillEfficiency。

合理值：適用於 電力模型 ：0.27，適用於 電力模型 ：0.74

uphillEfficiency?: number

屬性值

number

vehicleAxleWeight

每一車輛的重量，以公斤為單位。 值為 0 表示不會考慮每一個單位的權數限制。

vehicleAxleWeight?: number

屬性值

number

vehicleCommercial

車輛用於商業用途，因此可能無法在某些道路上駕駛。

vehicleCommercial?: boolean

屬性值

boolean

vehicleEngineType

車輛的引擎類型。 指定詳細的取用模型時，它必須與 vehicleEngineType 的值一致。 可能的值包括：'electricon'、'electric'

vehicleEngineType?: VehicleEngineType

屬性值

VehicleEngineType

vehicleHeight

以公尺為單位的車輛高度。 值為 0 表示不會考慮高度限制。

vehicleHeight?: number

屬性值

number

vehicleLength

以公尺為單位的車輛長度。 值為 0 表示不會考慮長度限制。

vehicleLength?: number

屬性值

number

vehicleLoadType

可能分類為危險材料且受限於某些道路的貨物類型。 可用的 vehicleLoadType 值是 US Hazmat 類別 1 到 9，加上用於其他國家/地區的一般分類。 以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以多次指定。 此參數目前只考慮 travelMode=truck。 可能的值包括：'USHazmatClass1'、 'USHazmatClass2'、'USHazmatClass3'、'USHazmatClass4'、'USHazmatClass5'、'USHazmatClass6'、'USHazmatClass7'、'USHazmatClass8'、'USHazmatClass9'、'otherHazmatExplosive'、'otherHazmatGeneral'、'otherHazmatHarmfulToWater'

vehicleLoadType?: VehicleLoadType

屬性值

VehicleLoadType

vehicleMaxSpeed

以 km/小時為單位的車輛最大速度。 值為 0 表示將在路線規劃期間決定並套用車輛的適當值。 在路由規劃期間，可能會覆寫非零值。

vehicleMaxSpeed?: number

屬性值

number

vehicleWeight

車輛重量，以壓克為單位。

• 如果已設定任何 *效率參數，則為必要。

• 在取用模型的內容中使用時，它必須嚴格為正數。 系統會考慮權數限制。

• 如果未指定詳細的 取用模型 ， 且vehicleWeight 的值不是零，則會考慮重量限制。

• 在所有其他情況下，會忽略此參數。

Sensible 值：適用於 熱氣模型 ：1600，適用於 電力模型 ：1900

vehicleWeight?: number

屬性值

number

vehicleWidth

以公尺為單位的車輛寬度。 值為 0 表示不會考慮寬度限制。

vehicleWidth?: number

屬性值

number

windingness

令人興奮路線的回合層級。 此參數只能與 routeType=擷取搭配使用。 可能的值包括：'low'、'normal'、'high'

windingness?: Windingness

屬性值

Windingness

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

繼承自 RequestOptionsBase.abortSignal

customHeaders

{object}[customHeaders]使用者定義自定義要求標頭，將在傳送要求之前套用。

customHeaders?: [key: string]: string

屬性值

[key: string]: string

繼承自 RequestOptionsBase.customHeaders

onDownloadProgress

下載進度時引發的回呼。

onDownloadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

繼承自 RequestOptionsBase.onDownloadProgress

onUploadProgress

上傳進度時引發的回呼。

onUploadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

繼承自 RequestOptionsBase.onUploadProgress

timeout

要求在自動終止之前可能需要的毫秒數。

timeout?: number

屬性值

number

繼承自 RequestOptionsBase.timeout