Circle | MapGL | 2GIS Documentation
Documentation
ру
en

Circle

Class for creating a circle on the map

Extends: EventedEventedDynamicObjectEventTable
new constructor(map, options)

Example:

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

The map instance

options
CircleOptions

Circle options

Returns
Methods
destroy()

Destroys the circle

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
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