Skip to content

marker-config.md

Latest commit

 

History

History
93 lines (60 loc) · 2.9 KB

marker-config.md

File metadata and controls

93 lines (60 loc) · 2.9 KB

MarkerConfig

Configuration for a map marker. Used in the markers option to define initial markers.

Properties

id

Type: string Required

Unique marker identifier. Use this ID to reference the marker when calling removeMarker().

coords

Type: [number, number] Required

Coordinates [lng, lat] or [easting, northing] depending on the CRS of the map provider.

options

Type: MarkerOptions

Optional marker appearance options. See MarkerOptions below.

MarkerOptions

Controls the visual appearance of a marker. All properties are optional — unset values fall back through the resolution order.

symbol

Type: string Default: 'pin'

Symbol to use for this marker. Built-in values: 'pin', 'circle'. Ignored when symbolSvgContent is set.

symbolSvgContent

Type: string

Inner SVG path content (no <svg> wrapper) to render instead of a registered symbol. Use {{token}} placeholders for colours. When set, symbol is ignored.

markers.add('id', coords, {
  symbolSvgContent: `
    <path d="..." fill="none" stroke="{{selectedColor}}" stroke-width="{{selectedWidth}}"/>
    <path d="..." fill="{{backgroundColor}}" stroke="{{haloColor}}" stroke-width="{{haloWidth}}"/>
    <path d="..." fill="{{foregroundColor}}"/>
  `,
  viewBox: '0 0 38 38',
  anchor: [0.5, 1],
  backgroundColor: { outdoor: '#d4351c', dark: '#ff6b6b' }
})

{{selectedColor}} and {{selectedWidth}} are valid tokens — they are resolved when the marker is in its selected state. selectedColor comes from MapStyleConfig.selectedColor, falling back to the mapColorScheme scheme default (#0b0c0c light / #ffffff dark). It cannot be set per marker. selectedWidth follows the normal symbol cascade and can be set via constructor symbolDefaults.

viewBox

Type: string Default: registered symbol's viewBox, or '0 0 38 38'

SVG viewBox attribute for the symbol. Use alongside symbolSvgContent when your paths use a different coordinate space.

anchor

Type: [number, number] Default: registered symbol's anchor, or [0.5, 0.5]

Normalised [x, y] anchor point where [0, 0] is top-left and [1, 1] is bottom-right. Determines which point on the symbol aligns with the geographic coordinate.

anchor: [0.5, 1]   // bottom-centre — tip of a pin
anchor: [0.5, 0.5] // centre — circle or dot

Colour and graphic properties

backgroundColor, foregroundColor, haloWidth, graphic, selectedWidth, and any custom tokens are all supported. See Symbol Config for the full property reference including style-keyed colour objects, built-in graphic names, and custom token substitution.

haloColor and selectedColor are basemap-level properties set on MapStyleConfig — they cannot be set per marker.