Type Alias Indication

Represents the instruction that a user should follow when on a RouteStep to continue the route.

type Indication = {
    distance: number;
    distanceToNextLevel: number;
    indicationType: string;
    neededLevelChange: boolean;
    orientation: number;
    orientationType: string;
    stepIdxDestination: number;
    stepIdxOrigin: number;
}

Properties

distance: number

The distance between the origin and destination

distanceToNextLevel: number

The number of levels between the origin and destination

indicationType: string

The Indication.Action of the instruction as String

neededLevelChange: boolean

If the user should change the level in order to arrive at the destination

orientation: number

The angle a user should change his direction in order to go from the origin to the destination

orientationType: string

The Indication.Orientation of the instruction as String

stepIdxDestination: number

The index of the indication's step of destination

stepIdxOrigin: number

The index of the indication's step of origin