Skip to main content

class

Control​

Class for the map's controls creating.
new constructor(map, content, options)
Example: ```js const control = new mapgl.Control( map, '<button>Some text</button>', { position: 'topLeft' }, ); ```
Parameters
map
Map<>
The map instance.
content
string
Control HTML content.
options
ControlOptions
Control options.
Returns
Control<>
Methods
destroy
Destroys the control.
Returns
void
getContainer
Returns the container of the control.
Returns
HTMLDivElement<>
getPosition
Returns the position of the control.
Returns
ControlPosition
setPosition(position)
Sets the position of the control.
Parameters
position
ControlPosition
Required position of the control.
Returns
void

Evented​

Event emitter
new constructor
Returns
Evented<M>
Methods
emit(type, data?)
Calls all event listeners with event type `type`
Parameters
type
K
Event type
data?
M[K]
Data transferred to events
Returns
this
off(type, listener)
Removes event listener registered with `on`
Parameters
type
K
Event type
listener
(ev: M[K]) => void
Event handler
Returns
this
on(type, listener)
Registers event listener
Parameters
type
K
Event type
listener
(ev: M[K]) => void
Event handler
Returns
this
once(type, listener)
Registers event listener which will be called once
Parameters
type
K
Event type
listener
(ev: M[K]) => void
Event handler
Returns
this

Ruler​

A class that provides ruler functionality.
Extends: Evented<RulerEventTable>
new constructor(map, options)
Example: ```js const ruler = new mapgl.Ruler(map, {}); ruler.setPoints([ [55.31878, 25.23584], [55.35878, 25.23584], [55.35878, 25.26584], ]); ```
Parameters
map
Map<>
The map instance.
options
Ruler initialization options.
Returns
Ruler<>
Methods
destroy
Destroys the ruler.
Returns
void
disable
Disables the ruler display.
Returns
void
emit(type, data?)
Calls all event listeners with event type `type`
Parameters
type
K
Event type
data?
RulerEventTable[K]
Data transferred to events
Returns
this
enable
Enables the ruler display.
Returns
void
getData
Get ruler data depending on the ruler mode.
Returns
off(type, listener)
Removes event listener registered with `on`
Parameters
type
K
Event type
listener
(ev: RulerEventTable[K]) => void
Event handler
Returns
this
on(type, listener)
Registers event listener
Parameters
type
K
Event type
listener
(ev: RulerEventTable[K]) => void
Event handler
Returns
this
once(type, listener)
Registers event listener which will be called once
Parameters
type
K
Event type
listener
(ev: RulerEventTable[K]) => void
Event handler
Returns
this
setLabelsVisibility(settings)
Set labels visibility.
Parameters
settings
Visibility settings for label groups.
Returns
void
setPoints(points)
Sets new points. This overrides the previous points.
Parameters
points
GeoPoint[]
An array of geographical points [longitude, latitude].
Returns
void

RulerControl​

A class that provides a ruler control on the map.
Extends: Control
new constructor(map, options)
Example: ```js const control = new mapgl.RulerControl(map, {{ position: 'centerRight' }}); control.getRuler().setPoints([ [55.31878, 25.23584], [55.35878, 25.23584], [55.35878, 25.26584], ]); ```
Parameters
map
Map<>
The map instance.
options
Ruler control initialization options.
Returns
RulerControl<>
Methods
destroy
Destroys the control and the ruler.
Returns
void
getContainer
Returns the container of the control.
Returns
HTMLDivElement<>
getPosition
Returns the position of the control.
Returns
ControlPosition
getRuler
Returns the ruler instance.
Returns
Ruler<>
setPosition(position)
Sets the position of the control.
Parameters
position
ControlPosition
Required position of the control.
Returns
void
toggle
Toggle control. The same as clicking the control button.
Returns
void