Class CustomGeoJSONModule<TSources>

Module for displaying customer-owned GeoJSON data with TomTom SDK support.

Wraps one or more MapLibre GeoJSON sources together with caller-supplied layer specs, and adds the usual TomTom SDK lifecycle behaviour on top: style-change restoration, config-change / shown-features events, and per-source user interaction events (click, hover, long-hover, contextmenu).

Unlike opinionated modules such as PlacesModule or GeometriesModule, this module makes no assumptions about how data is rendered — the caller passes raw MapLibre layer specs (circle, heatmap, fill, line, symbol, …).

Example

Single source, default generic:

const module = await CustomGeoJSONModule.get(map, {
    sources: {
        points: {
            layers: [{ type: 'circle', paint: { 'circle-radius': 4, 'circle-color': '#0a3653' } }],
        },
    },
});

await module.show(myFeatureCollection, 'points');
module.events.points.on('click', (feature, lngLat) => console.log(feature, lngLat));

Example

Multiple sources with typed payloads:

type Sources = {
    heatmap: FeatureCollection<Point>;
    buildings: FeatureCollection<Polygon, { name: string }>;
};

const module = await CustomGeoJSONModule.get<Sources>(map, {
    sources: {
        heatmap: { layers: [{ type: 'heatmap', paint: { 'heatmap-radius': 12 } }] },
        buildings: { layers: [{ type: 'fill', paint: { 'fill-color': '#5a5' } }] },
    },
});

await module.show(heatmapData, 'heatmap');
await module.show(buildingData, 'buildings');

Example

Same data, multiple renderings — call show once without a source name:

type Buildings = FeatureCollection<Point, { Name: string }>;

const module = await CustomGeoJSONModule.get<{ heatmap: Buildings; markers: Buildings }>(map, {
    sources: {
        heatmap: { layers: heatmapLayers },
        markers: { layers: markerLayers },
    },
});

await module.show(buildingData); // applied to both sources

Type Parameters

TSources extends Record<string, FeatureCollection> = Record<string, FeatureCollection>
A record mapping source names to the FeatureCollection type each source carries. Pass this generic when you want type-safe show / getShown per source.

Hierarchy (View Summary)

AbstractMapModule<
CustomGeoJSONSourcesWithLayers<TSources>,
CustomGeoJSONModuleConfig<TSources>,
>
- CustomGeoJSONModule

Index

Accessors

events sourceAndLayerIDs

Methods

applyConfig clear getConfig getShown resetConfig setVisible show waitUntilModuleReady get

Accessors

events

get events(): CustomGeoJSONEvents<TSources>
Per-source events surface.

Each key on the returned object is one of the source names declared in CustomGeoJSONModuleConfig.sources. Each value is a CombinedEvents instance covering both user interactions (click, hover, long-hover, contextmenu) and module lifecycle events (config-change, shown-features).

config-change handlers are module-wide (the same handler array is shared across every source's CombinedEvents). shown-features handlers fire only for their own source.

Returns CustomGeoJSONEvents<TSources>
Example
```
module.events.buildings.on('click', (feature, lngLat) => { ... });
module.events.heatmap.on('shown-features', (data) => { ... });
module.events.buildings.on('config-change', (config) => { ... });
```

sourceAndLayerIDs

get sourceAndLayerIDs(): Record<keyof SOURCES_WITH_LAYERS, SourceWithLayerIDs>
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.

Returns Record<keyof SOURCES_WITH_LAYERS, SourceWithLayerIDs>
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.
Remarks
The returned IDs are useful when you need to:
- Directly manipulate layers using MapLibre's native API
- Identify which layers on the map belong to this module
- Set layer ordering or positioning relative to other layers
- Access source or layer properties through MapLibre methods
Example
```
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');
});
```
Inherited from AbstractMapModule.sourceAndLayerIDs

Methods

applyConfig

applyConfig(config: CustomGeoJSONModuleConfig<TSources> | undefined): void
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.
Parameters
- config: CustomGeoJSONModuleConfig<TSources> | undefined
  The configuration object to apply to the module. Pass undefined to reset the configuration to default values.
Returns void
Remarks
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.
Example
```
// Apply a new configuration
myModule.applyConfig({ visible: true, opacity: 0.8 });

// Reset to default configuration
myModule.applyConfig(undefined);
```
See
- resetConfig for a convenience method to reset configuration
- getConfig to retrieve the current configuration
Inherited from AbstractMapModule.applyConfig

clear

clear(sourceName?: keyof TSources): Promise<void>
Clears data from the given source — or from all sources when no name is supplied.
Parameters
- OptionalsourceName: keyof TSources
Returns Promise<void>

getConfig

getConfig(): NonNullable<CustomGeoJSONModuleConfig<TSources>> | 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.

Returns NonNullable<CustomGeoJSONModuleConfig<TSources>> | 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.
Remarks
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.
Example
```
// 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
```
See
- applyConfig to modify the configuration
- resetConfig to clear the configuration
Inherited from AbstractMapModule.getConfig

getShown

getShown(): { [K in string | number | symbol]: TSources[K] }
Returns the feature collection currently shown on each source.

Sources that have never been shown (or have been cleared) return the empty feature collection that GeoJSONSourceWithLayers keeps as initial state.

Returns { [K in string | number | symbol]: TSources[K] }

resetConfig

resetConfig(): void
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).

Returns void
Remarks
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.
Example
```
// Apply some configuration
myModule.applyConfig({ visible: true, opacity: 0.5 });

// Later, reset to defaults
myModule.resetConfig();
```
See
- applyConfig to apply a new configuration
- getConfig to retrieve the current configuration before resetting
Inherited from AbstractMapModule.resetConfig

setVisible

setVisible(visible: boolean): void
Toggles visibility of every layer across every source.
Parameters
- visible: boolean
Returns void
Remarks
Calling show on a source after setVisible(false) will re-reveal that source's layers via GeoJSONSourceWithLayers' automatic visibility behaviour. To keep a source hidden, call setVisible(false) after the next show.

show

show<K extends string | number | symbol>(
data: TSources[K],
sourceName?: K,
): Promise<void>
Displays the given GeoJSON data on the named source — or on every source when no name is supplied.

Replaces any previously shown data. Layer visibility is set automatically based on whether the feature collection is non-empty.
Type Parameters
- K extends string | number | symbol
Parameters
- data: TSources[K]
  The GeoJSON feature collection to display.
- OptionalsourceName: K
  The source name (must match a key from CustomGeoJSONModuleConfig.sources). When omitted, data is shown on every source — best used when every source shares the same FeatureCollection shape.
Returns Promise<void>

`Protected`waitUntilModuleReady

waitUntilModuleReady(): Promise<void>
Returns Promise<void>
Inherited from AbstractMapModule.waitUntilModuleReady

`Static`get

get<
    TSources extends
        Record<string, FeatureCollection<Geometry, GeoJsonProperties>> = Record<
        string,
        FeatureCollection<Geometry, GeoJsonProperties>,
    >,
>(
    tomtomMap: TomTomMap,
    config: CustomGeoJSONModuleConfig<TSources>,
): Promise<CustomGeoJSONModule<TSources>>
Creates a new CustomGeoJSONModule once the map is ready.
Type Parameters
- TSources extends Record<string, FeatureCollection<Geometry, GeoJsonProperties>> = Record<string, FeatureCollection<Geometry, GeoJsonProperties>>
Parameters
- tomtomMap: TomTomMap
  The TomTomMap instance.
- config: CustomGeoJSONModuleConfig<TSources>
  Module configuration. sources is required and must contain at least one entry; each entry must have at least one layer.
Returns Promise<CustomGeoJSONModule<TSources>>

Class CustomGeoJSONModule<TSources>

Example

Example

Example

Type Parameters

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

events

Returns CustomGeoJSONEvents<TSources>

Example

sourceAndLayerIDs

Returns Record<keyof SOURCES_WITH_LAYERS, SourceWithLayerIDs>

Remarks

Example

Methods

applyConfig

Parameters

Returns void

Remarks

Example

See

clear

Parameters

Returns Promise<void>

getConfig

Returns NonNullable<CustomGeoJSONModuleConfig<TSources>> | undefined

Remarks

Example

See

getShown

Returns { [K in string | number | symbol]: TSources[K] }

resetConfig

Returns void

Remarks

Example

See

setVisible

Parameters

Returns void

Remarks

show

Type Parameters

Parameters

Returns Promise<void>

ProtectedwaitUntilModuleReady

Returns Promise<void>

Staticget

Type Parameters

Parameters

Returns Promise<CustomGeoJSONModule<TSources>>

Settings

On This Page

`Protected`waitUntilModuleReady

`Static`get