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

    Class GTFSPathway

    Pathways

    Optional Represents edges in a station graph describing station interiors, connecting platforms, entrances/exits, generic nodes, or boarding areas.

    Primary Key: (pathway_id)

    Pathways must be complete if included:

    • No dangling locations if any pathways exist, except for platforms that have boarding areas.
    • Platforms with boarding areas must not have pathways directly; their boarding areas do.
    • Each platform (location_type=0) or boarding area (4) must have at least one path to an entrance/exit (2) unless it’s impossible for riders to exit at that platform.
    Index

    Constructors

    • Parameters

      • data: Record<string, string>

        the parsed GTFS CSV data

      Returns GTFSPathway

    Properties

    fromStopId: string

    Required The stop or node from which this pathway begins. Must be location_type=0, 2, 3, or 4 (platform, entrance/exit, generic node, or boarding area). Stations (location_type=1) are forbidden here.

    id: string

    Required Unique ID for the pathway record.

    isBidirectional: GTFSIsBidirectional

    Required 0 = Unidirectional, 1 = Bidirectional

    length?: number

    Optional Horizontal length in meters of the pathway. Recommended for walkway, fare gate, exit gate.

    maxSlope?: number

    Optional Maximum slope ratio. Positive for upwards, negative for downwards. E.g., 0.083 is an 8.3% slope. Used for walkway (1) or moving sidewalk (3) if relevant.

    minWidth?: number

    Optional Minimum width of the pathway in meters, recommended if less than 1 meter.

    Required Pathway mode, e.g. walkway, stairs, escalator.

    reversedSignpostedAs?: string

    Optional Public facing text on signage when traversing the pathway in reverse (toStopId -> fromStopId), if different from signpostedAs.

    signpostedAs?: string

    Optional Public facing text on signage to help riders navigate (e.g. "Follow signs to X").

    stairCount?: number

    Optional Number of stairs in this pathway. Positive: fromStopId to toStopId goes upwards Negative: fromStopId to toStopId goes downwards Recommended for pathway_mode=2 (stairs).

    toStopId: string

    Required The stop or node at which this pathway ends. Must be location_type=0, 2, 3, or 4 (platform, entrance/exit, generic node, or boarding area). Stations (location_type=1) are forbidden here.

    traversalTime?: number

    Optional Average time in seconds needed to traverse this pathway. Recommended for moving sidewalk, escalator, elevator.