ScaleControl
A ScaleControl control displays the ratio of a distance on the map to the corresponding distance on the ground.
Example
let scale = new ScaleControl({
maxWidth: 80,
unit: 'imperial'
});
map.addControl(scale);
scale.setUnit('metric');
Implements
Methods
onAdd()
onAdd(
map:Map):HTMLElement
Register a control on the map and give it a chance to register event listeners and resources. This method is called by Map#addControl internally.
Parameters
| Parameter | Type | Description |
|---|---|---|
map |
Map |
the Map this control will be added to |
Returns
HTMLElement
The control's container element. This should be created by the control and returned by onAdd without being attached to the DOM: the map will insert the control's element into the DOM as necessary.
Implementation of
Source
src/ui/control/scale_control.ts:66
onRemove()
onRemove():
void
Unregister a control on the map and give it a chance to detach event listeners and resources. This method is called by Map#removeControl internally.
Returns
void
Implementation of
Source
src/ui/control/scale_control.ts:77
setUnit()
setUnit(
unit:Unit):void
Set the scale's unit of the distance
Parameters
| Parameter | Type | Description |
|---|---|---|
unit |
Unit |
Unit of the distance ('imperial', 'metric' or 'nautical'). |
Returns
void