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

    Class PTStopInfo

    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.

    const ptStopInfo = await overlayItem.getPTStopInfo();
    Index

    Accessors

    agencies stops trips

    Methods

    tripsByAgency tripsByRouteShortName tripsByRouteType fromParameters

    Accessors

    • get agencies(): PTAgency[]

      Agencies serving the selected PT overlay item.

      Returns PTAgency[]

    • get stops(): PTStop[]

      Stops associated with the selected PT overlay item.

      Returns PTStop[]

    • get trips(): PTTrip[]

      Trips associated with the selected PT overlay item.

      Contains PTTrip objects providing schedule, realtime and accessibility information.

      Returns PTTrip[]

    Methods

    • Filter trips by agency.

      Parameters

      Returns PTTrip[]

      Trips operated by the provided agency. Returns an empty list if the agency is not present.

    • Filter trips by route short name.

      Parameters

      • routeShortName: string

        Short name to filter trips by

      Returns PTTrip[]

      Trips whose route short name equals routeShortName

    • Filter trips by PTRouteType.

      Parameters

      Returns PTTrip[]

      Trips matching the specified route type

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods