@magiclane/maps-sdk
    Preparing search index...

    Class NavigationInstruction

    Hierarchy

    • GemAutoreleaseObject
      • NavigationInstruction
    Index

    Accessors

    currentCountryCodeISO currentPosition currentRoadInformation currentStreetName currentStreetSpeedLimit driveSide hasNextNextTurnInfo hasNextTurnInfo hasSignpostInfo instructionIndex laneImg mapId navigationRoute navigationStatus nextCountryCodeISO nextInstruction nextNextInstruction nextNextRoadInformation nextNextStreetName nextNextTurnDetails nextNextTurnImg nextNextTurnInstruction nextRoadInformation nextStreetName nextTurnDetails nextTurnImg nextTurnInstruction pointerId previousInstruction remainingTravelTimeDistance remainingTravelTimeDistanceToNextWaypoint returnToRoutePosition segmentIndex signpostDetails signpostInstruction timeDistanceToNextNextTurn timeDistanceToNextTurn traveledTimeDistance

    Methods

    dispose exportAs getLaneImage getNextNextTurnImage getNextSpeedLimitVariation getNextTurnImage getRoadInfoImg registerAutoReleaseObject init

    Accessors

    • get currentCountryCodeISO(): string

      Returns string

    • get currentPosition(): GemPosition | null

      Returns GemPosition | null

    • get currentRoadInformation(): RoadInfo[]

      Returns RoadInfo[]

    • get currentStreetName(): string

      Returns string

    • get currentStreetSpeedLimit(): number

      Returns number

    • get hasNextNextTurnInfo(): boolean

      Returns boolean

    • get hasNextTurnInfo(): boolean

      Returns boolean

    • get hasSignpostInfo(): boolean

      Returns boolean

    • get instructionIndex(): number

      Returns number

    • get laneImg(): LaneImg

      Returns LaneImg

    • get mapId(): number

      Returns number

    • Returns Route

    • get nextCountryCodeISO(): string

      Returns string

    • get nextNextRoadInformation(): RoadInfo[]

      Returns RoadInfo[]

    • get nextNextStreetName(): string

      Returns string

    • get nextNextTurnImg(): Img

      Returns Img

    • get nextNextTurnInstruction(): string

      Returns string

    • get nextRoadInformation(): RoadInfo[]

      Returns RoadInfo[]

    • get nextStreetName(): string

      Returns string

    • get nextTurnImg(): Img

      Returns Img

    • get nextTurnInstruction(): string

      Returns string

    • get pointerId(): any

      Returns any

    • get remainingTravelTimeDistanceToNextWaypoint(): TimeDistance

      Returns TimeDistance

    • get returnToRoutePosition(): Coordinates | null

      Returns Coordinates | null

    • get segmentIndex(): number

      Returns number

    • get signpostInstruction(): string

      Returns string

    Methods

    • Returns void

    • Parameters

      • fileFormat: any = 'packedGeometry'

      Returns Uint8Array

    • Parameters

      Returns Uint8Array<ArrayBufferLike> | null

    • Parameters

      Returns Uint8Array<ArrayBufferLike> | null

    • Parameters

      • OptionalcheckDistance: number

      Returns NextSpeedLimit

    • Parameters

      Returns Uint8Array<ArrayBufferLike> | null

    • Parameters

      Returns Img

    • Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.

      Parameters

      • pointerId: any

        The pointer ID to register

      Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods