Interface SetupMarkerOptions

interface SetupMarkerOptions {
    anchor?: PositionAnchor;
    className?: string;
    clickTolerance?: number;
    color?: string;
    draggable?: boolean;
    element: HTMLElement;
    feature?: Feature<Point, GeoJsonProperties>;
    lngLat?: LngLatLike;
    offset?: PointLike;
    opacity?: string;
    opacityWhenCovered?: string;
    pitchAlignment?: Alignment;
    rotation?: number;
    rotationAlignment?: Alignment;
    scale?: number;
    subpixelPositioning?: boolean;
}

Hierarchy

  • MarkerOptions
    • SetupMarkerOptions

Properties

anchor? className? clickTolerance? color? draggable? element feature? lngLat? offset? opacity? opacityWhenCovered? pitchAlignment? rotation? rotationAlignment? scale? subpixelPositioning?

Properties

Optionalanchor

anchor?: PositionAnchor

A 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'.

Default Value

'center'

OptionalclassName

className?: string

Space-separated CSS class names to add to marker element.

OptionalclickTolerance

clickTolerance?: 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.

Default Value

0

Optionalcolor

color?: string

The color to use for the default marker if options.element is not provided. The default is light blue.

Default Value

'#3FB1CE'

Optionaldraggable

draggable?: boolean

A boolean indicating whether or not a marker is able to be dragged to a new position on the map.

Default Value

false

element

element: HTMLElement

DOM element to use as a marker. The default is a light blue, droplet-shaped SVG marker.

Optionalfeature

feature?: Feature<Point, GeoJsonProperties>

OptionallngLat

lngLat?: LngLatLike

Optionaloffset

offset?: PointLike

The offset in pixels as a PointLike object to apply relative to the element's center. Negatives indicate left and up.

Optionalopacity

opacity?: string

Marker's opacity when it's in clear view (not behind 3d terrain)

Default Value

1

OptionalopacityWhenCovered

opacityWhenCovered?: string

Marker's opacity when it's behind 3d terrain

Default Value

0.2

OptionalpitchAlignment

pitchAlignment?: Alignment

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.

Default Value

'auto'

Optionalrotation

rotation?: number

The rotation angle of the marker in degrees, relative to its respective rotationAlignment setting. A positive value will rotate the marker clockwise.

Default Value

0

OptionalrotationAlignment

rotationAlignment?: Alignment

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.

Default Value

'auto'

Optionalscale

scale?: 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.

Default Value

1

OptionalsubpixelPositioning

subpixelPositioning?: boolean

If true, rounding is disabled for placement of the marker, allowing for subpixel positioning and smoother movement when the marker is translated.

Default Value

false

Settings

Member Visibility

On This Page

Properties