gis-tools-ts - v0.6.0
    Preparing search index...

    Class GTFSStop

    Stop Information

    Conditionally Required - Stops where vehicles pick up or drop off riders. Also defines stations, entrances, etc.

    Index

    Constructors

    constructor

    Properties

    code? desc? id lat? levelId? locationType? lon? name? parentStation? platformCode? timezone? ttsName? url? wheelchairBoarding? zoneId?

    Methods

    properties

    Constructors

    • Parameters

      • data: Record<string, string>

        the parsed GTFS CSV data

      Returns GTFSStop

    Properties

    code?: string

    Optional Short text or a number that identifies the location for riders.

    desc?: string

    Optional Description providing useful information about the location. Should not be a duplicate of name.

    id: string

    Required Identifies a location: stop/platform, station, entrance/exit, generic node, or boarding area. Must be unique across:

    • stops.stop_id
    • locations.geojson id
    • location_groups.location_group_id Multiple routes may use the same stop_id.
    lat?: number

    Conditionally Required Latitude of the location. Required if location_type is 0, 1, or 2. Optional otherwise.

    levelId?: string

    Optional Level of the location. References levels.level_id.

    locationType?: number

    Optional Location type. Valid options: 0 or empty = Stop/Platform, 1 = Station, 2 = Entrance/Exit, 3 = Generic Node, 4 = Boarding Area.

    lon?: number

    Conditionally Required Longitude of the location. Required if location_type is 0, 1, or 2. Optional otherwise.

    name?: string

    Conditionally Required Name of the location. Required if location_type is 0, 1, or 2. Optional otherwise.

    parentStation?: string

    Conditionally Required Defines hierarchy between different locations. Required if location_type is 2, 3, or 4.

    platformCode?: string

    Optional Platform identifier for a platform stop.

    timezone?: string

    Optional Timezone of the location. Inherits from parent station if not specified.

    ttsName?: string

    Optional Readable version of the stop_name for text-to-speech systems.

    url?: string

    Optional URL of a web page about this location.

    wheelchairBoarding?: number

    Optional Indicates whether wheelchair boardings are possible at this location. For parentless stops: 0 = no info, 1 = possible, 2 = not possible. For child stops, entrance/exits: inherits or overrides parent station accessibility.

    zoneId?: string

    Optional Identifies the fare zone for a stop.

    Methods

    Settings

    Member Visibility

    On This Page

    Stop Information
    Constructors
    Properties
    Methods