MglMarker

Creates a marker component

See Marker.

import { MglMarker } from '@indoorequal/vue-maplibre-gl';

Props

coordinates

• Type: LngLatLike
• Required: true
• Default: undefined

Marker coordinates

offset

• Type: undefined
• Required: false
• Default: undefined

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

anchor

• Type: PositionAnchor
• Required: false
• Default: undefined

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'

color

• Type: string
• Required: false
• Default: undefined

The color to use for the default marker if options.element is not provided. The default is light blue. Default Value '#3FB1CE'

draggable

• Type: boolean
• Required: false
• Default: undefined

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

clickTolerance

• Type: number
• Required: false
• Default: undefined

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

rotation

• Type: number
• Required: false
• Default: undefined

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

rotationAlignment

• Type: string
• Required: false
• Default: undefined

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'

pitchAlignment

• Type: string
• Required: false
• Default: undefined

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'

scale

• Type: number
• Required: false
• Default: undefined

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

opacity (since 7.0.0)

• Type: string
• Required: false
• Default: undefined

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

opacityWhenCovered (since 7.0.0)

• Type: string
• Required: false
• Default: undefined

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

subpixelPositioning (since 7.5.0)

• Type: boolean
• Required: false
• Default: false

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

Events

dragstart

Fired when dragging starts

drag

Fired while dragging

dragend

Fired when the marker is finished being dragged

update:coordinates

Fired when the coordinates have been updated

Slots

marker

Slot for custom marker

default

Slot for popup component

Source

See source.