Marker | MapGL | 2GIS Documentation
Documentation
2GIS
∂ev
API&SDK

Marker

Class for creating markers on the map.

Extends: EventedEventedDynamicObjectEventTable
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
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[K]

Data transferred to events

Returns
this
getCoordinates()

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

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[K]) => void

Event handler

Returns
this
on(type, listener)

Registers event listener

Parameters
type
K

Event type

listener
(ev: DynamicObjectEventTable[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[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
show()

Displays hidden marker.

Returns
this