RouteGetRouteRangeQueryParamProperties interface

套件:

@azure-rest/maps-route

屬性

accelerationEfficiency	指定當車輛加速 時，將儲存在燃料中的化學能量轉換為動能的效率（即 KineticEnergyGained/ChemicalEnergyConsumed）。ChemicalEnergyConsumed 是利用 燃料EnergyDensityInMJoulesPerLiter，將消耗的燃料轉換成化學能量來取得。 必須與 減速效率配對。 允許的值範圍是 0.0 到 1/減速效率。 合理的值：適用於 燃燒模型：0.33，適用於 電動模型： 0.66
auxiliaryPowerInkW	指定以千瓦為單位維持輔助系統所使用的電力量。 它可以用來指定因 AC 系統、無線電、加熱等裝置和系統而耗用量。 合理的值：1.7
auxiliaryPowerInLitersPerHour	指定以每小時升為單位，用於維持車輛輔助系統的燃料量。 它可以用來指定因 AC 系統、無線電、加熱等裝置和系統而耗用量。 明智的值：0.2
avoid	指定路由計算在判斷路由時應嘗試避免的事項。 可以在一個要求中指定多次，例如『&avoid=高速公路&avoid=tollRoads&avoid=ferries』。 在 [路由範圍] 要求中，不得使用已經使用的值UsedRoads。
constantSpeedConsumptionInkWhPerHundredkm	指定耗用量的速度相依元件。 以未排序的速度/耗用量率組清單的形式提供。 此清單會定義耗用量曲線上的點。 找到不在清單中之速度的耗用量率，如下所示： 如果指定的速度位於清單中的兩個速度之間，則為線性插補 依線性外推，否則假設由清單中最接近兩個點所決定的常數 （1Consumption/OcSpeed） 清單必須包含介於 1 到 25 點之間（含），且不能包含相同速度的重複點。 如果它只包含單一點，則會使用該點的耗用量率，而不需進一步處理。 針對最大速度指定的耗用量必須大於或等於倒數第二個最大速度的耗用量。 這可確保外推不會導致負耗用量率。 同樣地，針對清單中兩個最小速度指定的耗用量值，無法導致任何較小速度的負耗用量率。 耗用量值的有效範圍（以 kWh/100 公里表示）介於 0.01 到 100000.0 之間。 合理的值：50,8.2：130,21.3 電耗模型需要此參數，。
constantSpeedConsumptionInLitersPerHundredkm	指定耗用量的速度相依元件。 提供為非排序的冒號分隔速度清單，& 耗用量率組。 此清單會定義耗用量曲線上的點。 找到不在清單中之速度的耗用量率，如下所示： 如果指定的速度位於清單中的兩個速度之間，則為線性插補 依線性外推，否則假設由清單中最接近兩個點所決定的常數 （1Consumption/OcSpeed） 清單必須包含介於 1 到 25 點之間（含），且不能包含相同速度的重複點。 如果它只包含單一點，則會使用該點的耗用量率，而不需進一步處理。 針對最大速度指定的耗用量必須大於或等於倒數第二個最大速度的耗用量。 這可確保外推不會導致負耗用量率。 同樣地，針對清單中兩個最小速度指定的耗用量值，無法導致任何較小速度的負耗用量率。 耗用量值的有效範圍（以 l/100 公里表示）介於 0.01 到 100000.0 之間。 合理的值：50,6.3：130,11.5 附注：燃燒耗用量模型需要此參數。
currentChargeInkWh	指定目前千瓦時（kWh）的電力供應。 此參數與 maxChargeInkWh 參數 並存。 允許的值範圍是 0.0 到 maxChargeInkWh。 明智的值：43
currentFuelInLiters	指定目前以升為單位的燃料供應。 明智的值：55
decelerationEfficiency	指定當車輛減速 （即 ChemicalEnergySaved/KineticEnergyLost）時，將動能轉換為節約（未耗用）燃料的效率。ChemicalEnergySaved 是利用 燃料EnergyDensityInMJoulesPerLiter，將已儲存的（未消耗）燃料轉換為能源來取得。 必須與 accelerationEfficiency配對。 允許的值範圍是 0.0 到 1/accelerationEfficiency。 合理值：適用於 燃燒模型：0.83，適用於 電動模型： 0.91
departAt	從原始點出發的日期和時間，格式為 dateTime 值，如 RFC 3339 第 5.6 節所定義，並具有選擇性時區位移。 未指定時區位移時，會假設其為源點的位移。 預設值： 現在 其他值：dateTime 範例： 2023-12-19T16：39：57 2023-12-19T16：39：57-08：00 departAt 參數不能與 arriveAt搭配使用。
distanceBudgetInMeters	以公尺為單位的距離預算，決定可使用駕駛距離來行駛的最大範圍。 取用模型只會在 routeType 為 eco 時影響範圍。 必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
downhillEfficiency	指定當車輛失去海拔 （即 ChemicalEnergySaved/PotentialEnergyLost）時，將潛在能源轉換為節約（未耗用）燃料的效率。ChemicalEnergySaved 是利用 燃料EnergyDensityInMJoulesPerLiter，將已儲存的（未消耗）燃料轉換為能源來取得。 必須與 uphillEfficiency配對。 允許的值範圍是 0.0 到 1/uphillEfficiency。 合理的值：適用於 燃燒模型：0.51，適用於 電動模型：0.73
energyBudgetInkWh	千瓦時（kWh）的電力能源預算，決定可使用指定的用電量模型來行駛的最大範圍。 使用 energyBudgetInkWh 時，必須指定詳細的用電量模型。 必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
fuelBudgetInLiters	以升為單位的燃料預算，決定可使用指定的燃燒耗用量模型來行駛的最大範圍。 使用 fuelBudgetInLiters 時，必須指定詳細的燃燒耗用量模型。 必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
fuelEnergyDensityInMJoulesPerLiter	指定以兆焦耳（MJ）儲存在一升燃料中的化學能量量。 它與 *效率 參數搭配使用，用於節省或耗用的能源和燃料之間的轉換。 例如，汽油的能源密度為 34.2 MJ/l，柴油為 35.8 MJ/l。 如果已設定任何 *Efficiency 參數，則需要此參數。 明智的值：34.2
hilliness	驚心動魄路線的丘陵程度。 此參數只能與 routeType=thrilling 搭配使用。
maxChargeInkWh	指定可能儲存在車輛電池中的千瓦時（kWh）最大電力供應量。 此參數與 currentChargeInkWh 參數 並存。 最小值必須大於或等於 currentChargeInkWh。 明智的值：85
query	範圍計算應從中開始的座標。
routeType	要求的路由類型。
timeBudgetInSec	以秒為單位的時間預算，決定可使用駕駛時間行駛的最大範圍。 取用模型只會在 routeType 為 eco 時影響範圍。 必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。
traffic	可能的值： true - 在路由期間考慮所有可用的流量資訊 false - 在路由期間忽略目前的流量數據。 請注意，雖然在路由期間忽略目前的交通數據，但歷史交通對有效道路速度的影響仍會納入其中。
travelMode	所要求路線的移動模式。 如果未定義，預設值為 『car』。 請注意，要求的 travelMode 可能無法用於整個路線。 當要求之 travelMode 不適用於特定區段時，該區段回應的 travelMode 元素將會是 “other”。 請注意，旅遊模式巴士、摩托車、計程車和麵包車是 BETA 功能。 所有區域都無法使用完整限制數據。
uphillEfficiency	指定當車輛提高高度 時，將儲存在燃料中的化學能量轉換為潛在能源的效率（即 PotentialEnergyGained/ChemicalEnergyConsumed）。ChemicalEnergyConsumed 是利用 燃料EnergyDensityInMJoulesPerLiter，將消耗的燃料轉換成化學能量來取得。 必須與 downhillEfficiency配對。 允許的值範圍是 0.0 到 1/downhillEfficiency。 合理的值：適用於 燃燒模型：0.27，適用於 電動模型： 0.74
vehicleAxleWeight	每軸車輛重量以公斤為單位。 值為 0 表示不會考慮每個軸的重量限制。
vehicleCommercial	車輛是否用於商業用途。 可能不允許商用車輛在一些道路上行駛。
vehicleEngineType	車輛的引擎類型。 指定詳細的取用模型時，它必須與 vehicleEngineType的值一致。
vehicleHeight	車輛的高度以公尺為單位。 值為 0 表示不會考慮高度限制。
vehicleLength	車輛的長度以公尺為單位。 值為 0 表示不會考慮長度限制。
vehicleLoadType	可能分類為危險物質的貨物類型，並受限於某些道路。 可用的 vehicleLoadType 值為 US Hazmat 類別 1 到 9，加上用於其他國家/地區的泛型分類。 以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以指定多次。 此參數目前只考慮 travelMode=truck。
vehicleMaxSpeed	車輛的最大速度，以公里/小時為單位。 車輛配置檔中的最大速度用於檢查高速公路上是否允許車輛。 值為 0 表示將在路線規劃期間決定並套用車輛的適當值。 在路線規劃期間，可能會覆寫非零的值。 例如，目前的流量為 60 公里/小時。 如果車輛最大速度設定為每小時 50 公里，路由引擎會考慮 60 公里/小時，因為這是目前的情況。 如果車輛的最大速度提供為80公里/小時，但目前的交通流量為60公里/小時，則路由引擎將再次使用60公里/小時。
vehicleWeight	車輛重量以公斤為單位。 如果已設定任何 *效率參數，則這是強制性的。 在取用模型的內容中使用時，它必須嚴格為正數。 考慮權數限制。 如果未指定詳細的 耗用量模型，且 車輛重量 的值為非零，則會考慮重量限制。 在其他所有情況下，會忽略此參數。 合理的值：適用於 燃燒模型：1600，適用於 電動模型：1900
vehicleWidth	車輛寬度以公尺為單位。 值為 0 表示不會考慮寬度限制。
windingness	驚心動魄路線的轉彎水準。 此參數只能與 routeType=thrilling 搭配使用。

屬性詳細資料

accelerationEfficiency

指定當車輛加速 時，將儲存在燃料中的化學能量轉換為動能的效率（即 KineticEnergyGained/ChemicalEnergyConsumed）。ChemicalEnergyConsumed 是利用 燃料EnergyDensityInMJoulesPerLiter，將消耗的燃料轉換成化學能量來取得。

必須與 減速效率配對。

允許的值範圍是 0.0 到 1/減速效率。

合理的值：適用於 燃燒模型：0.33，適用於 電動模型： 0.66

accelerationEfficiency?: number

屬性值

number

auxiliaryPowerInkW

指定以千瓦為單位維持輔助系統所使用的電力量。

它可以用來指定因 AC 系統、無線電、加熱等裝置和系統而耗用量。

合理的值：1.7

auxiliaryPowerInkW?: number

屬性值

number

auxiliaryPowerInLitersPerHour

指定以每小時升為單位，用於維持車輛輔助系統的燃料量。

它可以用來指定因 AC 系統、無線電、加熱等裝置和系統而耗用量。

明智的值：0.2

auxiliaryPowerInLitersPerHour?: number

屬性值

number

avoid

指定路由計算在判斷路由時應嘗試避免的事項。 可以在一個要求中指定多次，例如『&avoid=高速公路&avoid=tollRoads&avoid=ferries』。 在 [路由範圍] 要求中，不得使用已經使用的值UsedRoads。

avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

屬性值

("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]

constantSpeedConsumptionInkWhPerHundredkm

指定耗用量的速度相依元件。

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

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

• 依線性外推，否則假設由清單中最接近兩個點所決定的常數 （1Consumption/OcSpeed）

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

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

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

耗用量值的有效範圍（以 kWh/100 公里表示）介於 0.01 到 100000.0 之間。

合理的值：50,8.2：130,21.3

電耗模型需要此參數，。

constantSpeedConsumptionInkWhPerHundredkm?: string

屬性值

string

constantSpeedConsumptionInLitersPerHundredkm

指定耗用量的速度相依元件。

提供為非排序的冒號分隔速度清單，& 耗用量率組。 此清單會定義耗用量曲線上的點。 找到不在清單中之速度的耗用量率，如下所示：

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

• 依線性外推，否則假設由清單中最接近兩個點所決定的常數 （1Consumption/OcSpeed）

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

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

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

耗用量值的有效範圍（以 l/100 公里表示）介於 0.01 到 100000.0 之間。

合理的值：50,6.3：130,11.5

附注：燃燒耗用量模型需要此參數。

constantSpeedConsumptionInLitersPerHundredkm?: string

屬性值

string

currentChargeInkWh

指定目前千瓦時（kWh）的電力供應。

此參數與 maxChargeInkWh 參數 並存。

允許的值範圍是 0.0 到 maxChargeInkWh。

明智的值：43

currentChargeInkWh?: number

屬性值

number

currentFuelInLiters

指定目前以升為單位的燃料供應。

明智的值：55

currentFuelInLiters?: number

屬性值

number

decelerationEfficiency

指定當車輛減速 （即 ChemicalEnergySaved/KineticEnergyLost）時，將動能轉換為節約（未耗用）燃料的效率。ChemicalEnergySaved 是利用 燃料EnergyDensityInMJoulesPerLiter，將已儲存的（未消耗）燃料轉換為能源來取得。

必須與 accelerationEfficiency配對。

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

合理值：適用於 燃燒模型：0.83，適用於 電動模型： 0.91

decelerationEfficiency?: number

屬性值

number

departAt

從原始點出發的日期和時間，格式為 dateTime 值，如 RFC 3339 第 5.6 節所定義，並具有選擇性時區位移。 未指定時區位移時，會假設其為源點的位移。

• 預設值： 現在
• 其他值：dateTime

範例：

• 2023-12-19T16：39：57
• 2023-12-19T16：39：57-08：00

departAt 參數不能與 arriveAt搭配使用。

departAt?: string | Date

屬性值

string | Date

distanceBudgetInMeters

以公尺為單位的距離預算，決定可使用駕駛距離來行駛的最大範圍。 取用模型只會在 routeType 為 eco 時影響範圍。
必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。

distanceBudgetInMeters?: number

屬性值

number

downhillEfficiency

指定當車輛失去海拔 （即 ChemicalEnergySaved/PotentialEnergyLost）時，將潛在能源轉換為節約（未耗用）燃料的效率。ChemicalEnergySaved 是利用 燃料EnergyDensityInMJoulesPerLiter，將已儲存的（未消耗）燃料轉換為能源來取得。

必須與 uphillEfficiency配對。

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

合理的值：適用於 燃燒模型：0.51，適用於 電動模型：0.73

downhillEfficiency?: number

屬性值

number

energyBudgetInkWh

千瓦時（kWh）的電力能源預算，決定可使用指定的用電量模型來行駛的最大範圍。
使用 energyBudgetInkWh 時，必須指定詳細的用電量模型。
必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。

energyBudgetInkWh?: number

屬性值

number

fuelBudgetInLiters

以升為單位的燃料預算，決定可使用指定的燃燒耗用量模型來行駛的最大範圍。
使用 fuelBudgetInLiters 時，必須指定詳細的燃燒耗用量模型。
必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。

fuelBudgetInLiters?: number

屬性值

number

fuelEnergyDensityInMJoulesPerLiter

指定以兆焦耳（MJ）儲存在一升燃料中的化學能量量。 它與 *效率 參數搭配使用，用於節省或耗用的能源和燃料之間的轉換。 例如，汽油的能源密度為 34.2 MJ/l，柴油為 35.8 MJ/l。

如果已設定任何 *Efficiency 參數，則需要此參數。

明智的值：34.2

fuelEnergyDensityInMJoulesPerLiter?: number

屬性值

number

hilliness

驚心動魄路線的丘陵程度。 此參數只能與 routeType=thrilling 搭配使用。

hilliness?: "low" | "normal" | "high"

屬性值

"low" | "normal" | "high"

maxChargeInkWh

指定可能儲存在車輛電池中的千瓦時（kWh）最大電力供應量。

此參數與 currentChargeInkWh 參數 並存。

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

明智的值：85

maxChargeInkWh?: number

屬性值

number

query

範圍計算應從中開始的座標。

query: number[]

屬性值

number[]

routeType

要求的路由類型。

routeType?: "fastest" | "shortest" | "eco" | "thrilling"

屬性值

"fastest" | "shortest" | "eco" | "thrilling"

timeBudgetInSec

以秒為單位的時間預算，決定可使用駕駛時間行駛的最大範圍。 取用模型只會在 routeType 為 eco 時影響範圍。
必須使用一個預算（fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters）。

timeBudgetInSec?: number

屬性值

number

traffic

可能的值：

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

traffic?: boolean

屬性值

boolean

travelMode

所要求路線的移動模式。 如果未定義，預設值為 『car』。 請注意，要求的 travelMode 可能無法用於整個路線。 當要求之 travelMode 不適用於特定區段時，該區段回應的 travelMode 元素將會是 “other”。 請注意，旅遊模式巴士、摩托車、計程車和麵包車是 BETA 功能。 所有區域都無法使用完整限制數據。

travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

屬性值

"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"

uphillEfficiency

指定當車輛提高高度 時，將儲存在燃料中的化學能量轉換為潛在能源的效率（即 PotentialEnergyGained/ChemicalEnergyConsumed）。ChemicalEnergyConsumed 是利用 燃料EnergyDensityInMJoulesPerLiter，將消耗的燃料轉換成化學能量來取得。

必須與 downhillEfficiency配對。

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

合理的值：適用於 燃燒模型：0.27，適用於 電動模型： 0.74

uphillEfficiency?: number

屬性值

number

vehicleAxleWeight

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

vehicleAxleWeight?: number

屬性值

number

vehicleCommercial

車輛是否用於商業用途。 可能不允許商用車輛在一些道路上行駛。

vehicleCommercial?: boolean

屬性值

boolean

vehicleEngineType

車輛的引擎類型。 指定詳細的取用模型時，它必須與 vehicleEngineType的值一致。

vehicleEngineType?: "combustion" | "electric"

屬性值

"combustion" | "electric"

vehicleHeight

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

vehicleHeight?: number

屬性值

number

vehicleLength

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

vehicleLength?: number

屬性值

number

vehicleLoadType

可能分類為危險物質的貨物類型，並受限於某些道路。 可用的 vehicleLoadType 值為 US Hazmat 類別 1 到 9，加上用於其他國家/地區的泛型分類。 以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以指定多次。 此參數目前只考慮 travelMode=truck。

vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

屬性值

"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"

vehicleMaxSpeed

車輛的最大速度，以公里/小時為單位。 車輛配置檔中的最大速度用於檢查高速公路上是否允許車輛。

• 值為 0 表示將在路線規劃期間決定並套用車輛的適當值。

• 在路線規劃期間，可能會覆寫非零的值。 例如，目前的流量為 60 公里/小時。 如果車輛最大速度設定為每小時 50 公里，路由引擎會考慮 60 公里/小時，因為這是目前的情況。 如果車輛的最大速度提供為80公里/小時，但目前的交通流量為60公里/小時，則路由引擎將再次使用60公里/小時。

vehicleMaxSpeed?: number

屬性值

number

vehicleWeight

車輛重量以公斤為單位。

• 如果已設定任何 *效率參數，則這是強制性的。

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

• 如果未指定詳細的 耗用量模型，且 車輛重量 的值為非零，則會考慮重量限制。

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

合理的值：適用於 燃燒模型：1600，適用於 電動模型：1900

vehicleWeight?: number

屬性值

number

vehicleWidth

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

vehicleWidth?: number

屬性值

number

windingness

驚心動魄路線的轉彎水準。 此參數只能與 routeType=thrilling 搭配使用。

windingness?: "low" | "normal" | "high"

屬性值

"low" | "normal" | "high"