Scale

A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems.

Constructors

constructor(options: Scale.ScaleOptions = definedExternally)

open val onAdd: (map: LeafletMap) -> HTMLElement?

Should return the container DOM element for the control and add listeners on relevant map events. Called on addTo

open val onRemove: (map: LeafletMap) -> Unit?

Optional method. Should contain all clean up code that removes the listeners previously added in onAdd. Called on remove.

fun addInitHook(initHookFn: () -> Unit): JsAny

Adds a constructor hook to the class.

fun addInitHook(methodName: String, vararg args: JsAny): JsAny

Adds the control to the given map.

open fun getContainer(): HTMLElement?

Returns the HTMLElement that contains the control.

Returns the position of the control.

fun include(props: JsAny): JsAny

Includes a mixin into the current class.

fun mergeOptions(props: JsAny): JsAny

Merges options into the defaults of the class.

Removes the control from the map it is currently active on.

Sets the position of the control.