RouteRequestRouteMatrixQueryParamProperties interface

套件:

@azure-rest/maps-route

屬性

arriveAt	抵達目的地點的日期和時間，其格式為 值，如 rfC 3339 第 5339 節 5.6所定義，並具有選擇性時區位移。 如果未指定時區位移，則會假設為目的地點的位移。 範例： 2023-12-19T16：39：57 2023-12-19T16：39：57-08：00 arriveAt 參數不能與 departAt、minDeviationDistance 或 minDeviationTime搭配使用。
avoid	指定路由計算在判斷路由時應嘗試避免的事項。 可以在一個要求中指定多次，例如『&avoid=高速公路&avoid=tollRoads&avoid=ferries』。 在 [路由範圍] 要求中，不得使用已經使用的值UsedRoads。
computeTravelTimeFor	指定是否使用不同類型的交通資訊傳回額外的旅行時間（無、歷史、即時），以及預設的最佳估計旅行時間。
departAt	從原始點出發的日期和時間，格式為 dateTime 值，如 RFC 3339 第 5.6 節所定義，並具有選擇性時區位移。 未指定時區位移時，會假設其為源點的位移。 預設值： 現在 其他值：dateTime 範例： 2023-12-19T16：39：57 2023-12-19T16：39：57-08：00 departAt 參數不能與 arriveAt搭配使用。
hilliness	驚心動魄路線的丘陵程度。 此參數只能與 routeType=thrilling 搭配使用。
routeType	要求的路由類型。
sectionType	指定路由回應中報告哪些區段類型。 例如，如果 sectionType = 行人，則只傳回適合行人之區段。 可以在一個要求中指定多次，例如 '§ionType=carTrain§ionType=pedestrian§ionType=motorway'。 默認 sectionType 是指 travelMode 輸入。 根據預設，travelMode 會設定為 car
traffic	可能的值： true - 在路由期間考慮所有可用的流量資訊 false - 在路由期間忽略目前的流量數據。 請注意，雖然在路由期間忽略目前的交通數據，但歷史交通對有效道路速度的影響仍會納入其中。
travelMode	所要求路線的移動模式。 如果未定義，預設值為 『car』。 請注意，要求的 travelMode 可能無法用於整個路線。 當要求之 travelMode 不適用於特定區段時，該區段回應的 travelMode 元素將會是 “other”。 請注意，旅遊模式巴士、摩托車、計程車和麵包車是 BETA 功能。 所有區域都無法使用完整限制數據。
vehicleAxleWeight	每軸車輛重量以公斤為單位。 值為 0 表示不會考慮每個軸的重量限制。
vehicleHeight	車輛的高度以公尺為單位。 值為 0 表示不會考慮高度限制。
vehicleLength	車輛的長度以公尺為單位。 值為 0 表示不會考慮長度限制。
vehicleLoadType	可能分類為危險物質的貨物類型，並受限於某些道路。 可用的 vehicleLoadType 值為 US Hazmat 類別 1 到 9，加上用於其他國家/地區的泛型分類。 以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以指定多次。 此參數目前只考慮 travelMode=truck。
vehicleMaxSpeed	車輛的最大速度，以公里/小時為單位。 車輛配置檔中的最大速度用於檢查高速公路上是否允許車輛。 值為 0 表示將在路線規劃期間決定並套用車輛的適當值。 在路線規劃期間，可能會覆寫非零的值。 例如，目前的流量為 60 公里/小時。 如果車輛最大速度設定為每小時 50 公里，路由引擎會考慮 60 公里/小時，因為這是目前的情況。 如果車輛的最大速度提供為80公里/小時，但目前的交通流量為60公里/小時，則路由引擎將再次使用60公里/小時。
vehicleWeight	車輛重量以公斤為單位。
vehicleWidth	車輛寬度以公尺為單位。 值為 0 表示不會考慮寬度限制。
waitForResults	布爾值，指出是否要同步執行要求。 如果設定為 true，如果使用者的要求在 120 秒內完成，則會收到 200 回應。 否則，使用者會立即取得 202 回應。 如需 202 回應的詳細資訊，請參閱 API 描述。 僅支援異步要求。
windingness	驚心動魄路線的轉彎水準。 此參數只能與 routeType=thrilling 搭配使用。

屬性詳細資料

arriveAt

抵達目的地點的日期和時間，其格式為 值，如 rfC 3339 第 5339 節 5.6所定義，並具有選擇性時區位移。 如果未指定時區位移，則會假設為目的地點的位移。

範例：

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

arriveAt 參數不能與 departAt、minDeviationDistance 或 minDeviationTime搭配使用。

arriveAt?: string | Date

屬性值

string | Date

avoid

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

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

屬性值

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

computeTravelTimeFor

指定是否使用不同類型的交通資訊傳回額外的旅行時間（無、歷史、即時），以及預設的最佳估計旅行時間。

computeTravelTimeFor?: "none" | "all"

屬性值

"none" | "all"

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

hilliness

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

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

屬性值

"low" | "normal" | "high"

routeType

要求的路由類型。

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

屬性值

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

sectionType

指定路由回應中報告哪些區段類型。

例如，如果 sectionType = 行人，則只傳回適合行人之區段。 可以在一個要求中指定多次，例如 '§ionType=carTrain§ionType=pedestrian§ionType=motorway'。 默認 sectionType 是指 travelMode 輸入。 根據預設，travelMode 會設定為 car

sectionType?: ("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

屬性值

("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]

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"

vehicleAxleWeight

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

vehicleAxleWeight?: number

屬性值

number

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

車輛重量以公斤為單位。

vehicleWeight?: number

屬性值

number

vehicleWidth

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

vehicleWidth?: number

屬性值

number

waitForResults

布爾值，指出是否要同步執行要求。 如果設定為 true，如果使用者的要求在 120 秒內完成，則會收到 200 回應。 否則，使用者會立即取得 202 回應。 如需 202 回應的詳細資訊，請參閱 API 描述。 僅支援異步要求。

waitForResults?: boolean

屬性值

boolean

windingness

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

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

屬性值

"low" | "normal" | "high"