PTStopInfo - @magiclane/maps-sdk API Reference

PTStopInfo class

Aggregated public transport data for a selected overlay item.

Instances are produced by OverlayItem.getPTStopInfo() and contain the agencies, stops and trips associated with the selected public transport overlay item. Use the filtering helpers to query trips by short name, type or agency.

Signature:

export declare class PTStopInfo

Example

const ptStopInfo = await overlayItem.getPTStopInfo();

Maps & 3D Scene

Properties

Property	Modifiers	Type	Description
agencies	`readonly`	PTAgency[]	Agencies serving the selected PT overlay item.
stops	`readonly`	PTStop[]	Stops associated with the selected PT overlay item.
trips	`readonly`	PTTrip[]	Trips associated with the selected PT overlay item. Contains PTTrip objects providing schedule, realtime and accessibility information.

Property

Modifiers

Type

Description

agencies

readonly

PTAgency[]

Agencies serving the selected PT overlay item.

stops

readonly

PTStop[]

Stops associated with the selected PT overlay item.

trips

readonly

PTTrip[]

Trips associated with the selected PT overlay item.

Contains PTTrip objects providing schedule, realtime and accessibility information.

Methods

Method	Modifiers	Description
tripsByAgency(agency)		Filter trips by agency.
tripsByRouteShortName(routeShortName)		Filter trips by route short name.
tripsByRouteType(routeType)		Filter trips by PTRouteType.