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

    Class PTRouteInstruction

    Public transport route instruction class

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _pointerId mapId

    Accessors

    arrivalTime coordinates countryCodeISO departureTime exitDetails followRoadInstruction hasFollowRoadInfo hasRoadInfo hasSignpostInfo hasTurnInfo hasWheelchairSupport isCommon isExit isFerry isTollRoad name platformCode pointerId realisticNextTurnImg remainingTravelTimeDistance remainingTravelTimeDistanceToNextWaypoint roadInfo roadInfoImg signpostDetails signpostInstruction timeDistanceToNextTurn traveledTimeDistance turnDetails turnImg turnInstruction

    Methods

    getRealisticNextTurnImage getRoadInfoImage getTurnImage registerAutoReleaseObject

    Constructors

    Properties

    Protected_pointerId

    _pointerId: number
    mapId: number

    Accessors

    • get arrivalTime(): Date | null

      Get public transit route instruction arrival time in UTC

      Returns

      • Arrival time in UTC if available, null otherwise

      Throws

      • An exception if it fails.

      Returns Date | null

    • get coordinates(): Coordinates

      Returns Coordinates

    • get countryCodeISO(): string

      Returns string

    • get departureTime(): Date | null

      Get public transit route instruction departure time in UTC

      Returns

      • Departure time in UTC if available, null otherwise

      Throws

      • An exception if it fails.

      Returns Date | null

    • get exitDetails(): string

      Get the exit route instruction text.

      Returns string

      Exit route instruction text or empty string if not an exit

      An exception if it fails.

    • get followRoadInstruction(): string

      Get textual description for the follow road information.

      Returns string

      Follow road instruction

      An exception if it fails.

    • get hasFollowRoadInfo(): boolean

      Check if follow road information is available.

      Returns boolean

      True if available, false otherwise

      An exception if it fails.

    • get hasRoadInfo(): boolean

      Check if road information is available.

      Returns boolean

      True if available, false otherwise

      An exception if it fails.

    • get hasSignpostInfo(): boolean

      Check if signpost information is available.

      Returns boolean

      True if available, false otherwise

      An exception if it fails.

    • get hasTurnInfo(): boolean

      Check if turn information is available.

      Returns boolean

      True if available, false otherwise

      An exception if it fails.

    • get hasWheelchairSupport(): boolean

      Get if public transit route instruction has wheelchair support

      Returns

      • True if has wheelchair support, false otherwise

      Throws

      • An exception if it fails.

      Returns boolean

    • get isCommon(): boolean

      Check if this instruction is of common type.

      Returns boolean

      True if common type, false otherwise

      An exception if it fails.

    • get isExit(): boolean

      Check if the route instruction is a main road exit instruction.

      Returns boolean

      True if an exit is involved, false otherwise

      An exception if it fails.

    • get isFerry(): boolean

      Check if the route instruction is a ferry.

      Returns boolean

      True if a ferry is involved, false otherwise

      An exception if it fails.

    • get isTollRoad(): boolean

      Check if the route instruction is a toll road.

      Returns boolean

      True if a toll road is involved, false otherwise

      An exception if it fails.

    • get name(): string

      Get public transit route instruction name

      Returns

      • Instruction name

      Throws

      • An exception if it fails.

      Returns string

    • get platformCode(): string

      Get platform code

      Returns

      • Platform code

      Throws

      • An exception if it fails.

      Returns string

    • get pointerId(): number

      Returns number

    • get realisticNextTurnImg(): AbstractGeometryImg

      Get the image of the realistic next turn image

      Returns AbstractGeometryImg

      The image for the realistic next turn image

      An exception if it fails.

    • get remainingTravelTimeDistance(): TimeDistance

      Get remaining travel distance in meters and remaining travel time in seconds.

      Returns TimeDistance

      TimeDistance object

      An exception if it fails.

    • get remainingTravelTimeDistanceToNextWaypoint(): TimeDistance

      Get remaining travel time and distance to the next waypoint.

      Returns TimeDistance

      TimeDistance object

      An exception if it fails.

    • get roadInfo(): RoadInfo[]

      Get road information.

      Returns RoadInfo[]

      List of RoadInfo objects

      An exception if it fails.

    • get roadInfoImg(): RoadInfoImg

      Get the image of the road info

      Returns RoadInfoImg

      RoadInfo image

      An exception if it fails.

    • get signpostDetails(): SignpostDetails

      Get extended signpost details.

      Returns SignpostDetails

      SignpostDetails object

      An exception if it fails.

    • get signpostInstruction(): string

      Get textual description for the signpost information.

      Returns string

      Signpost instructions

      An exception if it fails.

    • get timeDistanceToNextTurn(): TimeDistance

      Get distance to the next turn in meters, time in seconds.

      Returns TimeDistance

      TimeDistance object

      An exception if it fails.

    • get traveledTimeDistance(): TimeDistance

      Get the traveled distance and time.

      Returns TimeDistance

      TimeDistance object

      An exception if it fails.

    • get turnDetails(): TurnDetails

      Get full details for the turn.

      Returns TurnDetails

      TurnDetails object

      An exception if it fails.

    • get turnImg(): Img

      Get the turn image

      Returns Img

      Turn image

      An exception if it fails.

    • get turnInstruction(): string

      Get textual description for the turn.

      Returns string

      The turn instruction

      An exception if it fails.

    Methods

    • Get road image.

      Parameters

      • options: { backgroundColor?: Color; format?: ImageFileFormat; size?: Size }

        Object containing image options:

        • size: The image size.
        • format: The image format.
        • backgroundColor: The image background color.

      Returns Uint8Array<ArrayBufferLike> | null

      RoadInfo Image or null

      An exception if it fails.

    • Get turn image.

      Parameters

      Returns Uint8Array<ArrayBufferLike> | null

      The turn image or null

      An exception if it fails.

    • 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

    Constructors
    Properties
    Accessors
    Methods