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

    Class PTRouteInfo

    Public-facing route information for a stop.

    Contains rider-visible route metadata such as short/long names, route type and color hints. Use this when presenting routes associated with a stop in UI or lists.

    Instances are provided as part of PTStop.routes or PTTrip.route.

    Index

    Constructors

    constructor

    Properties

    heading? routeColor? routeId routeLongName? routeShortName? routeTextColor? routeType

    Methods

    buildStopRoutes fromParameters

    Constructors

    • Create a PTRouteInfo.

      API users do not typically create instances of this class directly.

      Parameters

      • params: {
            heading?: string;
            routeColor?: string;
            routeId: number;
            routeLongName?: string;
            routeShortName?: string;
            routeTextColor?: string;
            routeType: PTRouteType;
        }

        Route parameters

      Returns PTRouteInfo

    Properties

    heading?: string

    Optional heading or destination string.

    routeColor?: string

    Optional color associated with the route (hex string).

    routeId: number

    Internal route identifier.

    routeLongName?: string

    Descriptive route name (may be null).

    routeShortName?: string

    Short route identifier (may be null).

    routeTextColor?: string

    Optional text color suitable for use on top of routeColor (hex string).

    routeType: PTRouteType

    Route type.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods