你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

与指令点相对应的折线“磅”列表中的点的索引。
possibleCombineWithNext

可以选择将指令与下一个指令组合在一起。 这可用于生成消息，例如“向左转，然后向右转”。
roadNumbers

机动后下一条重要路段（s）或要跟踪的道路段的路号（s）。 示例：[“E34”、“N205”]
roundaboutExitNumber

这表示在环流处要采取的退出。
routeOffsetInMeters

从路线起点到指令点的距离。
signpostText

标志标上的文本与操纵最相关，或与应遵循的方向有关。
stateCode

国家/地区的细分（例如，状态）由 ISO 3166-2 代码的第二部分表示。 这仅适用于美国、加拿大和墨西哥等一些国家。
street

机动后下一条重要路段的街道名称，或应遵循的街道的名称。
travelTimeInSeconds

估计到与 routeOffsetInMeters 对应的点的行程时间。
turnAngleInDecimalDegrees

指示指令的方向。 如果 junctionType 指示轮次指令：

  • 180 = U 轮次
  • [-179， -1] = 左转
  • 0 = 直接打开 （'0 度' 轮次）
  • [1， 179] = 右转

如果 junctionType 指示分叉指令：

  • <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

与指令点相对应的折线“磅”列表中的点的索引。

pointIndex?: number

属性值

number

possibleCombineWithNext

可以选择将指令与下一个指令组合在一起。 这可用于生成消息，例如“向左转，然后向右转”。

possibleCombineWithNext?: boolean

属性值

boolean

roadNumbers

机动后下一条重要路段（s）或要跟踪的道路段的路号（s）。 示例：[“E34”、“N205”]

roadNumbers?: string[]

属性值

string[]

roundaboutExitNumber

这表示在环流处要采取的退出。

roundaboutExitNumber?: string

属性值

string

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 轮次
  • [-179， -1] = 左转
  • 0 = 直接打开 （'0 度' 轮次）
  • [1， 179] = 右转

如果 junctionType 指示分叉指令：

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

属性值

number