kvision-maps/io.kvision.maps.externals.leaflet.control/Zoom

Zoom

open external class Zoom(options: Zoom.ZoomControlOptions = definedExternally) : Control<Zoom.ZoomControlOptions> (source)

A basic zoom control with two buttons (zoom in and zoom out). It is put on the map by default unless you set its LeafletMap.zoomControl option to false.

Constructors

Zoom

constructor(options: Zoom.ZoomControlOptions = definedExternally)

Types

ZoomControlOptions

interface ZoomControlOptions : Control.ControlOptions

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

addTo

open fun addTo(map: LeafletMap): Control<Zoom.ZoomControlOptions>

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.

remove

open fun remove(): Control<Zoom.ZoomControlOptions>

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

setPosition

open fun setPosition(position: PositionsUnion): Control<Zoom.ZoomControlOptions>

Sets the position of the control.