Type Alias PlacesModuleConfig<P>

Type Declaration

• OptionalbeforeLayerConfig?: PlacesBeforeLayerConfig

  Where the module's layers sit in the map's layer stack, for everything it draws or per part.

  Remarks

  Left out, every layer sits where PlacesBeforeLayerConfig says it does by default.

• Optionalcluster?: PlacesClusterConfig

  How the pin-clustered marker type clusters places and draws the cluster badge.

• Optionalcolor?: string

  The colour of this module's own drawing: the default pin fill, the label of a hovered or clicked place, connection lines and entry points. Connection labels take a darker shade of it on a light map and a lighter one on a dark map; entry points take the darker one on a light map.

  Remarks

  A more specific setting wins for its element: icon.default.style.fillColor for the pin, label.color or a layers.* paint override for a label or layer. Unset, it is the map's accent colour (TomTomMap.mapColors), and without one the SDK's own colours. Cluster badges do not take it: PlaceClusterBadgeConfig.color sets them.

• Optionalconnections?: PlaceConnectionsConfig

  Configuration for connection lines drawn between places via PlacesModule.showConnections.

  Remarks

  When omitted, connections rendered via showConnections use default styling (a dashed line) and no label.

• OptionalentryPoints?: PlaceEntryPointsConfig

  Configuration for drawing the entry points of the shown places.

  Remarks

  When omitted, entry points are not drawn.

• OptionalevAvailability?: EVAvailabilityConfig

  Configuration for EV charging station availability display.

  Remarks

  Disabled by default - set enabled: true to show availability on EV stations. Requires calling getPlacesWithEVAvailability to fetch availability data.

  Default

  undefined (disabled)
  Copy

• OptionalextraFeatureProps?: Record<string, ExtraFeatureProp<P>>

  Additional properties to compute for each place feature.

  These properties are added to the feature and can be used in styling expressions or event handlers. Values can be static or computed from place data.

  Remarks

  Useful for:

  • Adding computed flags for conditional styling via 'layers' config.
  • Extracting nested properties for easier access
  • Adding business logic properties

  Example

  extraFeatureProps: {
    // Static property
    source: 'search-results',
  
    // Computed property
    category: (place) => place.properties.poi?.categories?.[0],
    brand: (place) => place.properties.poi?.brands?.[0] ?? '',
    hasOpeningHours: (place) => !!place.properties.poi?.openingHours,
  
    // Complex computation
    distanceFromCenter: (place) => {
      const coords = place.geometry.coordinates;
      return Math.sqrt(Math.pow(coords[0] - 4.9, 2) + Math.pow(coords[1] - 52.3, 2));
    }
  }
  Copy

• Optionalicon?: PlaceIconConfig<P>

  The default pin, and custom icons per place category.

• Optionallabel?: PlaceLabelConfig<P>

  The labels next to place markers: their content, styling and position.

• Optionallayers?: PlaceLayersConfig

  MapLibre overrides for the places layers, for control the other settings do not offer.

  Remarks

  Each override lays its layout and paint properties over the layer's own, one by one, and wins over label and color for the properties it names.

• OptionalmarkerType?: PlacesMarkerType

  The kind of marker all places are drawn with.

  Remarks

  PlaceIconConfig.categoryIcons replace its icon for the categories they name, under every marker type.

  Default

  'pin'
  Copy

• Optionalvisible?: boolean

  Whether the module draws anything: places, connections and entry points.

  Remarks

  show() and clear() never change it — a hidden module keeps its data until PlacesModule.setVisible shows it again. Layers the marker type does not use, and any hidden through layers, stay hidden while the module is shown.

  Default

  true
  Copy