Control

abstract external class Control<T : Control.ControlOptions>(options: T = definedExternally) : Class

Control is a base class for implementing map controls. Handles positioning. All other controls extend from this class.

See https://leafletjs.com/reference.html#control

Inheritors

Constructors

Link copied to clipboard
constructor(options: T = definedExternally)

Types

Link copied to clipboard
interface ControlOptions
Link copied to clipboard
interface LayersObject

Object literal with layer names as keys and Layer objects as values.

Properties

Link copied to clipboard
open val onAdd: (map: LeafletMap) -> <Error class: unknown class>?

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

Link copied to clipboard
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.

Functions

Link copied to clipboard
open fun addTo(map: LeafletMap): Control<T>

Adds the control to the given map.

Link copied to clipboard
open fun getContainer(): <Error class: unknown class>?

Returns the HTMLElement that contains the control.

Link copied to clipboard

Returns the position of the control.

Link copied to clipboard
open fun remove(): Control<T>

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

Link copied to clipboard
open fun setPosition(position: PositionsUnion): Control<T>

Sets the position of the control.