TomTom Maps for JavaScript
    Preparing search index...

    Type Alias BaseMapModuleConfig

    BaseMapModuleConfig: MapModuleCommonConfig & {
        layerGroupsVisibility?: BaseMapLayerGroupsVisibility;
        visible?: boolean;
    }

    Configuration for the BaseMapModule (initialization or runtime).

    Controls visibility and behavior of base map layer groups. Can be used both during module initialization and for runtime updates.

    Type Declaration

    • OptionallayerGroupsVisibility?: BaseMapLayerGroupsVisibility

      Optional visibility configuration for specific layer groups.

      Use this to control visibility of layer groups at runtime without reinitializing the module.

      // Hide all building layers
      layerGroupsVisibility: {
        mode: 'include',
        names: ['buildings2D', 'buildings3D'],
        visible: false
      }

      // Show only labels
      layerGroupsVisibility: {
        mode: 'include',
        names: ['allPlaceLabels', 'cityLabels', 'countryLabels'],
        visible: true
      }
    • Optionalvisible?: boolean

      Controls the visibility of all layers associated with this module.

      true

    This configuration allows fine-grained control over which base map elements are displayed, enabling you to create custom map appearances for different use cases.

    // Hide specific layer groups
    const config: BaseMapModuleConfig = {
      layerGroupsVisibility: {
        mode: 'include',
        names: ['buildings2D', 'buildings3D'],
        visible: false
      }
    };

    // Show only certain groups
    const minimalConfig: BaseMapModuleConfig = {
      visible: true,
      layerGroupsVisibility: {
        mode: 'include',
        names: ['roads', 'water', 'land'],
        visible: true
      }
    };

    Settings
    Member Visibility