RightTrackTransitAgency

RightTrackTransitAgency

RightTrackTransitAgency Abstract Class

Constructor

(abstract) new RightTrackTransitAgency(id, name, description, iconPathopt, maintaineropt)

Source:

Create a new Transit Agency

Parameters:
Name Type Attributes Description
id string

Transit Agency ID

name string

Transit Agency Name

description string

Transit Agency Description

iconPath string <optional>

Local file path to Transit Agency Icon

maintainer Object <optional>

Transit Agency Maintainer Information

Properties
Name Type Attributes Description
name string <optional>

Maintainer Name

email string <optional>

Maintainer Email Address

source string <optional>

Maintainer's project source address

Members

description :string

Source:

Transit Agency Description

Type:
  • string

iconPath :string

Source:

Local file path to Transit Agency Icon

Type:
  • string

id :string

Source:

Transit Agency ID Code

Type:
  • string

maintainer :object

Source:
Properties:
Name Type Description
name string

Maintainer Name

email string

Maintainer Email Address

source string

Maintainer's project source address

Transit Agency Maintainer Information

Type:
  • object

name :string

Source:

Transit Agency Display Name

Type:
  • string

Methods

(abstract) getDivisionIconPath(division) → {string|undefined}

Source:

Get the local file path to the icon for the specified Transit Division

Parameters:
Name Type Description
division string

Transit Division Code

Returns:

Absolute local path to division icon

Type
string | undefined

(abstract) getLineBackgroundColor(line) → {string}

Source:

Get the background color for the specified Transit Line

Parameters:
Name Type Description
line string

Transit Line Code

Returns:

background color (#rrggbb)

Type
string

(abstract) getLineTextColor(line) → {string}

Source:

Get the text color for the specified Transit Line

Parameters:
Name Type Description
line
Returns:

text color (#rrggbb)

Type
string

(abstract) loadFeed(callback)

Source:

Load the Transit Feed for this Transit Agency

Parameters:
Name Type Description
callback function

Callback function

Properties
Name Type Attributes Description
error Error

Transit Feed Error. The Error's message will be a pipe (|) separated string in the format of: Error Code|Error Type|Error Message that will be parsed out by the Right Track API Server into a more specific error Response.

feed TransitFeed <optional>

The built TransitFeed for the Transit Agency