Title

Global

Members

Array.<string>

# constant VALID_MOTS

The valid supported mots by the application

View Source constants.js, line 6

Methods

# findMotIcon(name) → {Icon}

Map each mot to an icon

Parameters:
Name Type Description
name string

The name of the mot, ex('bus' or 'train')

View Source utils.jsx, line 17

MotIcon

Icon

# GeopsRoutingDemo(mots, routingUrl, stationSearchUrl, APIKey)

Root component of the application that holds all other sub-components.

Parameters:
Name Type Description
mots Array.<string>

List of mots to be available (ex: ['bus', 'train'])

routingUrl string

The API routing url to be used for navigation.

stationSearchUrl string

The API station search URL to be used for searching for stations.

APIKey string

A key obtained from geOps that enables you to used the previous API services.

View Source Components/GeopsRoutingDemo/GeopsRoutingDemo.jsx, line 16

# SearchField()

The component that displays the search field(s)

View Source Components/SearchField/SearchField.jsx, line 18

# SearchResults()

The component that displays the station search results

View Source Components/SearchResults/SearchResults.jsx, line 15

Type Definitions

props

# MapComponentProps

The map props

Properties:
Name Type Description
APIKey string

key obtained from geOps that enables you to used the previous API services.

routingUrl string

The API routing url to be used for navigation.

currentMot string

The current selected mot by user, example 'bus'.

currentStopsGeoJSON Object

The current stops defined by user in geojson format inside a dictionary, key is the stop index(order) and the value is the geoJSON itself.

onShowNotification function

A store action that can be dispatched, takes the notification message and type as arguments.

onSetClickLocation function

A store action that can be dispatched, takes the clicked location on map array of [long,lat] and stores it in the store.

View Source Components/MapComponent/MapComponent.jsx, line 15

props

# NotificationHandlerProps

The notification handler props

Properties:
Name Type Description
notificationMessage string

Obtained from the store, the message to be displayed. Can be any valid string.

notificationType string

Obtained from the store, the message type (error, success, info, etc...)

View Source Components/NotificationHandler/NotificationHandler.jsx, line 7

props

# RoutingMenuProps

The routing menu props

Properties:
Name Type Description
stationSearchUrl string

The station search API used for searching.

APIKey string

key obtained from geOps that enables you to used the previous API services.

mots Array.<string>

List of mots to be available (ex: ['bus', 'train'])

clickLocation LongLat

The location clicked by the user in the form of [long,lat].

onShowNotification function

A store action that can be dispatched, takes the notification message and type as arguments.

onSetCurrentStopsGeoJSON function

A store action that can be dispatched, sets the current stops in the store in the form of GeoJSON format.

onSetCurrentMot function

TA store action that can be dispatched, sets the current selected mot by the user inside the store.

View Source Components/RoutingMenu/RoutingMenu.jsx, line 38