Gets the source and layer identifiers for all sources managed by this module.
This property provides access to the MapLibre source and layer IDs that were created and are managed by this module. These IDs can be used to interact directly with MapLibre's API or to identify which layers belong to this module.
A record mapping each source name to its corresponding source ID and layer IDs. Each entry contains the MapLibre source identifier and an array of layer identifiers associated with that source.
The returned IDs are useful when you need to:
const ids = myModule.sourceAndLayerIDs;
console.log(ids);
// {
// mySource: {
// sourceID: 'my-source-id',
// layerIDs: ['layer-1', 'layer-2']
// }
// }
// Use with MapLibre API
const map = myModule.mapLibreMap;
ids.mySource.layerIDs.forEach(layerId => {
map.setLayoutProperty(layerId, 'visibility', 'visible');
});
Applies a configuration to this module.
This method updates the module's behavior and appearance based on the provided configuration. The configuration is stored internally and will be automatically reapplied if the map style changes.
The configuration object to apply to the module. Pass undefined to reset
the configuration to default values.
When a configuration is applied, the module updates its visual representation and behavior accordingly. The configuration persists across map style changes, ensuring consistent module behavior even when the map's base style is modified.
The given configuration replaces the current one rather than being merged into it. To change one part of it, use updateConfig.
// Apply a new configuration
myModule.applyConfig({ visible: true, color: '#E63312' });
// Reset to default configuration
myModule.applyConfig(undefined);
Remove all rendered incidents (source kept, data emptied).
Takes the event state off one of the shown features.
Takes the given event states, or all of them, off the shown features.
Optionaloptions: ClearEventStatesOptionsRetrieves a copy of the current module configuration.
This method returns a shallow copy of the configuration object that is currently
applied to the module. If no configuration has been applied, it returns undefined.
A shallow copy of the current configuration object, or undefined if no
configuration is currently applied. The returned object is a copy to prevent
unintended modifications to the internal state.
The returned configuration object is a shallow copy, which means that while the top-level properties are copied, any nested objects or arrays are still referenced from the original configuration. This is sufficient for most use cases but should be kept in mind when dealing 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 ids of the shown features that have an event state, by state.
The read side of setEventState and clearEventStates: it reflects those and
the states user interactions put. The ids are those getShown() and the event handlers hand
back, so each can go straight back into setEventState.
Returns the currently shown incidents — the exact data that was passed to show.
Reads the module's client-side cache (shownFeatures), mirroring the other GeoJSON
modules (PlacesModule, TrafficAreaAnalyticsModule, GeometriesModule). It does
not hit-test the viewport: the proxy already scopes and de-duplicates the
allEventFeatures it dispatches to click handlers, so no caller needs viewport-level
de-duplication here.
Whether the module is set to be shown: its visible setting, true unless set. A shown
module with nothing shown draws nothing; getShown() returns what is shown.
Resets the configuration of this module to its default values.
This is a convenience method that clears any previously applied configuration
and restores the module to its initial state. This is equivalent to calling
applyConfig(undefined).
After calling this method, the module will behave as if no configuration was ever applied. Any custom settings, styling, or behavior modifications will be removed and replaced with default values.
// Apply some configuration
myModule.applyConfig({ visible: true, color: '#E63312' });
// Later, reset to defaults
myModule.resetConfig();
Puts an event state on one of the shown features, as a user interaction would.
The state is what the module's own layers draw (place pins and entry points, route outlines,
geometries, details-module incidents, area-analytics cells), what layers of yours read with
['get', 'eventState'], and what getEventStates returns. It lasts as long as the shown
feature does: through setVisible, style and configuration changes, not through a new
show, a clear or a setStyle with resetState.
Mark a subset of currently-rendered incidents as "focused" via MapLibre
feature-state. null clears the state. Paint expressions in
incidentDetailsLayers.ts read ['feature-state', 'focused'] and pop the
focused subset (wider stripe + a theme-aware outline, the highlight config). Unfocused
features are unchanged — the highlight adds emphasis, it does not dim the rest.
No effect if called before show().
Shows or hides everything the module draws.
Stored as visible in the configuration. Showing and clearing data never change it: a hidden
module keeps its data, through style changes too, and draws it again on setVisible(true).
Showing leaves hidden what the configuration turns off: a route section type that is off, the layers a place marker type does not use.
Render the service result. Replaces any previously shown snapshot.
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 nested object that was there — and the result is applied with
applyConfig. This is the same on every module, whatever its applyConfig does with a
whole configuration.
The properties to change.
routing.applyConfig({ displayUnits: { distance: { type: 'imperial_us' } }, color: '#0a3653' });
routing.updateConfig({ color: '#c2185b' }); // displayUnits stays imperial
applyConfig to apply a whole configuration
ProtectedwaitStaticcreateCreates a new module instance on the given map, waiting until the map is ready first.
TrafficIncidentDetailsModule owns the sources, layers and images it adds, all suffixed per
instance. Every call therefore returns a new, independent instance, and stacking several
of them on one map is a supported thing to do.
trafficIncidentDetailsKnobCatalogue lists the plain-valued settings of config as data.
The TomTomMap instance.
Optionalconfig: TrafficIncidentDetailsModuleConfig
The module optional configuration.
Returns a promise with a new instance of this module.
Renders traffic incidents returned by
trafficIncidentDetails()on the map.Use this module when you fetch incidents via the Incident Details service and want to display them as a developer-controlled overlay. TrafficIncidentsModule is the vector-tile alternative — hidden in the default style, so this module renders on its own without collision; if you've enabled it elsewhere in your app, hide it again before using this module to avoid double-rendering.
Rendering approach
7–8 layers — 4 to 5 line (optional highlight-halo, outline, solid inner, direction chevron, pattern inner) and 3 symbol (incident marker, jam marker with delay text, closed-road marker). Per-magnitude styling uses match expressions on
magnitudeOfDelayinside a single layer instead of one layer per magnitude. Colours are read from the loaded style's incident layers (see ./util/readIncidentPalette), falling back to built-in defaults when absent, and read again whenever atraffic.incidents.*Colorstyling knob recolours them. Direction is rendered as a tiledline-pattern(chevron sprite registered at init) instead of the vector-tile module's per-featureroads-arrowsymbol — the pattern is continuous, so it reads on short jams and at planning zooms (z12+) where the per-feature symbol only activates at z15+.Focus and highlight
setFocus writes MapLibre feature-state
focused=true|falseon each rendered incident. The default highlight widens the focused subset and paints an outline beneath it (black on light map styles, white on dark); unfocused incidents are unchanged. A hovered or clicked incident (itseventState, see setEventState) draws the same highlight. Override or disable it via thehighlightconfig —highlight: falsekeepssetFocuswriting feature-state but emits no halo layer and no width pop, leaving callers free to drive their own styling offfeature-state.focusedandeventState.API limitations
The Incident Details REST API returns a feature list, not a rendering-ready tile. Several tags that the vector-tile pipeline injects per-feature are absent:
road_category,road_subcategory) — the vector-tile pipeline scales line width and offset by road class (motorway wider than street, stripe placed alongside the road on one carriageway). Without it, per-road-class geometry becomes a guess: we render every incident as a uniform stripe centred on the road, no offset.left_hand_traffic) — only meaningful when paired with road-class-driven offset; irrelevant here.display_class) — the vector-tile pipeline hides low-priority incidents at low zooms; we show everything above the layer minzoom.point_type) — the vector-tile pipeline limits jam and closed-road icons to line endpoints; we render on every matching feature.icon_category_1) — the vector-tile pipeline layers a cause icon (e.g. accident) over the jam icon; we show only the primary category.Callers wanting full per-road-class visual fidelity should use TrafficIncidentsModule instead.
Known limitations
queryRenderedFeatures, so hover and click cannot reach them. If you need to surface multiple incidents at one location, query the source data directly (theFeatureCollectionyou passed to show) rather than relying on render-time hit-testing.Example
Fetch and render incidents for Amsterdam:
See