Type Alias BaseMapLayerGroups

Layer group filter for selective base map display.

Defines which layer groups to include or exclude from the base map module. Can be expressed as explicit inclusions (show only these) or exclusions (show all except these).

Remarks

Filter Modes:

include: the specified groups
exclude: every layer outside the specified groups, which BaseMapModule.setVisible leaves as they were.

Common Use Cases:

Show only roads and labels (minimal map)
Hide buildings for cleaner appearance
Show only water and land (base terrain)
Remove labels for overlay maps

Example

// Show only roads and borders
const roadsOnly: BaseMapLayerGroups = {
  mode: 'include',
  names: ['roads', 'roadLabels', 'borders']
};

// Show everything except buildings
const noBuildings: BaseMapLayerGroups = {
  mode: 'exclude',
  names: ['buildings2D', 'buildings3D']
};

// Show only terrain (no labels, no roads)
const terrainOnly: BaseMapLayerGroups = {
  mode: 'include',
  names: ['land', 'water']
};

type BaseMapLayerGroups = {
mode: "include" | "exclude";
names: BaseMapLayerGroupName[];
}

Index

Properties

mode names

Properties

mode

mode: "include" | "exclude"

Filter mode determining whether groups are included or excluded.

Remarks

include: Only the specified groups are considered, all others are ignored
exclude: All base map groups except the specified ones are considered

Example

mode: 'include'  // Whitelist approach
mode: 'exclude'  // Blacklist approach

names

names: BaseMapLayerGroupName[]

Names of the layer groups to include or exclude.

Remarks

The meaning depends on the mode:

In include mode: These groups are shown or hidden
In exclude mode: All other groups are shown or hidden, and these are left as they were

Example

// Show only these
names: ['roads', 'roadLabels', 'water']

// Hide these
names: ['buildings2D', 'buildings3D', 'houseNumbers']

Type Alias BaseMapLayerGroups

Remarks

Example

Index

Properties

Properties

mode

Remarks

Example

names

Remarks

Example

Settings

On This Page