RouteInstructionGroupOutput interface

Package:

@azure-rest/maps-route

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 in the instructions and belonging to this group.
groupLengthInMeters	Length of the group.
groupMessage	Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged).
lastInstructionIndex	Index of the last instruction in the instructions and belonging to this group.

Property Details

firstInstructionIndex

Index of the first instruction in the instructions and belonging to this group.

firstInstructionIndex?: number

Property Value

number

groupLengthInMeters

Length of the group.

groupLengthInMeters?: number

Property Value

number

groupMessage

Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged).

groupMessage?: string

Property Value

string

lastInstructionIndex

Index of the last instruction in the instructions and belonging to this group.

lastInstructionIndex?: number

Property Value

number