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

    Class PTRouteSegment

    Hierarchy

    • RouteSegmentBase
      • PTRouteSegment
    Index

    Constructors

    constructor

    Properties

    _mapId _pointerId

    Accessors

    agencyFareUrl agencyName agencyPhone agencyUrl arrivalDelayInSeconds arrivalTime countAlerts departureDelayInSeconds departureTime geographicArea hasBicycleSupport hasWheelchairSupport incursCosts instructions isCommon isSignificant isStationWalk lineBlockID lineColor lineFrom lineTextColor lineTowards name platformCode pointerId realtimeStatus routeUrl shortName stayOnSameTransit summary timeDistance transitType waypoints

    Methods

    getAlert

    Constructors

    • Parameters

      • pointerId: number

      Returns PTRouteSegment

    Properties

    Protected_mapId

    _mapId: number

    Protected_pointerId

    _pointerId: any

    Accessors

    • get agencyFareUrl(): string

      Returns string

    • get agencyName(): string

      Returns string

    • get agencyPhone(): string

      Returns string

    • get agencyUrl(): string

      Returns string

    • get arrivalDelayInSeconds(): number

      Returns number

    • get arrivalTime(): Date | null

      Returns Date | null

    • get countAlerts(): number

      Returns number

    • get departureDelayInSeconds(): number

      Returns number

    • get departureTime(): Date | null

      Returns Date | null

    • get geographicArea(): RectangleGeographicArea

      Get geographic area of the route

      Returns RectangleGeographicArea

      Geographic area covered by the route

      An exception if it fails.

    • get hasBicycleSupport(): boolean

      Returns boolean

    • get hasWheelchairSupport(): boolean

      Returns boolean

    • get incursCosts(): boolean

      Check if traveling the route or route segment incurs cost to the user.

      Returns boolean

      True if the route incurs costs, false otherwise

      An exception if it fails.

    • get instructions(): RouteInstruction[]

      Get route instructions list.

      Returns RouteInstruction[]

      A list of route instructions for the route segment

      An exception if it fails.

    • get isCommon(): boolean

      Check if this segment is of common type.

      Returns boolean

      True if the segment is common type, false otherwise

      An exception if it fails.

    • get isSignificant(): boolean

      Returns boolean

    • get isStationWalk(): boolean

      Returns boolean

    • get lineBlockID(): number

      Returns number

    • get lineColor(): Color

      Returns Color

    • get lineFrom(): string

      Returns string

    • get lineTextColor(): Color

      Returns Color

    • get lineTowards(): string

      Returns string

    • get name(): string

      Returns string

    • get platformCode(): string

      Returns string

    • get pointerId(): any

      Returns any

    • get routeUrl(): string

      Returns string

    • get shortName(): string

      Returns string

    • get stayOnSameTransit(): boolean

      Returns boolean

    • get summary(): string

      Get summary of the route segment.

      Returns string

      The summary of the route segment

      An exception if it fails.

    • get timeDistance(): TimeDistance

      Get length in meters and estimated travel time in seconds for the route / route segment.

      Returns TimeDistance

      TimeDistance object containing the time and distance information

      An exception if it fails.

    • get waypoints(): Landmark[]

      Returns Landmark[]

    Methods

    • Parameters

      • index: number

      Returns PTAlert | null

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods