RouteInstructionOutput interface

Пакет:

@azure-rest/maps-route

Набор атрибутов, описывающих маневр, например "Повернуть вправо", "Сохранить слева", "Взять паром", "Взять автомагистраль", "Прибыть".

Свойства

combinedMessage	Читаемое человеком сообщение для маневра в сочетании с сообщением из следующей инструкции. Иногда можно объединить две последовательные инструкции в одну инструкцию, что упрощает выполнение. Если это так, флаг возможнойCombineWithNext будет иметь значение true. Например: 10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam Флаг possibleCombineWithNext в инструкции 10 имеет значение 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 код страны альфа-3. Например, США.
drivingSide	Указывает левую руку против правой стороны вождения в точке маневра.
exitNumber	Номера выхода шоссе, снятого текущим маневром. Если выход имеет несколько номеров выхода, они будут разделены "" и, возможно, агрегированы по "-", например "10, 13-15".
instructionType	Тип инструкции, например поворот или изменение формы дороги.
junctionType	Тип соединения, где проходит маневр. Для более крупных округлений создаются две отдельные инструкции для ввода и выхода из круговой области.
maneuver	Код, определяющий маневр.
message	Читаемое человеком сообщение для маневра.
point	Расположение, представленное в виде широты и долготы.
pointIndex	Индекс точки в списке многострочного "точек", соответствующих точке инструкции.
possibleCombineWithNext	При необходимости можно объединить инструкцию с следующей. Это можно использовать для создания сообщений, таких как "Повернуть влево, а затем повернуть вправо".
roadNumbers	Номера дорог следующего значительного дорожного сегмента после маневра или дороги, которые следует следовать. Пример: ["E34", "N205"]
roundaboutExitNumber	Это указывает, какой выход следует принять в круглой кольцевой области.
routeOffsetInMeters	Расстояние от начала маршрута до точки инструкции.
signpostText	Текст на знаке, который наиболее относится к маневру, или к направлению, которое следует следовать.
stateCode	Подразделение (например, государство) страны, представленное второй частью кода ISO 3166-2. Это доступно только для некоторых стран и регионов, таких как США, Канада и Мексика.
street	Название улицы следующего значительного дорожного сегмента после маневра или улицы, которую следует следовать.
travelTimeInSeconds	Предполагаемое время путешествия до точки, соответствующей маршрутуOffsetInMeters.
turnAngleInDecimalDegrees	Указывает направление инструкции. Если junctionType указывает инструкцию поворота: 180 = разворот [-179, -1] = левый поворот 0 = прямо в (поворот "0 градусов") [1, 179] = правый поворот Если junctionType указывает инструкцию бифуркации: <0 — держите слева >0 — держите право

Сведения о свойстве

combinedMessage

Читаемое человеком сообщение для маневра в сочетании с сообщением из следующей инструкции. Иногда можно объединить две последовательные инструкции в одну инструкцию, что упрощает выполнение. Если это так, флаг возможнойCombineWithNext будет иметь значение true. Например:

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

Флаг possibleCombineWithNext в инструкции 10 имеет значение 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 код страны альфа-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

Номера дорог следующего значительного дорожного сегмента после маневра или дороги, которые следует следовать. Пример: ["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

Предполагаемое время путешествия до точки, соответствующей маршрутуOffsetInMeters.

travelTimeInSeconds?: number

Значение свойства

number

turnAngleInDecimalDegrees

Указывает направление инструкции. Если junctionType указывает инструкцию поворота:

• 180 = разворот
• [-179, -1] = левый поворот
• 0 = прямо в (поворот "0 градусов")
• [1, 179] = правый поворот

Если junctionType указывает инструкцию бифуркации:

• <0 — держите слева
• >0 — держите право

turnAngleInDecimalDegrees?: number

Значение свойства

number