Marker

API Reference (beta) for <Marker />

Property Type Description
lnglat
required bindable
LngLat | {
  lng: number,
  lat: number
} | {
  lon: number,
  lat: number
} | [number, number]
-
class
optional
string
-
content
optional
Snippet<[]>
HTML content of the marker
children
optional
Snippet<[]>
-
ondrag
optional
Listener()
-
ondragstart
optional
Listener()
-
ondragend
optional
Listener()
-
element
optional
HTMLElement
DOM element to use as a marker. The default is a light blue, droplet-shaped SVG marker.
offset
optional
[number, number] | Point
The offset in pixels as a object to apply relative to the element's center. Negatives indicate left and up.
anchor
optional
"center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right"
A string indicating the part of the Marker that should be positioned closest to the coordinate set via . Options are `'center'`, `'top'`, `'bottom'`, `'left'`, `'right'`, `'top-left'`, `'top-right'`, `'bottom-left'`, and `'bottom-right'`.
color
optional
string
The color to use for the default marker if options.element is not provided. The default is light blue.
scale
optional
number
The scale to use for the default marker if options.element is not provided. The default scale corresponds to a height of `41px` and a width of `27px`.
draggable
optional
boolean
A boolean indicating whether or not a marker is able to be dragged to a new position on the map.
clickTolerance
optional
number
The max number of pixels a user can shift the mouse pointer during a click on the marker for it to be considered a valid click (as opposed to a marker drag). The default is to inherit map's clickTolerance.
rotation
optional
number
The rotation angle of the marker in degrees, relative to its respective `rotationAlignment` setting. A positive value will rotate the marker clockwise.
rotationAlignment
optional
"map" | "viewport" | "auto"
`map` aligns the `Marker`'s rotation relative to the map, maintaining a bearing as the map rotates. `viewport` aligns the `Marker`'s rotation relative to the viewport, agnostic to map rotations. `auto` is equivalent to `viewport`.
pitchAlignment
optional
"map" | "viewport" | "auto"
`map` aligns the `Marker` to the plane of the map. `viewport` aligns the `Marker` to the plane of the viewport. `auto` automatically matches the value of `rotationAlignment`.
opacity
optional
string
Marker's opacity when it's in clear view (not behind 3d terrain)
opacityWhenCovered
optional
string
Marker's opacity when it's behind 3d terrain
subpixelPositioning
optional
boolean
If `true`, rounding is disabled for placement of the marker, allowing for subpixel positioning and smoother movement when the marker is translated.