Marker

Class for creating markers on the map.

Extends: EventedEventedDynamicObjectEventTableEventedEventedDynamicObjectEventTableMarker

new constructor(map, options)

Example:

const marker = new mapgl.Marker(map, {
    coordinates: map.getCenter()
});

Parameters

map

Map

The map instance.

options

MarkerOptions

Marker options.

Returns

Marker

Methods

destroy()

Destroys the marker.

Returns

void

emit(type, data?)

Calls all event listeners with event type type

Parameters

type

K

Event type

data?

DynamicObjectEventTable<Marker>[K]

Data transferred to events

Returns

this

getCoordinates()

Returns current marker center in geographical coordinates [longitude, latitude].

Returns

number[]

getRotation()

Returns a clockwise rotation angle of the marker icon in degrees.

Returns

number

hide()

Hides the marker.

Returns

this

off(type, listener)

Removes event listener registered with on

Parameters

type

K

Event type

listener

(ev: DynamicObjectEventTable<Marker>[K]) => void

Event handler

Returns

this

on(type, listener)

Registers event listener

Parameters

type

K

Event type

listener

(ev: DynamicObjectEventTable<Marker>[K]) => void

Event handler

Returns

this

once(type, listener)

Registers event listener which will be called once

Parameters

type

K

Event type

listener

(ev: DynamicObjectEventTable<Marker>[K]) => void

Event handler

Returns

this

setCoordinates(coordinates)

Sets the geographical center of the marker.

Parameters

coordinates

number[]

Coordinates [longitude, latitude] where the center of the marker should be set.

Returns

this

setHoverIcon(iconOptions?)

Sets the hover icon of the marker. If you pass empty options, the current hover just will be deleted.

Parameters

iconOptions?

MarkerIconOptions

Options include icon URL, optional anchor and size.

Returns

this

setIcon(iconOptions)

Sets the icon of the marker.

Parameters

iconOptions

MarkerIconOptions

Options include icon URL, optional anchor and size.

Returns

this

setLabel(labelOptions?)

Sets the label of the marker. If you pass an empty label, the current one just will be deleted.

Parameters

labelOptions?

MarkerLabelOptions

Options of a new marker label.

Returns

this

setRotation(angle)

Sets the clockwise rotation of the icon.

Parameters

angle

number

Angle in degrees.

Returns

this

show()

Displays hidden marker.

Returns

this