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

Ruler

A class that provides ruler functionality.

Extends: EventedEventedRulerEventTable
new constructor(map, options)

Example:

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
RulerOptions

Ruler initialization options.

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

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