RouteInstruction Class

  • Reference

Definition

Namespace:
Azure.Maps.Routing.Models
Assembly:
Azure.Maps.Routing.dll
Package:
Azure.Maps.Routing v1.0.0-beta.3
Source:
RouteInstruction.cs

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

public class RouteInstruction
type RouteInstruction = class
Public Class RouteInstruction
Inheritance
Object
RouteInstruction

Properties

CombinedMessage

A human-readable message for the maneuver combined with the message from the next instruction. Sometimes it is possible to combine two successive instructions into a single instruction making it easier to follow. When this is the case the possibleCombineWithNext flag will be true. For example:

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

The possibleCombineWithNext flag on instruction 10 is true. This indicates to the clients of coded guidance that it can be combined with instruction 11. The instructions will be combined automatically for clients requesting human-readable guidance. The combinedMessage field contains the combined message:

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

3-character ISO 3166-1 alpha-3 country code. E.g. USA.
DrivingSide

Indicates left-hand vs. right-hand side driving at the point of the maneuver.
ExitNumber

The number(s) of a highway exit taken by the current maneuver. If an exit has multiple exit numbers, they will be separated by "," and possibly aggregated by "-", e.g., "10, 13-15".
InstructionType

Type of the instruction, e.g., turn or change of road form.
JunctionType

The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout.
Maneuver

A code identifying the maneuver.
Message

A human-readable message for the maneuver.
Point

A location represented as a latitude and longitude.
PointIndex

The index of the point in the list of polyline "points" corresponding to the point of the instruction.
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".
RoadNumbers

The road number(s) of the next significant road segment(s) after the maneuver, or of the road(s) to be followed. Example: ["E34", "N205"].
RoundaboutExitNumber

This indicates which exit to take at a roundabout.
RouteOffsetInMeters

Distance from the start of the route to the point of the instruction.
SignpostText

The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed.
StateCode

A subdivision (e.g., state) of the country, represented by the second part of an ISO 3166-2 code. This is only available for some countries/regions like the US, Canada, and Mexico.
Street

Street name of the next significant road segment after the maneuver, or of the street that should be followed.
TravelTimeInSeconds

Estimated travel time up to the point corresponding to routeOffsetInMeters.
TurnAngleInDegrees

Indicates the direction of an instruction. If junctionType indicates a turn instruction:

  • 180 = U-turn
  • [-179, -1] = Left turn
  • 0 = Straight on (a '0 degree' turn)
  • [1, 179] = Right turn

If junctionType indicates a bifurcation instruction:

  • <0 - keep left
  • &gt;0 - keep right

Applies to