Type Alias GeometriesModuleConfig

Type Declaration

• OptionalbeforeLayerConfig?: GeometryBeforeLayerConfig

  Layer positioning configuration.

  Controls where geometry layers appear in the map's layer stack: 'top' places them above all layers, a layer ID below that layer, and a { all, fill, line } record each part on its own.

  Example

  // On top of everything
  beforeLayerConfig: 'top'
  
  // Below map labels
  beforeLayerConfig: 'lowestLabel'
  
  // Fill below the road network, border below labels
  beforeLayerConfig: { fill: 'lowestRoadLine', line: 'lowestLabel' }
  Copy

• Optionalcolor?: string

  Base colour of the fill and the border, as a CSS colour string.

  Remarks

  Precedence, highest first:

  • Fill: a feature's own color property, fill.color, fill.palette, this field.
  • Border: line.color, a feature's own color property, fill.color, fill.palette, this field.
  • Then, for both: the map's accent when a theme sets one (TomTomMap.mapColors), else a theme-adaptive default — '#0A3653' on light map styles, '#5FA8D8' on dark (custom styles count as light).

  With fillStyle: 'outline' the border ends its chain on a neutral grey instead of the accent or the default.

• Optionalfill?: GeometryFillConfig

  Fill color and opacity.

  Controls the interior color and transparency of polygon geometries.

• OptionalfillStyle?: GeometryFillStyle

  How every feature shown by this module is filled.

  • 'filled' — Colored fill with thin border (default)
  • 'outline' — Transparent fill with thick colored border
  • 'inverted' — Colors the area outside the polygon (donut geometry)

  Individual features can override this by setting fillStyle in their properties.

  Example

  // Show the "rest of the world" outside a country
  const module = await GeometriesModule.create(map, {
      fillStyle: 'inverted',
      fill: { color: 'black', opacity: 0.5 }
  });
  module.show(countryGeometry);
  Copy

• Optionalhighlight?: GeometryHighlightConfig

  How a hovered or clicked geometry is drawn.

• Optionallabel?: GeometryLabelConfig

  The label at each geometry's center: its text and styling.

• Optionalline?: GeometryLineConfig

  Border/outline configuration.

  Controls the outline appearance of polygon geometries.

• OptionallineLabel?: GeometryLineLabelConfig

  Labels along the polygon border lines, drawn only when this is set ({} for the defaults).

• OptionaltransformFeaturesForDisplay?: (input: PolygonFeatures) => PolygonFeatures

  Transform applied to features before rendering.

  Receives the value passed to GeometriesModule.show and returns features ready for display. Useful for deriving labels or other display properties from domain data.

  Remarks

  For most use cases the standard config fields (fill, label, fillStyle) suffice. Reachable ranges have their own module, ReachableRangesModule, which titles and colours each band.

  Example

  // Derive title from a custom property
  const config: GeometriesModuleConfig = {
      transformFeaturesForDisplay: (fc) => ({
          ...fc,
          features: fc.features.map((f) => ({
              ...f,
              properties: { ...f.properties, title: f.properties?.customLabel },
          })),
      }),
  };
  Copy

• Optionalvisible?: boolean

  Whether the module draws anything: fills, borders, center labels and border labels.

  Remarks

  show() and clear() never change it — a hidden module keeps its data until GeometriesModule.setVisible shows it again. A border hidden through line.layer.layout.visibility stays hidden while the module is shown.

  Default

  true
  Copy