RouteResultInstruction interface

Package:

azure-maps-rest

A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.

Properties

countryCode	3-character ISO 3166-1 alpha-3 country code. E.g. USA. NOTE: This property will not be serialized. It can only be populated by the server.
drivingSide	Indicates left-hand vs. right-hand side driving at the point of the maneuver. Possible values include: 'LEFT', 'RIGHT' NOTE: This property will not be serialized. It can only be populated by the server.
instructionType	Type of the instruction, e.g., turn or change of road form. Possible values include: 'TURN', 'ROAD_CHANGE', 'LOCATION_DEPARTURE', 'LOCATION_ARRIVAL', 'DIRECTION_INFO', 'LOCATION_WAYPOINT'
maneuver	A code identifying the maneuver. Possible values include: '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' NOTE: This property will not be serialized. It can only be populated by the server.
message	A human-readable message for the maneuver. NOTE: This property will not be serialized. It can only be populated by the server.
point
possibleCombineWithNext	It is possible to optionally combine the instruction with the next one. This can be used to build messages like "Turn left and then turn right". NOTE: This property will not be serialized. It can only be populated by the server.
routeOffsetInMeters	Distance from the start of the route to the point of the instruction. NOTE: This property will not be serialized. It can only be populated by the server.
street	Street name of the next significant road segment after the maneuver, or of the street that should be followed. NOTE: This property will not be serialized. It can only be populated by the server.
travelTimeInSeconds	Estimated travel time up to the point corresponding to routeOffsetInMeters. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

countryCode

3-character ISO 3166-1 alpha-3 country code. E.g. USA. NOTE: This property will not be serialized. It can only be populated by the server.

countryCode?: string

Property Value

string

drivingSide

Indicates left-hand vs. right-hand side driving at the point of the maneuver. Possible values include: 'LEFT', 'RIGHT' NOTE: This property will not be serialized. It can only be populated by the server.

drivingSide?: DrivingSide

Property Value

DrivingSide

instructionType

Type of the instruction, e.g., turn or change of road form. Possible values include: 'TURN', 'ROAD_CHANGE', 'LOCATION_DEPARTURE', 'LOCATION_ARRIVAL', 'DIRECTION_INFO', 'LOCATION_WAYPOINT'

instructionType?: GuidanceInstructionType

Property Value

GuidanceInstructionType

maneuver

A code identifying the maneuver. Possible values include: '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' NOTE: This property will not be serialized. It can only be populated by the server.

maneuver?: GuidanceManeuver

Property Value

GuidanceManeuver

message

A human-readable message for the maneuver. NOTE: This property will not be serialized. It can only be populated by the server.

message?: string

Property Value

string

point

point?: Coordinate

Property Value

Coordinate

possibleCombineWithNext

It is possible to optionally combine the instruction with the next one. This can be used to build messages like "Turn left and then turn right". NOTE: This property will not be serialized. It can only be populated by the server.

possibleCombineWithNext?: boolean

Property Value

boolean

routeOffsetInMeters

Distance from the start of the route to the point of the instruction. NOTE: This property will not be serialized. It can only be populated by the server.

routeOffsetInMeters?: number

Property Value

number

street

Street name of the next significant road segment after the maneuver, or of the street that should be followed. NOTE: This property will not be serialized. It can only be populated by the server.

street?: string

Property Value

string

travelTimeInSeconds

Estimated travel time up to the point corresponding to routeOffsetInMeters. NOTE: This property will not be serialized. It can only be populated by the server.

travelTimeInSeconds?: number

Property Value

number