The MapLibre source and layer IDs of all sources this module creates and manages.
A record mapping each source name to its MapLibre source ID and an array of the IDs of that source's layers.
Applies a configuration to this module.
The module updates its behaviour and appearance to match. It stores the configuration and reapplies it automatically when the map style changes.
The configuration to apply. Pass undefined to reset it to the default values.
The given configuration replaces the current one rather than being merged into it. To change one part of it, use updateConfig.
Use it for settings your code writes. It takes every setting, typed, including the ones no knob covers (layer specs, callbacks, MapLibre expressions), and checks no value at run time. For settings held as data, from a control, storage or a language model, use setKnobs.
// Apply a new configuration
myModule.applyConfig({ visible: true, color: '#E63312' });
// Reset to default configuration
myModule.applyConfig(undefined);
Returns a shallow copy of the current module configuration, or undefined if none is applied.
A shallow copy of the current configuration, or undefined. It is a copy so that you
can't modify the internal state by accident.
Only the top-level properties are copied. Nested objects and arrays still reference the original configuration. This is enough for most use cases, but keep it in mind with complex configurations.
// Apply a configuration
myModule.applyConfig({ visible: true, color: '#E63312' });
// Later, retrieve the current configuration
const currentConfig = myModule.getConfig();
console.log(currentConfig); // { visible: true, color: '#E63312' }
// When no config is applied
myModule.resetConfig();
console.log(myModule.getConfig()); // undefined
Returns the features the map renders in the viewport, from its vector tiles.
An object containing visible traffic flow features.
This is the only way to read live flow values, because Orbis traffic flow is vector tiles, with no service for a road, a point or an area. Results cover what is drawn in the current viewport and zoom, so a hidden module returns none, and a segment crossing a tile boundary appears once per tile. See TrafficFlowModuleFeature for what each carries.
Whether traffic flow is set to be shown.
The visible setting, or false if nothing has set it, as traffic is hidden until shown.
Resets this module's configuration to its default values.
It clears any applied configuration and restores the module to its initial state, the same
as calling applyConfig(undefined).
The module then behaves as if no configuration was ever applied. Any custom settings, styling or behaviour changes are replaced with default values.
// Apply some configuration
myModule.applyConfig({ visible: true, color: '#E63312' });
// Later, reset to defaults
myModule.resetConfig();
Changes part of the configuration and keeps the rest.
The given properties are laid over the current configuration one level deep, so a nested
object you pass replaces the one that was there. The result is applied with
applyConfig. This works the same on every module, whatever its applyConfig does with
a whole configuration.
The properties to change.
Use it for settings your code writes, as applyConfig: typed, and not checked at run time. To change nested values and keep the ones beside them, or to set values held as data, use setKnobs, which reaches each by its path and checks it.
routing.applyConfig({ displayUnits: { distance: { type: 'imperial_us' } }, color: '#0a3653' });
routing.updateConfig({ color: '#c2185b' }); // displayUnits stays imperial
applyConfig to apply a whole configuration
StaticgetRetrieves a TrafficFlowModule instance for the given map.
The map to attach this module to.
Optionalconfig: TrafficFlowModuleConfig
Optional configuration for initialization, visibility, and filters.
A promise that resolves to the initialized TrafficFlowModule.
The configuration takes:
visible - The initial visibility.filters - Road category and type filters.colors, widthFactor and opacityFactor - The colour of each flow level's lines, and their
width and opacity.trafficFlowKnobCatalogue lists the plain-valued settings as data.
If the style lacks traffic flow, get() reloads it with the trafficFlow part included.
The module that shows and configures real-time traffic flow on the map.
It controls the vector tile traffic flow layers, which colour road segments by current traffic speed.
Remarks
The module owns whether the style's traffic-flow layers are shown, for which roads, and how they look, through each flow level's colour (
colors), the line width (widthFactor) and the line opacity (opacityFactor). See Who owns what.Features:
The colours:
Example
Basic usage:
Example
Filter by road type:
Example
Restyle the flow:
See