TomTom Maps for JavaScript
    Preparing search index...

    Type Alias BaseMapModuleInitConfig

    BaseMapModuleInitConfig: BaseMapModuleConfig & {
        layerGroupsFilter?: BaseMapLayerGroups;
    }

    Initialization configuration for the BaseMapModule.

    Extends BaseMapModuleConfig with additional options available only during module initialization.

    Type Declaration

    • OptionallayerGroupsFilter?: BaseMapLayerGroups

      Layer groups to include/exclude during module initialization.

      One-time configuration: This can only be set during initialization. Once the module is created, you cannot change which groups are loaded, only their visibility via layerGroupsVisibility.

      // Load only essential layers
      layerGroupsFilter: {
        mode: 'include',
        names: ['land', 'water', 'roadLines', 'borders']
      }

      // Load everything except 3D buildings
      layerGroupsFilter: {
        mode: 'exclude',
        names: ['buildings3D']
      }

      // Minimal overlay map
      layerGroupsFilter: {
        mode: 'include',
        names: ['water', 'land']
      }

    Initialization vs Runtime:

    • layerGroupsFilter: Only available at init - determines which groups to load
    • layerGroupsVisibility: Available at init and runtime - controls visibility

    Use Cases:

    • Create minimal maps with only essential layers
    • Build custom map styles by excluding certain features
    • Optimize performance by not loading unnecessary layers
    // Initialize with only roads and water
    const initConfig: BaseMapModuleInitConfig = {
      layerGroupsFilter: {
        mode: 'include',
        names: ['roadLines', 'roadLabels', 'water', 'land']
      },
      visible: true
    };

    // Exclude buildings from initialization
    const noBuildingsConfig: BaseMapModuleInitConfig = {
      layerGroupsFilter: {
        mode: 'exclude',
        names: ['buildings2D', 'buildings3D', 'houseNumbers']
      }
    };

    // Minimal map for data overlay
    const overlayBaseConfig: BaseMapModuleInitConfig = {
      layerGroupsFilter: {
        mode: 'include',
        names: ['water', 'land', 'borders']
      },
      visible: true
    };

    Settings

    Member Visibility