RulerControl | MapGL | Urbi Documentation
MapGL JS API
Maps
Search
Navigation
Urbi Pro
CityLens
On‑Premise
Account

RulerControl

A class that provides a ruler control on the map.

Extends: Control
new constructor(map, options)

Example:

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
RulerControlOptions

Ruler control initialization options.

Returns
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
mapgl.ControlPosition
getRuler()

Returns the ruler instance.

Returns
setPosition(position)

Sets the position of the control.

Parameters
position
mapgl.ControlPosition

Required position of the control.

Returns
void
toggle()

Toggle control. The same as clicking the control button.

Returns
void