RouteInstructionOutput interface

  • リファレンス
パッケージ:
@azure-rest/maps-route

操縦を説明する一連の属性 (例: "右に曲がる"、"左に保つ"、"フェリーに乗る"、"高速道路に乗る"、"到着" など)。

プロパティ

combinedMessage

操作のための人間が判読できるメッセージと、次の命令からのメッセージを組み合わせたメッセージ。 場合によっては、2 つの連続する命令を 1 つの命令に結合して、簡単に従うことができます。 この場合、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

ISO 3166-1 alpha-3 国コード 3 文字。 例: 米国
drivingSide

操縦のポイントでの左手と右側の運転を示します。
exitNumber

現在の操縦によって取得された高速道路出口の数。 出口に複数の終了番号がある場合は、""" で区切られ、"-" で集計される可能性があります (例: "10,13-15")。
instructionType

指示の種類 (例: 道路の形状のターンまたは変更)。
junctionType

操縦が行われるジャンクションの種類。 より大きなラウンドアバウト交差点では、ラウンドアバウト交差点に入って離れる 2 つの個別の命令が生成されます。
maneuver

操縦を識別するコード。
message

操縦のための人間が判読できるメッセージ。
point

緯度と経度として表される場所。
pointIndex

命令のポイントに対応するポリラインの "ポイント" のリスト内のポイントのインデックス。
possibleCombineWithNext

必要に応じて、命令を次の命令と組み合わせることができます。 これを使用して、"左に曲がって右に曲がる" などのメッセージを作成できます。
roadNumbers

操縦後の次に重要な道路セグメントの道路番号、または従う道路の道路番号。 例: ["E34", "N205"]
roundaboutExitNumber

これは、ラウンドアバウトで実行する出口を示します。
routeOffsetInMeters

ルートの始点から命令のポイントまでの距離。
signpostText

操縦または従うべき方向に最も関連する道標のテキスト。
stateCode

ISO 3166-2 コードの 2 番目の部分で表される国の下位区分 (州など)。 これは、米国、カナダ、メキシコなどの一部の国でのみ使用できます。
street

操縦後の次の重要な道路セグメントの通り名、または従う必要がある通りの道路名。
travelTimeInSeconds

routeOffsetInMeters に対応するポイントまでの推定移動時間。
turnAngleInDecimalDegrees

命令の方向を示します。 junctionType がターン命令を示す場合:

  • 180 = U ターン
  • [-179, -1] = 左折
  • 0 = 直線 ('0 度' ターン)
  • [1, 179] = 右折

junctionType が分岐命令を示す場合:

  • <0 - 左のままにする
  • >0 - 右に保つ

プロパティの詳細

combinedMessage

操作のための人間が判読できるメッセージと、次の命令からのメッセージを組み合わせたメッセージ。 場合によっては、2 つの連続する命令を 1 つの命令に結合して、簡単に従うことができます。 この場合、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

ISO 3166-1 alpha-3 国コード 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

操縦が行われるジャンクションの種類。 より大きなラウンドアバウト交差点では、ラウンドアバウト交差点に入って離れる 2 つの個別の命令が生成されます。

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

命令のポイントに対応するポリラインの "ポイント" のリスト内のポイントのインデックス。

pointIndex?: number

プロパティ値

number

possibleCombineWithNext

必要に応じて、命令を次の命令と組み合わせることができます。 これを使用して、"左に曲がって右に曲がる" などのメッセージを作成できます。

possibleCombineWithNext?: boolean

プロパティ値

boolean

roadNumbers

操縦後の次に重要な道路セグメントの道路番号、または従う道路の道路番号。 例: ["E34", "N205"]

roadNumbers?: string[]

プロパティ値

string[]

roundaboutExitNumber

これは、ラウンドアバウトで実行する出口を示します。

roundaboutExitNumber?: string

プロパティ値

string

routeOffsetInMeters

ルートの始点から命令のポイントまでの距離。

routeOffsetInMeters?: number

プロパティ値

number

signpostText

操縦または従うべき方向に最も関連する道標のテキスト。

signpostText?: string

プロパティ値

string

stateCode

ISO 3166-2 コードの 2 番目の部分で表される国の下位区分 (州など)。 これは、米国、カナダ、メキシコなどの一部の国でのみ使用できます。

stateCode?: string

プロパティ値

string

street

操縦後の次の重要な道路セグメントの通り名、または従う必要がある通りの道路名。

street?: string

プロパティ値

string

travelTimeInSeconds

routeOffsetInMeters に対応するポイントまでの推定移動時間。

travelTimeInSeconds?: number

プロパティ値

number

turnAngleInDecimalDegrees

命令の方向を示します。 junctionType がターン命令を示す場合:

  • 180 = U ターン
  • [-179, -1] = 左折
  • 0 = 直線 ('0 度' ターン)
  • [1, 179] = 右折

junctionType が分岐命令を示す場合:

  • <0 - 左のままにする
  • >0 - 右に保つ
turnAngleInDecimalDegrees?: number

プロパティ値

number