On this page
Constructors
Properties
Methods

Class ScaleControlMaptiler

A ScaleControl control displays the ratio of a distance on the map to the corresponding distance on the ground.

let scale = new ScaleControl({
    maxWidth: 80,
    unit: 'imperial'
});
map.addControl(scale);

scale.setUnit('metric');

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

options setUnit

Methods

getDefaultPosition onAdd onRemove

Constructors

Properties

options: ScaleControlOptions
setUnit: (unit: Unit) => void

Set the scale's unit of the distance

Type Declaration

    • (unit: Unit): void

    • Parameters

      • unit: Unit

        Unit of the distance ('imperial', 'metric' or 'nautical').

      Returns void

Methods

  • Optionally provide a default position for this control. If this method is implemented and Map.addControl is called without the position parameter, the value returned by getDefaultPosition will be used as the control's position.

    Returns ControlPosition

    a control position, one of the values valid in addControl.

  • 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

    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.

  • 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

Was this helpful?
SDK JS
Reference
ScaleControl