+
+
+
+
+
+ openlayers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Map
+
+
+
+
+
+
+ An OpenLayers for handling Layers.
+This class extends the OpenLayers class
+ol/Map.
+
+ Map
+
+
+
+ Extends
+
+ OLMap
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
options (Object
+ = {})
+ Map options.
+
+
+
+
+
+
+
+
+
+
+ | Name |
+ Description |
+
+
+
+
+
+ options.layers Array.Layer?
+ |
+ List of
+Layers
+.
+ |
+
+
+
+
+
+
+
+
+
+
Example
+
+
+ import { Map } from 'mobility-toolbox-js/src/ol';
+
+
+
+
+
+
+ Instance Members
+
+
+
+
+
+
▸
+
addLayer(layer, The)
+
+
+
+
+
+
+
+ Adds a Layer to the map.
+
+ addLayer(layer: any, The:
Layer)
Parameters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
getMobilityLayers()
+
+
+
+
+
+
+
+ Returns a list of mobility layers.
+
+ getMobilityLayers():
LayerReturns
+ Layer:
+ Layer
+.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
removeLayer(layer, The)
+
+
+
+
+
+
+
+ Removes a given layer from the map.
+
+ removeLayer(layer: any, The:
Layer): any
Parameters
+
+
+
+
+
+
+
+ Returns
+ any:
+ The removed layer (or undefined if the layer was not found).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Layer
+
+
+
+
+
+
+ A class representing a layer to display on BasicMap with a name and
+an ol/Layer and further options
+
+
+
+
+
+ Extends
+
+ Observable
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+
+
+
+
+
+
+ | Name |
+ Description |
+
+
+
+
+
+ options.name string
+ |
+ Layer name (required).
+ |
+
+
+
+
+
+ options.olLayer ol.layer
+ |
+ The
+ol/Layer
+ (required).
+ |
+
+
+
+
+
+ options.key string
+
+ (default undefined)
+ |
+ Layer key, will use options.name.toLowerCase() if not specified.
+ |
+
+
+
+
+
+ options.isBaseLayer boolean
+
+ (default undefined)
+ |
+ If true this layer is a baseLayer.
+ |
+
+
+
+
+
+ options.children Array<ol.layer>
+
+ (default [])
+ |
+ Sublayers.
+ |
+
+
+
+
+
+ options.visible boolean
+
+ (default true)
+ |
+ If true this layer is the currently visible layer on the map.
+ |
+
+
+
+
+
+ options.copyright string
+
+ (default undefined)
+ |
+ Copyright-Statement.
+ |
+
+
+
+
+
+ options.properties Object
+
+ (default {})
+ |
+ Application-specific layer properties.
+ |
+
+
+
+
+
+ options.isQueryable boolean
+
+ (default undefined)
+ |
+ If true feature information can be queried by the react-spatial LayerService. Default is undefined, but resulting to true if not strictly set to false.
+ |
+
+
+
+
+
+
+
+
+
+
Example
+
+
+ import { Layer } from 'mobility-toolbox-js/src/ol';
+
+
+
+
+
+
+ Instance Members
+
+
+
+
+
+
+
+
+
+ Get a layer property.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
name (string)
+ Property name.
+
+
+
+
+
+
Returns
+ property:
+ Property
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get a layer property.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
name (string)
+ Property name.
+
+
+
+
+
+
Returns
+ property:
+ Property
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set a layer property.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
name (string)
+ Property name.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Set a layer property.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
name (string)
+ Property name.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get the Layer's Copyright Statment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ string:
+ Copyright
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get the Layer's Copyright Statment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ string:
+ Copyright
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get the Layername.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ string:
+ Layername
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get the Layername.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ string:
+ Layername
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get the Layers Key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ string:
+ Key
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Get the Layers Key.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ string:
+ Key
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return whether the layer is visible or not.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ boolean:
+ If true, the layer is visible.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Return whether the layer is visible or not.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ boolean:
+ If true, the layer is visible.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns whether the layer is the BaseLayer or not.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ boolean:
+ If true, the layer is the BaseLayer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns whether the layer is the BaseLayer or not.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ boolean:
+ If true, the layer is the BaseLayer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
setCopyright(copyright)
+
+
+
+
+
+
+
+ Get the Layer's Copyright Statment.
+
+ setCopyright(copyright: any):
stringParameters
+
+
+
+
+ copyright (any)
+
+
+
+
+
+
Returns
+ string:
+ Copyright
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
setCopyright(copyright)
+
+
+
+
+
+
+
+ Get the Layer's Copyright Statment.
+
+ setCopyright(copyright: any):
stringParameters
+
+
+
+
+ copyright (any)
+
+
+
+
+
+
Returns
+ string:
+ Copyright
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
setVisible(visible, stopPropagationDown = false, stopPropagationUp = false, stopPropagationSiblings = false)
+
+
+
+
+
+
+
+ Change the visibility of the layer
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
visible (boolean)
+ Defines the visibility of the layer
+
+
+
+
+
+
+
+
stopPropagationDown (boolean?
+ = false)
+
+
+
+
+
+
+
+
stopPropagationUp (boolean?
+ = false)
+
+
+
+
+
+
+
+
stopPropagationSiblings (boolean?
+ = false)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
setVisible(visible, stopPropagationDown = false, stopPropagationUp = false, stopPropagationSiblings = false)
+
+
+
+
+
+
+
+ Change the visibility of the layer
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
visible (boolean)
+ Defines the visibility of the layer
+
+
+
+
+
+
+
+
stopPropagationDown (boolean?
+ = false)
+
+
+
+
+
+
+
+
stopPropagationUp (boolean?
+ = false)
+
+
+
+
+
+
+
+
stopPropagationSiblings (boolean?
+ = false)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns an array with childlayers
+
+ getChildren():
Array<ol.layer>
Returns
+ Array<ol.layer>:
+ Children
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns an array with childlayers
+
+ getChildren():
Array<ol.layer>
Returns
+ Array<ol.layer>:
+ Children
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
setChildren(layers)
+
+
+
+
+
+
+
+ Sets the child layers
+
+ setChildren(layers:
Array<ol.layer>)
Parameters
+
+
+
+
+
layers (Array<ol.layer>)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
setChildren(layers)
+
+
+
+
+
+
+
+ Sets the child layers
+
+ setChildren(layers:
Array<ol.layer>)
Parameters
+
+
+
+
+
layers (Array<ol.layer>)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
getVisibleChildren()
+
+
+
+
+
+
+
+ Returns an array with visible child layers
+
+ getVisibleChildren():
Array<ol.layer>
Returns
+ Array<ol.layer>:
+ Visible children
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
getVisibleChildren()
+
+
+
+
+
+
+
+ Returns an array with visible child layers
+
+ getVisibleChildren():
Array<ol.layer>
Returns
+ Array<ol.layer>:
+ Visible children
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Add a child layer
+
+ addChild(layer: ol.layer)
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+ layer (ol.layer)
+ Child layer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Add a child layer
+
+ addChild(layer: ol.layer)
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+ layer (ol.layer)
+ Child layer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
removeChild(name)
+
+
+
+
+
+
+
+ Removes a child layer by layer name
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
name (string)
+ Layer name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
removeChild(name)
+
+
+
+
+
+
+
+ Removes a child layer by layer name
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
name (string)
+ Layer name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
hasVisibleChildren()
+
+
+
+
+
+
+
+ Checks whether the layer has child layers with visible set to True
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ boolean:
+ True if the layer has visible child layers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
hasVisibleChildren()
+
+
+
+
+
+
+
+ Checks whether the layer has child layers with visible set to True
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ boolean:
+ True if the layer has visible child layers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
hasChildren(visible)
+
+
+
+
+
+
+
+ Checks whether the layer has any child layers with visible equal to the input parameter
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
visible (boolean)
+ The state to check the childlayers against
+
+
+
+
+
+
Returns
+ boolean:
+ True if the layer has children with the given visibility
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
hasChildren(visible)
+
+
+
+
+
+
+
+ Checks whether the layer has any child layers with visible equal to the input parameter
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
visible (boolean)
+ The state to check the childlayers against
+
+
+
+
+
+
Returns
+ boolean:
+ True if the layer has children with the given visibility
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
getFeatureInfoAtCoordinate(coordinate)
+
+
+
+
+
+
+
+ Request feature information for a given coordinate.
+
+ getFeatureInfoAtCoordinate(coordinate: ol.Coordinate):
Promise<
Object>
Parameters
+
+
+
+
+ coordinate (ol.Coordinate)
+ Coordinate to request the information at.
+
+
+
+
+
+
Returns
+ Promise<Object>:
+ Promise with features, layer and coordinate
+or null if no feature was hit.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
getFeatureInfoAtCoordinate(coordinate)
+
+
+
+
+
+
+
+ Request feature information for a given coordinate.
+
+ getFeatureInfoAtCoordinate(coordinate: ol.Coordinate):
Promise<
Object>
Parameters
+
+
+
+
+ coordinate (ol.Coordinate)
+ Coordinate to request the information at.
+
+
+
+
+
+
Returns
+ Promise<Object>:
+ Promise with features, layer and coordinate
+or null if no feature was hit.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ WMSLayer
+
+
+
+
+
+
+ A class representing WMS layer to display on BasicMap
+
+ new WMSLayer(options:
Object?)
+ Extends
+
+ Layer
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
options (Object?
+ = {})
+
+
+
+
+
+
Example
+
+
+ import { WMSLayer } from 'mobility-toolbox-js/src/ol';
+
+
+
+
+
+
+ Instance Members
+
+
+
+
+
+
▸
+
getFeatureInfoUrl(coord)
+
+
+
+
+
+
+
+ Get features infos' Url.
+
+ getFeatureInfoUrl(coord: ol.Coordinate): ol.Layer
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+
+ Returns
+ ol.Layer:
+ ol/Layer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
getFeatureInfoAtCoordinate(coordinate)
+
+
+
+
+
+
+
+ Request feature information for a given coordinate.
+
+ getFeatureInfoAtCoordinate(coordinate: ol.Coordinate):
Promise<
Object>
Parameters
+
+
+
+
+
coordinate (ol.Coordinate)
+
ol/Coordinate
+ to request the information at.
+
+
+
+
+
+
Returns
+ Promise<Object>:
+ Promise with features, layer and coordinate
+or null if no feature was hit.
+eslint-disable-next-line class-methods-use-this
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
onClick(callback)
+
+
+
+
+
+
+
+ Listens to click events on the layer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Initialize the layer and listen to feature clicks.
+
+ init(map: ol.map)
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Terminate what was initialized in init function. Remove layer, events...
+
+ terminate()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MapboxLayer
+
+
+
+
+
+
+ A class representing Mapboxlayer to display on BasicMap
+
+ new MapboxLayer(options:
Object?)
+ Extends
+
+ Layer
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
options (Object?
+ = {})
+
+
+
+
+
+
Instance Members
+
+
+
+
+
+
+
+
+
+ Initialize the layer and listen to feature clicks.
+
+ init(map: ol.map)
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
getFeatureInfoAtCoordinate(coordinate, options)
+
+
+
+
+
+
+
+ Request feature information for a given coordinate.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+ coordinate (ol.Coordinate)
+ Coordinate to request the information at.
+
+
+
+
+
+
+
+
Returns
+ Promise<Object>:
+ Promise with features, layer and coordinate
+or null if no feature was hit.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Terminate what was initialized in init function. Remove layer, events...
+
+ terminate()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Create exact copy of the MapboxLayer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns
+ MapboxLayer:
+ MapboxLayer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MapboxStyleLayer
+
+
+
+
+
+
+ Layer for visualizing a specific set of layer from a MapboxLayer.
+
+ new MapboxStyleLayer(options:
Object?)
+ Extends
+
+ Layer
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
options (Object?
+ = {})
+ Layer options.
+
+
+
+
+
+
Example
+
+
+ import { MapboxStyleLayer } from 'mobility-toolbox-js/src/ol';
+
+
+
+
+
+
+ Instance Members
+
+
+
+
+
+
▸
+
getFeatureInfoAtCoordinate(coordinate)
+
+
+
+
+
+
+
+ Request feature information for a given coordinate.
+
+ getFeatureInfoAtCoordinate(coordinate: ol.Coordinate):
Promise<
Object>
Parameters
+
+
+
+
+ coordinate (ol.Coordinate)
+ Coordinate to request the information at.
+
+
+
+
+
+
Returns
+ Promise<Object>:
+ Promise with features, layer and coordinate
+or null if no feature was hit.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
clone(mapboxLayer)
+
+
+
+
+
+
+
+ Create exact copy of the MapboxLayer
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+ mapboxLayer (any)
+
+
+
+
+
+
Returns
+ MapboxLayer:
+ MapboxLayer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TrajservLayer
+
+
+
+
+
+
+ Responsible for loading tracker data from Trajserv.
+
+ new TrajservLayer(options:
Object?)
+ Extends
+
+ TrackerLayer
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
options (Object?
+ = {})
+ Layer options.
+
+
+
+
+
+
+
+
+
+
+ | Name |
+ Description |
+
+
+
+
+
+ options.url string
+
+ (default https://api.geops.io/tracker)
+ |
+ Tracker url.
+ |
+
+
+
+
+
+ options.apiKey string
+ |
+ Access key for
+geOps services
+.
+ |
+
+
+
+
+
+ options.delayDisplay number
+ |
+ delay from which the time is always display on the feature (in milliseconds).
+ |
+
+
+
+
+
+ options.regexPublishedLineName (Array<string> | string)
+ |
+ Regex filter for line name. This filter has a higher prio over publishedLineName.
+ |
+
+
+
+
+
+ options.publishedLineName (Array<string> | string)
+ |
+ Filter by line name, string: 'ICE', list: 's1,s2,s9,s10,s15'
+ |
+
+
+
+
+
+ options.tripNumber (Array<string> | string)
+ |
+ Filter by trip number, bus in zurich: '2068', list of buses in Zurich: '2068,3003,3451,3953'
+ |
+
+
+
+
+
+ options.operator (Array<string> | string)
+ |
+ Filter by operator, string: 'sbb', list: '(vbz
+|
+zsg)'
+ |
+
+
+
+
+
+
+
+
+
+
Example
+
+
+ import { TrajservLayer } from 'mobility-toolbox-js/src/ol';
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mapbox
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ MapboxTrajservLayer
+
+
+
+
+
+
+ Responsible for loading tracker data from Trajserv.
+
+ new MapboxTrajservLayer(options:
Object?)
+ Extends
+
+ TrackerLayer
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+
options (Object?
+ = {})
+ Layer options.
+
+
+
+
+
+
+
+
+
+
+ | Name |
+ Description |
+
+
+
+
+
+ options.url string
+
+ (default https://api.geops.io/tracker)
+ |
+ Tracker url.
+ |
+
+
+
+
+
+ options.apiKey string
+ |
+ Access key for
+geOps services
+.
+ |
+
+
+
+
+
+ options.delayDisplay number
+ |
+ delay from which the time is always display on the feature (in milliseconds).
+ |
+
+
+
+
+
+ options.regexPublishedLineName (Array<string> | string)
+ |
+ Regex filter for line name. This filter has a higher prio over publishedLineName.
+ |
+
+
+
+
+
+ options.publishedLineName (Array<string> | string)
+ |
+ Filter by line name, string: 'ICE', list: 's1,s2,s9,s10,s15'
+ |
+
+
+
+
+
+ options.tripNumber (Array<string> | string)
+ |
+ Filter by trip number, bus in zurich: '2068', list of buses in Zurich: '2068,3003,3451,3953'
+ |
+
+
+
+
+
+ options.operator (Array<string> | string)
+ |
+ Filter by operator, string: 'sbb', list: '(vbz
+|
+zsg)'
+ |
+
+
+
+
+
+
+
+
+
+
Example
+
+
+ import { MapboxTrajservLayer } from 'mobility-toolbox-js/src/mapbox';
+
+
+
+
+
+
+ Instance Members
+
+
+
+
+
+
▸
+
init(map, beforeLayerId)
+
+
+
+
+
+
+
+ Initialize the layer and listen to feature clicks.
+
+ init(map: mapboxgl.map, beforeLayerId:
String)
Parameters
+
+
+
+
+
map (mapboxgl.map)
+ A Mapbox
+
Map
+.
+
+
+
+
+
+
+
+
beforeLayerId (String)
+ .
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ StopsAPI
+
+
+
+
+
+
+ Access to Stops api.
+
+ new StopsAPI(options: any)
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+ options (any
+ = {})
+
+
+
+
+
+
Example
+
+
+ import { StopsAPI } from 'mobility-toolbox-js/src/api';
+
+
+
+
+
+
+ Instance Members
+
+
+
+
+
+
▸
+
search(params, abortController)
+
+
+
+
+
+
+
+ Search.
+
+ search(params:
Object, abortController: AbportController)
Parameters
+
+
+
+
+
params (Object)
+ Request parameters.
+
+
+
+
+
+
+
+ abortController (AbportController
+ = {})
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TrajservAPI
+
+
+
+
+
+
+ Access to Trajserv api.
+
+ new TrajservAPI(options: any)
+
+
+
+
+
+
+
+
+
+
+
+ Parameters
+
+
+
+
+ options (any
+ = {})
+
+
+
+
+
+
Example
+
+
+ import { TrajservAPI } from 'mobility-toolbox-js/src/api';
+
+
+
+
+
+
+ Instance Members
+
+
+
+
+
+
▸
+
fetchTrajectoryById(params, abortController)
+
+
+
+
+
+
+
+ Fetch a trajectory by id.
+
+ fetchTrajectoryById(params:
Object, abortController: AbportController)
Parameters
+
+
+
+
+
params (Object)
+ Request parameters.
+
+
+
+
+
+
+
+ abortController (AbportController
+ = {})
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
fetchTrajectories(params, abortController)
+
+
+
+
+
+
+
+ Fetch trajectories.
+
+ fetchTrajectories(params:
Object, abortController: AbportController)
Parameters
+
+
+
+
+
params (Object)
+ Request parameters.
+
+
+
+
+
+
+
+ abortController (AbportController
+ = {})
+
+
+
+
+
+
+
+
+
+
+
+
+
+
▸
+
fetchTrajectoryStations(params, abortController)
+
+
+
+
+
+
+
+ Fetch stations information about a trajectory.
+
+ fetchTrajectoryStations(params:
Object, abortController: AbportController)
Parameters
+
+
+
+
+
params (Object)
+ Request parameters.
+
+
+
+
+
+
+
+ abortController (AbportController
+ = {})
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+