PTRouteInfo - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > PTRouteInfo

PTRouteInfo class

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.

Maps & 3D Scene

Signature:

export declare class PTRouteInfo

Constructors

Constructor	Modifiers	Description
(constructor)({ routeId, routeShortName, routeLongName, routeType, routeColor, routeTextColor, heading, liveCrowding, }, input)		Create a PTRouteInfo. API users do not typically create instances of this class directly.

Constructor

Modifiers

Description

(constructor)({ routeId, routeShortName, routeLongName, routeType, routeColor, routeTextColor, heading, liveCrowding, }, input)

Create a PTRouteInfo.

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

Properties

Property	Modifiers	Type	Description
heading?	`readonly`	string	(Optional) Optional heading or destination string.
liveCrowding?	`readonly`	PTCrowdingInfo	(Optional) Live crowding summary over the route's fresh vehicle positions (worst values). Undefined when there is no crowding data. Every inner field is optional, always.
routeColor?	`readonly`	string	(Optional) Optional color associated with the route (hex string).
routeId	`readonly`	number	Internal route identifier.
routeLongName?	`readonly`	string	(Optional) Descriptive route name (may be null).
routeShortName?	`readonly`	string	(Optional) Short route identifier (may be null).
routeTextColor?	`readonly`	string	(Optional) Optional text color suitable for use on top of routeColor (hex string).
routeType	`readonly`	PTRouteType	Route type.