共用方式為

RouteInstructionOutput interface

  • 參考
套件:
@azure-rest/maps-route

一組描述機動的屬性，例如「向右轉」、「保持左轉」、「乘坐渡輪」、「乘坐高速公路」、「到達」。

屬性

combinedMessage

動作的人類可讀取訊息，結合下一個指示中的訊息。 有時候，可以將兩個連續的指示合併成單一指令，以便更容易遵循。 當發生這種情況時，possibleCombineWithNext 旗標會是 true。 例如：

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

指令 10 上的 possibleCombineWithNext 旗標為 true。 這向程式代碼指引的用戶端表示，它可以與指令 11 結合。 系統會針對要求人類可讀取指引的用戶端，自動合併這些指示。 combinedMessage 字段包含合併的訊息：

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

3 個字元 ISO 3166-1 alpha-3 國家/地區代碼。 例如美國
drivingSide

表示在機動點的左側與右側駕駛。
exitNumber

目前機動的高速公路出口數目。 如果結束有多個結束號碼，它們會以 “，”分隔，而且可能由 “-” 匯總，例如 “10， 13-15”。
instructionType

指示的類型，例如，轉向或變更道路形式。
junctionType

動作的交匯點類型。 對於較大的環圈，會產生兩個不同的指示來輸入和離開環島。
maneuver

識別動作的程序代碼。
message

人類可讀的動作訊息。
point

以緯度和經度表示的位置。
pointIndex

與指令點相對應之聚合線條 「points」 清單中的點索引。
possibleCombineWithNext

您可以選擇性地結合指令與下一個指令。 這可用來建置訊息，例如「向左轉，然後向右轉」。
roadNumbers

下一個重大路段的路號（s）在機動后，或道路（s）的路號要跟隨。 範例：[“E34”， “N205”]
roundaboutExitNumber

這表示在環島採取哪一個結束。
routeOffsetInMeters

從路線起點到指令點的距離。
signpostText

路標上的文字，與機動最相關的文字，或應遵循的方向。
stateCode

以 ISO 3166-2 代碼的第二個部分表示的國家/地區的細分（例如，州）。 這僅適用於某些國家/地區，例如美國、加拿大和墨西哥。
street

動作之後下一條重要路段的街道名稱，或應遵循的街道名稱。
travelTimeInSeconds

估計行進時間到對應至 routeOffsetInMeters 的點。
turnAngleInDecimalDegrees

指示的方向。 如果 junctionType 指出回合指示：

  • 180 = U-turn
  • [-179， -1] = 左轉
  • 0 = 直接開啟 （0 度』 回合 ）
  • [1， 179] = 右轉

如果 junctionType 表示 bifurcation 指令：

  • <0 - 保留左
  • >0 - 保持正確

屬性詳細資料

combinedMessage

動作的人類可讀取訊息，結合下一個指示中的訊息。 有時候，可以將兩個連續的指示合併成單一指令，以便更容易遵循。 當發生這種情況時，possibleCombineWithNext 旗標會是 true。 例如：

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

指令 10 上的 possibleCombineWithNext 旗標為 true。 這向程式代碼指引的用戶端表示，它可以與指令 11 結合。 系統會針對要求人類可讀取指引的用戶端，自動合併這些指示。 combinedMessage 字段包含合併的訊息：

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.

combinedMessage?: string

屬性值

string

countryCode

3 個字元 ISO 3166-1 alpha-3 國家/地區代碼。 例如美國

countryCode?: string

屬性值

string

drivingSide

表示在機動點的左側與右側駕駛。

drivingSide?: "LEFT" | "RIGHT"

屬性值

"LEFT" | "RIGHT"

exitNumber

目前機動的高速公路出口數目。 如果結束有多個結束號碼，它們會以 “，”分隔，而且可能由 “-” 匯總，例如 “10， 13-15”。

exitNumber?: string

屬性值

string

instructionType

指示的類型，例如，轉向或變更道路形式。

instructionType?: "TURN" | "ROAD_CHANGE" | "LOCATION_DEPARTURE" | "LOCATION_ARRIVAL" | "DIRECTION_INFO" | "LOCATION_WAYPOINT"

屬性值

"TURN" | "ROAD_CHANGE" | "LOCATION_DEPARTURE" | "LOCATION_ARRIVAL" | "DIRECTION_INFO" | "LOCATION_WAYPOINT"

junctionType

動作的交匯點類型。 對於較大的環圈，會產生兩個不同的指示來輸入和離開環島。

junctionType?: "REGULAR" | "ROUNDABOUT" | "BIFURCATION"

屬性值

"REGULAR" | "ROUNDABOUT" | "BIFURCATION"

maneuver

識別動作的程序代碼。

maneuver?: "ARRIVE" | "ARRIVE_LEFT" | "ARRIVE_RIGHT" | "DEPART" | "STRAIGHT" | "KEEP_RIGHT" | "BEAR_RIGHT" | "TURN_RIGHT" | "SHARP_RIGHT" | "KEEP_LEFT" | "BEAR_LEFT" | "TURN_LEFT" | "SHARP_LEFT" | "MAKE_UTURN" | "ENTER_MOTORWAY" | "ENTER_FREEWAY" | "ENTER_HIGHWAY" | "TAKE_EXIT" | "MOTORWAY_EXIT_LEFT" | "MOTORWAY_EXIT_RIGHT" | "TAKE_FERRY" | "ROUNDABOUT_CROSS" | "ROUNDABOUT_RIGHT" | "ROUNDABOUT_LEFT" | "ROUNDABOUT_BACK" | "TRY_MAKE_UTURN" | "FOLLOW" | "SWITCH_PARALLEL_ROAD" | "SWITCH_MAIN_ROAD" | "ENTRANCE_RAMP" | "WAYPOINT_LEFT" | "WAYPOINT_RIGHT" | "WAYPOINT_REACHED"

屬性值

"ARRIVE" | "ARRIVE_LEFT" | "ARRIVE_RIGHT" | "DEPART" | "STRAIGHT" | "KEEP_RIGHT" | "BEAR_RIGHT" | "TURN_RIGHT" | "SHARP_RIGHT" | "KEEP_LEFT" | "BEAR_LEFT" | "TURN_LEFT" | "SHARP_LEFT" | "MAKE_UTURN" | "ENTER_MOTORWAY" | "ENTER_FREEWAY" | "ENTER_HIGHWAY" | "TAKE_EXIT" | "MOTORWAY_EXIT_LEFT" | "MOTORWAY_EXIT_RIGHT" | "TAKE_FERRY" | "ROUNDABOUT_CROSS" | "ROUNDABOUT_RIGHT" | "ROUNDABOUT_LEFT" | "ROUNDABOUT_BACK" | "TRY_MAKE_UTURN" | "FOLLOW" | "SWITCH_PARALLEL_ROAD" | "SWITCH_MAIN_ROAD" | "ENTRANCE_RAMP" | "WAYPOINT_LEFT" | "WAYPOINT_RIGHT" | "WAYPOINT_REACHED"

message

人類可讀的動作訊息。

message?: string

屬性值

string

point

以緯度和經度表示的位置。

point?: LatLongPairOutput

屬性值

LatLongPairOutput

pointIndex

與指令點相對應之聚合線條 「points」 清單中的點索引。

pointIndex?: number

屬性值

number

possibleCombineWithNext

您可以選擇性地結合指令與下一個指令。 這可用來建置訊息，例如「向左轉，然後向右轉」。

possibleCombineWithNext?: boolean

屬性值

boolean

roadNumbers

下一個重大路段的路號（s）在機動后，或道路（s）的路號要跟隨。 範例：[“E34”， “N205”]

roadNumbers?: string[]

屬性值

string[]

roundaboutExitNumber

這表示在環島採取哪一個結束。

roundaboutExitNumber?: number

屬性值

number

routeOffsetInMeters

從路線起點到指令點的距離。

routeOffsetInMeters?: number

屬性值

number

signpostText

路標上的文字，與機動最相關的文字，或應遵循的方向。

signpostText?: string

屬性值

string

stateCode

以 ISO 3166-2 代碼的第二個部分表示的國家/地區的細分（例如，州）。 這僅適用於某些國家/地區，例如美國、加拿大和墨西哥。

stateCode?: string

屬性值

string

street

動作之後下一條重要路段的街道名稱，或應遵循的街道名稱。

street?: string

屬性值

string

travelTimeInSeconds

估計行進時間到對應至 routeOffsetInMeters 的點。

travelTimeInSeconds?: number

屬性值

number

turnAngleInDecimalDegrees

指示的方向。 如果 junctionType 指出回合指示：

  • 180 = U-turn
  • [-179， -1] = 左轉
  • 0 = 直接開啟 （0 度』 回合 ）
  • [1， 179] = 右轉

如果 junctionType 表示 bifurcation 指令：

  • <0 - 保留左
  • >0 - 保持正確
turnAngleInDecimalDegrees?: number

屬性值

number