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 every layer but the module's own titles, a MapStyleLayerID below that style 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), otherwise a theme-adaptive default: '#0A3653' on light map styles and '#5FA8D8' on dark.

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

• Optionalfill?: GeometryFillConfig

  The interior colour and opacity of polygon geometries.

• Optionalhighlight?: GeometryHighlightConfig

  How a hovered or clicked geometry is drawn.

• Optionallabel?: GeometryLabelConfig

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

• Optionallayers?: GeometryLayersConfig

  MapLibre overrides for the fill, border and label layers.

• Optionalline?: GeometryLineConfig

  The border, or 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, line) 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 its 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 layer hidden through its layers entry's layout.visibility stays hidden while the module is shown.

  Default

  true
  Copy