RouteResultInstructionGroup interface

  • Reference
Package:
azure-maps-rest

Groups a sequence of instruction elements which are related to each other. The sequence range is constrained with firstInstructionIndex and lastInstructionIndex. When human-readable text messages are requested for guidance (instructionType=text or tagged), then the instructionGroup has a summary message returned when available.

Properties

firstInstructionIndex

Index of the first instruction. NOTE: This property will not be serialized. It can only be populated by the server.
groupLengthInMeters

Length of the group. NOTE: This property will not be serialized. It can only be populated by the server.
groupMessage

Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged). NOTE: This property will not be serialized. It can only be populated by the server.
lastInstructionIndex

Index of the last instruction. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

firstInstructionIndex

Index of the first instruction. NOTE: This property will not be serialized. It can only be populated by the server.

firstInstructionIndex?: number

Property Value

number

groupLengthInMeters

Length of the group. NOTE: This property will not be serialized. It can only be populated by the server.

groupLengthInMeters?: number

Property Value

number

groupMessage

Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged). NOTE: This property will not be serialized. It can only be populated by the server.

groupMessage?: string

Property Value

string

lastInstructionIndex

Index of the last instruction. NOTE: This property will not be serialized. It can only be populated by the server.

lastInstructionIndex?: number

Property Value

number