AbstractThe style sources, with their layers, this module controls
The configuration type for this module, or undefined if no configuration is needed
ProtectedconstructorBuilds this module based on a given Maps SDK map.
The style sources, with their layers, this module controls
The configuration type for this module, or undefined if no configuration is needed
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.
Unless a module documents otherwise, 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, opacity: 0.8 });
// Reset to default configuration
myModule.applyConfig(undefined);
Retrieves 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, opacity: 0.8 });
// Later, retrieve the current configuration
const currentConfig = myModule.getConfig();
console.log(currentConfig); // { visible: true, opacity: 0.8 }
// When no config is applied
myModule.resetConfig();
console.log(myModule.getConfig()); // undefined
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, opacity: 0.5 });
// 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 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: 'imperial', theme: { mainColor: '#0a3653' } });
routing.updateConfig({ theme: { mainColor: '#c2185b' } }); // displayUnits stays imperial
applyConfig to apply a whole configuration
Protectedwait
Base class for the map modules that control sources and layers the loaded map style already provides, under fixed global IDs: the base map, POIs, the traffic tiles and the terrain.
Remarks
The style owns the data, so such a module brings no data of its own and shows nothing by itself. It changes how the parts the style provides are drawn, filtered and made visible. The SDK memoizes one instance per map, obtained with
get(map, config?), so every handle on it sees the same state.Because those sources and layers arrive with the style, they are in place as soon as the new style is loaded, and the module re-binds to them in the same tick. That is what the base class already does, so this class only names the kind, narrows the sources a module of this kind can hold, and hands it the map's LayerVisibilityComposer.