The location of the marker on the map.
Optional anchorA string indicating the part of the Marker that should be positioned closest to the coordinate set via Marker.setLngLat.
Options are 'center', 'top', 'bottom', 'left', 'right', 'top-left', 'top-right', 'bottom-left', and 'bottom-right'.
The default value os 'center'
Optional clickThe 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 (0) is to inherit map's clickTolerance.
Optional colorThe color to use for the default marker if options.element is not provided. The default is light blue (#3FB1CE).
Optional draggableA boolean indicating whether or not a marker is able to be dragged to a new position on the map. The default value is false
Optional offsetThe offset in pixels as a PointLike object to apply relative to the element's center. Negatives indicate left and up.
Optional onA collection of handlers for events with names defined by the EventTypes
generic.
on: {
click: evt => console.log(evt),
drag: evt => console.log(evt)
};
Optional click?: ((evt) => void) | ((evt) => any)Emitted when the Marker is clicked.
Optional drag?: ((evt) => void) | ((evt) => any)Optional dragend?: ((evt) => void) | ((evt) => any)Optional dragstart?: ((evt) => void) | ((evt) => any)Optional pitchmap 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.
The default value is auto.
Optional rotationThe rotation angle of the marker in degrees, relative to its rotationAlignment setting. A positive value will rotate the marker clockwise.
The default value is 0.
Optional rotationmap 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.
The default value is auto
Optional scaleThe scale to use for the default marker if options.element is not provided.
The default scale (1) corresponds to a height of 41px and a width of 27px.
Generated using TypeDoc
Objects that implement this interface will create or interact with a marker control.
See
Mapbox Marker Parameters