CircleMarker | MapGL | 2GIS Documentation
MapGL JS API
Maps
Search
Navigation
On-Premise
Urbi Pro
CityLens

CircleMarker

Class for creating a circleMarker on the map

The CircleMarker differs from the Circle in that it has radius in pixels so its instance displays the same on any zoom level

Extends: EventedEventedDynamicObjectEventTableEventedEventedDynamicObjectEventTableCircleMarker
new constructor(map, options)

Example:

const circleMarker = new mapgl.CircleMarker(map, {
    coordinates: map.getCenter(),
    radius: 500,
});
Parameters
map
Map

The map instance

options
CircleMarkerOptions

CircleMarker options

Returns
Methods
destroy()

Destroys the circleMarker

Returns
void
emit(type, data?)

Calls all event listeners with event type type

Parameters
type
K

Event type

data?
DynamicObjectEventTable<CircleMarker>[K]

Data transferred to events

Returns
this
off(type, listener)

Removes event listener registered with on

Parameters
type
K

Event type

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

Event handler

Returns
this
on(type, listener)

Registers event listener

Parameters
type
K

Event type

listener
(ev: DynamicObjectEventTable<CircleMarker>[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<CircleMarker>[K]) => void

Event handler

Returns
this