Class BaseRouteProvider

Base class used for RouteProviders

Source : file routeProviders/BaseRouteProvider.js at line 31

Constructor

new BaseRouteProvider ( )

Constructor

Source : file routeProviders/BaseRouteProvider.js at line 66

Public getters and setters

readonly get icon : String

The icon used in the ProviderToolbarUI. Must be overloaded in the derived classes

Source : file routeProviders/BaseRouteProvider.js at line 89

readonly get name : String

The provider name. Must be overloaded in the derived classes

Source : file routeProviders/BaseRouteProvider.js at line 102

readonly get providerKeyNeeded : Boolean

A boolean indicating when a provider key is needed for the provider. Must be overloaded in the derived classes

Source : file routeProviders/BaseRouteProvider.js at line 127

readonly get title : String

The title to display in the ProviderToolbarUI button. Must be overloaded in the derived classes

Source : file routeProviders/BaseRouteProvider.js at line 110

readonly get transitModes : Array of String

The possible transit modes for the provider. Must be overloaded in the derived classes. Must be a subarray of [ 'bike', 'pedestrian', 'car', 'train', 'line', 'circle' ]

Source : file routeProviders/BaseRouteProvider.js at line 119

get userLanguage : String

The user language.

Source : file routeProviders/BaseRouteProvider.js at line 134

set userLanguage

Source : file routeProviders/BaseRouteProvider.js at line 135

Public methods

getPromiseRoute ( route )

Call the provider, using the waypoints defined in the route and, on success, complete the route with the data from the provider

Source : file routeProviders/BaseRouteProvider.js at line 78

Parameters

Name Type Description
route Route

The route to witch the data will be added

Returns

A Promise. On success, the Route is completed with the data given by the provider.
Type : Promise

Private properties

#route : Route

A reference to the edited route

Source : file routeProviders/BaseRouteProvider.js at line 46

#userLanguage : String

The user language

Source : file routeProviders/BaseRouteProvider.js at line 38

Private methods

#getRoute ( onOk, onError )

Call the provider, using the waypoints defined in the route and, on success, complete the route with the data from the provider

Source : file routeProviders/BaseRouteProvider.js at line 57

Parameters

Name Type Description
onOk Function

The Promise Success handler

onError Function

The Promise Error handler