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

ScaleControl

A control that shows the scale line for the current map state. It appears on the map only if you set the scaleControl option within @type MapOptions to true.

Extends: Control
new constructor(map, options)

Example:

const control = new mapgl.ScaleControl(
    map,
    { position: 'topRight' },
);
Parameters
map
Map

The map instance.

options
ControlOptions

Control options.

Returns
Methods
destroy()

Destroys the scale control.

Returns
void
getContainer()

Returns the container of the control.

Returns
HTMLDivElement
getPosition()

Returns the position of the control.

Returns
setPosition(position)

Sets the position of the control.

Parameters
position
ControlPosition

Required position of the control.

Returns
void