Legacy
Mapbox.js is no longer in active development. To learn more about our newer mapping tools see Mapbox GL JS.
Control.Scale
A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems. Extends Control.
L.control.scale().addTo(map);
Creation
Factory | Description |
---|---|
L.control.scale(
|
Creates an scale control with the given options. |
Options
Option | Type | Default | Description |
---|---|---|---|
position |
String |
'bottomleft' |
The position of the control (one of the map corners). See control positions. |
maxWidth |
Number |
100 |
Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500). |
metric |
Boolean |
true |
Whether to show the metric scale line (m/km). |
imperial |
Boolean |
true |
Whether to show the imperial scale line (mi/ft). |
updateWhenIdle |
Boolean |
false |
If true , the control is updated on moveend , otherwise it's always up-to-date (updated on move ). |