kilua-leaflet/dev.kilua.externals.leaflet.control/Control

Control

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

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

Control

constructor(options: T = definedExternally)

Types

ControlOptions

interface ControlOptions : JsAny

LayersObject

interface LayersObject : JsAny

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

Properties

onAdd

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

onRemove

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

addInitHook

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

Adds a constructor hook to the class.

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

addTo

open fun addTo(map: LeafletMap): Control<T>

Adds the control to the given map.

getContainer

open fun getContainer(): HTMLElement?

Returns the HTMLElement that contains the control.

getPosition

open fun getPosition(): PositionsUnion

Returns the position of the control.

include

fun include(props: JsAny): JsAny

Includes a mixin into the current class.

mergeOptions

fun mergeOptions(props: JsAny): JsAny

Merges options into the defaults of the class.

remove

open fun remove(): Control<T>

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

setPosition

open fun setPosition(position: PositionsUnion): Control<T>

Sets the position of the control.