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

    Class PTRoute

    Public transport route class

    Hierarchy

    • RouteBase
      • PTRoute
    Index

    Constructors

    constructor

    Properties

    _mapId _pointerId

    Accessors

    countBuyTicketInformation dominantRoads geographicArea hasFerryConnections hasTollRoads incursCosts pointerId polygonGeographicArea preferences publicTransportFare publicTransportFrequency publicTransportRespectsAllConditions routeListener segments status summary terrainProfile tilesGeographicArea trafficEvents

    Methods

    clearRouteListener exportAs getBuyTicketInformation getClosestSegment getCoordinateOnRoute getDistanceOnRoute getPath getTimeDistance getTimeDistanceCoordinateOnRoute getTimeDistanceCoordinates getWaypoints getWaypointsVia registerAutoReleaseObject

    Constructors

    • Parameters

      • id: number
      • mapId: number

      Returns PTRoute

    Properties

    Protected_mapId

    _mapId: number

    Protected_pointerId

    _pointerId: any

    Accessors

    • get countBuyTicketInformation(): number

      Get number of BuyTicketInformation objects for PT route.

      Returns

      • Number of BuyTicketInformation objects.

      Throws

      • An exception if it fails.

      Returns number

    • get dominantRoads(): string[]

      Returns string[]

    • get hasFerryConnections(): boolean

      Returns boolean

    • get hasTollRoads(): boolean

      Returns boolean

    • get incursCosts(): boolean

      Returns boolean

    • get pointerId(): any

      Returns any

    • get publicTransportFare(): string | null

      Get Fare

      Returns

      • Fare of the route.

      Throws

      • An exception if it fails.

      Returns string | null

    • get publicTransportFrequency(): number

      Get Frequency

      Returns

      • Frequency of the route.

      Throws

      • An exception if it fails.

      Returns number

    • get publicTransportRespectsAllConditions(): boolean

      Check if the solution meets all the preferences

      Returns

      • True if the solution meets all the preferences, false otherwise.

      Throws

      • An exception if it fails.

      Returns boolean

    • get routeListener(): RouteListener | null

      Returns RouteListener | null

    • set routeListener(routeListener: RouteListener | null): void

      Parameters

      Returns void

    • get summary(): string

      Returns string

    Methods

    • Returns void

    • Parameters

      Returns string

    • Get buy ticket data obj specified by index.

      Parameters

      • IN index The index of the buy ticket data object.

      Returns

      • Valid PTBuyTicketInformation object for corresponding index.
      • Empty PTBuyTicketInformation object if id index is out of bounds.

      Throws

      • An exception if it fails.

      Parameters

      • index: number

      Returns PTBuyTicketInformation | null

    • Parameters

      Returns number

    • Parameters

      • distance: number

      Returns Coordinates

    • Parameters

      Returns number

    • Parameters

      • start: number
      • end: number

      Returns Path | null

    • Parameters

      • activePart: boolean = true

      Returns TimeDistance

    • Parameters

      • __namedParameters: { end: number; start: number; step: number; stepType: StepType }

      Returns TimeDistanceCoordinate[]

    • Parameters

      Returns Landmark[]

    • 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