Type Alias GeometriesModuleConfig

Type Declaration

• OptionalbeforeLayerConfig?: GeometryBeforeLayerConfig

  Layer positioning configuration.

  Controls where geometry layers appear in the map's layer stack. Use 'top' to place above all layers, or specify a layer ID to place below that layer.

  Example

  // On top of everything
  beforeLayerConfig: 'top'
  
  // Below map labels
  beforeLayerConfig: 'lowestLabel'
  
  // Below POI layer
  beforeLayerConfig: 'POI'
  Copy

• OptionalcolorConfig?: GeometryColorConfig

  Fill color and opacity configuration.

  Controls the interior color and transparency of polygon geometries.

• OptionallineConfig?: GeometryLineConfig

  Border/outline configuration.

  Controls the outline appearance of polygon geometries.

• OptionallineLabelConfig?: GeometryLineLabelConfig

  Line label configuration.

  When set, labels are placed along the polygon border lines.

• OptionaltextConfig?: GeometryTextConfig

  Text label configuration.

  Controls labels displayed at geometry center points.

• Optionaltheme?: GeometryTheme

  Visual theme applied to all features shown by this module.

  • '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 theme in their properties.

  Example

  // Show the "rest of the world" outside a country
  const module = await GeometriesModule.get(map, {
      theme: 'inverted',
      colorConfig: { fillColor: 'black', fillOpacity: 0.5 }
  });
  module.show(countryGeometry);
  Copy

• 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

  Used internally by reachableRangeGeometryConfig to generate budget labels (e.g. '30 min') from feature properties. For most use cases, the standard config fields (colorConfig, textConfig, theme) suffice.

  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