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

    Class GTFSRoute

    Route Information

    Required - Transit routes. A route is a group of trips that are displayed to riders as a single service.

    Index

    Constructors

    • Parameters

      • data: Record<string, string>

        the parsed GTFS CSV data

      Returns GTFSRoute

    Properties

    agencyId?: string

    Conditionally Required Agency for the specified route. Required if multiple agencies are defined in agency.txt.

    color?: string

    Optional Route color (hex) matching public-facing material. Defaults to FFFFFF if empty.

    continuousDropOff?: number

    Conditionally Forbidden Continuous drop-off setting for the entire route. 0 - Continuous stopping drop off, 1/empty - No continuous stopping drop off, 2 - Must phone agency, 3 - Must coordinate with driver.

    Forbidden if stop_times.start_pickup_drop_off_window or stop_times.end_pickup_drop_off_window are used.

    continuousPickup?: number

    Conditionally Forbidden Continuous pickup setting for the entire route. 0 - Continuous stopping pickup, 1/empty - No continuous stopping pickup, 2 - Must phone agency, 3 - Must coordinate with driver.

    Forbidden if stop_times.start_pickup_drop_off_window or stop_times.end_pickup_drop_off_window are used.

    desc?: string

    Optional Description of a route providing useful info, not a duplicate of short/long name.

    id: string

    Required Identifies a route.

    longName?: string

    Conditionally Required Full name of a route, generally more descriptive than shortName. Required if route_short_name is empty. Optional otherwise.

    networkId?: string

    Conditionally Forbidden Identifies a group of routes. Multiple rows may share the same network_id. Forbidden if route_networks.txt is used.

    shortName?: string

    Conditionally Required Short name of a route, e.g. "32", "100X", "Green". Required if route_long_name is empty. Recommended otherwise.

    sortOrder?: number

    Optional Orders routes for ideal presentation (smaller values displayed first).

    textColor?: string

    Optional Text color (hex) used against the route_color. Defaults to 000000 if empty.

    type: number

    Required Indicates the type of transportation used on a route. Valid options include: 0 - Tram, 1 - Subway, 2 - Rail, 3 - Bus, 4 - Ferry, 5 - Cable tram, 6 - Aerial lift, 7 - Funicular, 11 - Trolleybus, 12 - Monorail.

    url?: string

    Optional URL of a web page about the route. Should differ from agency.agency_url.