kvision/io.kvision.maps.externals.leaflet.map/LeafletMap

LeafletMap

open external class LeafletMap : Evented

The central class of the API — it is used to create a map on a page and manipulate it.

https://leafletjs.com/reference.html#map-example

Constructors

Link copied to clipboard
constructor(element: String, options: LeafletMap.LeafletMapOptions = definedExternally)
constructor(element: <Error class: unknown class>, options: LeafletMap.LeafletMapOptions = definedExternally)

Types

Link copied to clipboard
interface AnimatedOption

Artificial interface. Used so ZoomOptions and PanOptions both have an animate property, and other interfaces (e.g. ZoomPanOptions) can inherit from both.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
interface LeafletMapOptions

Constructor parameters for LeafletMap

Link copied to clipboard
interface LocateOptions
Link copied to clipboard
interface PanInsideOptions
Link copied to clipboard
Link copied to clipboard
interface ZoomOptions : LeafletMap.AnimatedOption

Options for LeafletMap methods

Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
open var boxZoom: Handler
Link copied to clipboard
open var doubleClickZoom: Handler
Link copied to clipboard
open var dragging: Handler
Link copied to clipboard
open var keyboard: Handler
Link copied to clipboard
Link copied to clipboard
open var scrollWheelZoom: Handler
Link copied to clipboard
open var tap: Handler
Link copied to clipboard
open var touchZoom: Handler
Link copied to clipboard
open var zoomControl: Zoom

Functions

Link copied to clipboard
open fun addControl(control: Control<*>): LeafletMap
Link copied to clipboard
open fun addEventListener(eventMap: LeafletEventHandlerFnMap): Evented
open fun addEventListener(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletEventId, fn: LeafletEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletTileEventId, fn: TileEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: Any = definedExternally): Evented
open fun addEventListener(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: Any = definedExternally): Evented
Link copied to clipboard
open fun addEventParent(obj: Evented): Evented
Link copied to clipboard
open fun addHandler(name: String, HandlerClass: Any): LeafletMap
Link copied to clipboard
open fun addLayer(layer: Layer<*>): LeafletMap
Link copied to clipboard
open fun addOneTimeEventListener(eventMap: LeafletEventHandlerFnMap): Evented
open fun addOneTimeEventListener(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletEventId, fn: LeafletEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletTileEventId, fn: TileEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: Any = definedExternally): Evented
open fun addOneTimeEventListener(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: Any = definedExternally): Evented
Link copied to clipboard
Link copied to clipboard
open fun closePopup(popup: Popup = definedExternally): LeafletMap
Link copied to clipboard
open fun closeTooltip(tooltip: Tooltip = definedExternally): LeafletMap
Link copied to clipboard
open fun containerPointToLatLng(point: Point): LatLng
Link copied to clipboard
open fun containerPointToLayerPoint(point: Point): Point
Link copied to clipboard
open fun createPane(name: String, container: <Error class: unknown class> = definedExternally): <Error class: unknown class>
Link copied to clipboard
open fun distance(latlng1: LatLng, latlng2: LatLng): Number
Link copied to clipboard
open fun eachLayer(fn: (layer: Layer<*>) -> Unit, context: Any = definedExternally): LeafletMap
Link copied to clipboard
open fun fire(type: String, data: Any = definedExternally, propagate: Boolean = definedExternally): Evented
Link copied to clipboard
open fun fireEvent(type: String, data: Any = definedExternally, propagate: Boolean = definedExternally): Evented
Link copied to clipboard
open fun fitBounds(bounds: LatLngBounds, options: LeafletMap.FitBoundsOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun fitWorld(options: LeafletMap.FitBoundsOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun flyTo(latlng: LatLng, zoom: Number = definedExternally, options: LeafletMap.ZoomPanOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun flyToBounds(bounds: LatLngBounds, options: LeafletMap.FitBoundsOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun getBounds(): LatLngBounds
Link copied to clipboard
open fun getBoundsZoom(bounds: LatLngBounds, inside: Boolean = definedExternally, padding: Point = definedExternally): Number
Link copied to clipboard
open fun getCenter(): LatLng
Link copied to clipboard
open fun getContainer(): <Error class: unknown class>
Link copied to clipboard
open fun getMaxZoom(): Number
Link copied to clipboard
open fun getMinZoom(): Number
Link copied to clipboard
open fun getPane(pane: <Error class: unknown class>): <Error class: unknown class>?
open fun getPane(pane: String): <Error class: unknown class>?
Link copied to clipboard
open fun getPanes(): MapPanes
Link copied to clipboard
open fun getPixelBounds(): Bounds
Link copied to clipboard
open fun getPixelOrigin(): Point
Link copied to clipboard
open fun getPixelWorldBounds(zoom: Number = definedExternally): Bounds
Link copied to clipboard
Link copied to clipboard
open fun getScaleZoom(scale: Number, fromZoom: Number = definedExternally): Number
Link copied to clipboard
open fun getSize(): Point
Link copied to clipboard
open fun getZoom(): Number
Link copied to clipboard
open fun getZoomScale(toZoom: Number, fromZoom: Number = definedExternally): Number
Link copied to clipboard
open fun hasEventListeners(type: String): Boolean
Link copied to clipboard
open fun hasLayer(layer: Layer<*>): Boolean
Link copied to clipboard
open fun invalidateSize(options: LeafletMap.ZoomPanOptions = definedExternally): LeafletMap

Checks if the map container size changed and updates the map if so — call it after you've changed the map size dynamically, also animating pan by default. If InvalidateSizeOptions.pan is false, panning will not occur. If InvalidateSizeOptions.debounceMoveend is true, it will delay moveend event so that it doesn't happen often even if the method is called many times in a row.

open fun invalidateSize(options: Boolean = definedExternally): LeafletMap

Checks if the map container size changed and updates the map if so — call it after you've changed the map size dynamically, also animating pan by default.

Link copied to clipboard
open fun latLngToContainerPoint(latlng: LatLng): Point
Link copied to clipboard
open fun latLngToLayerPoint(latlng: LatLng): Point
Link copied to clipboard
open fun layerPointToContainerPoint(point: Point): Point
Link copied to clipboard
open fun layerPointToLatLng(point: Point): LatLng
Link copied to clipboard
open fun listens(type: String): Boolean
Link copied to clipboard
open fun locate(options: LeafletMap.LocateOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun mouseEventToContainerPoint(ev: <Error class: unknown class>): Point
Link copied to clipboard
open fun mouseEventToLatLng(ev: <Error class: unknown class>): LatLng
Link copied to clipboard
open fun mouseEventToLayerPoint(ev: <Error class: unknown class>): Point
Link copied to clipboard
open fun off(): Evented
open fun off(eventMap: LeafletEventHandlerFnMap): Evented
open fun off(type: LeafletAnyEventId): Evented
open fun off(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletErrorEventId, fn: ErrorEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletLayerEventId, fn: LayerEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletControlEventId, fn: LayersControlEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletEventId, fn: LeafletEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletLocationEventId, fn: LocationEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletPopupEventId, fn: PopupEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletResizeEventId, fn: ResizeEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletTileEventId, fn: TileEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun off(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
Link copied to clipboard
open fun on(eventMap: LeafletEventHandlerFnMap): Evented
open fun on(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletEventId, fn: LeafletEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletTileEventId, fn: TileEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: Any = definedExternally): Evented
open fun on(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: Any = definedExternally): Evented
Link copied to clipboard
open fun once(eventMap: LeafletEventHandlerFnMap): Evented
open fun once(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletEventId, fn: LeafletEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletTileEventId, fn: TileEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: Any = definedExternally): Evented
open fun once(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: Any = definedExternally): Evented
Link copied to clipboard
open fun openPopup(popup: Popup): LeafletMap
open fun openPopup(content: <Error class: unknown class>, latlng: LatLng, options: Popup.PopupOptions = definedExternally): LeafletMap
open fun openPopup(content: String, latlng: LatLng, options: Popup.PopupOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun openTooltip(tooltip: Tooltip): LeafletMap
open fun openTooltip(content: <Error class: unknown class>, latlng: LatLng, options: Tooltip.TooltipOptions = definedExternally): LeafletMap
open fun openTooltip(content: String, latlng: LatLng, options: Tooltip.TooltipOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun panBy(offset: Point, options: LeafletMap.PanOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun panInside(latLng: LatLng, options: LeafletMap.PanInsideOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun panInsideBounds(bounds: LatLngBounds, options: LeafletMap.PanOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun panTo(latlng: LatLng, options: LeafletMap.PanOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun project(latlng: LatLng, zoom: Number = definedExternally): Point
Link copied to clipboard
open fun remove(): LeafletMap
Link copied to clipboard
open fun removeControl(control: Control<*>): LeafletMap
Link copied to clipboard
open fun removeEventListener(eventMap: LeafletEventHandlerFnMap): Evented
open fun removeEventListener(type: LeafletAnyEventId): Evented
open fun removeEventListener(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletErrorEventId, fn: ErrorEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletLayerEventId, fn: LayerEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletControlEventId, fn: LayersControlEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletEventId, fn: LeafletEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletLocationEventId, fn: LocationEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletPopupEventId, fn: PopupEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletResizeEventId, fn: ResizeEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletTileEventId, fn: TileEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
open fun removeEventListener(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn = definedExternally, context: Any = definedExternally): Evented
Link copied to clipboard
open fun removeEventParent(obj: Evented): Evented
Link copied to clipboard
open fun removeLayer(layer: Layer<*>): LeafletMap
Link copied to clipboard
open fun setMaxBounds(bounds: LatLngBounds): LeafletMap
Link copied to clipboard
open fun setMaxZoom(zoom: Number): LeafletMap
Link copied to clipboard
open fun setMinZoom(zoom: Number): LeafletMap
Link copied to clipboard
open fun setView(center: LatLng, zoom: Number = definedExternally, options: LeafletMap.ZoomPanOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun setZoom(zoom: Number, options: LeafletMap.ZoomPanOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun setZoomAround(position: LatLng, zoom: Number, options: LeafletMap.ZoomOptions = definedExternally): LeafletMap
open fun setZoomAround(position: Point, zoom: Number, options: LeafletMap.ZoomOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun stop(): LeafletMap

Stops the currently running panTo or flyTo animation, if any.

Link copied to clipboard
open fun stopLocate(): LeafletMap
Link copied to clipboard
open fun unproject(point: Point, zoom: Number = definedExternally): LatLng
Link copied to clipboard
open fun whenReady(fn: () -> Unit, context: Any = definedExternally): LeafletMap
Link copied to clipboard
open fun wrapLatLng(latlng: LatLng): LatLng
Link copied to clipboard
Link copied to clipboard
open fun zoomIn(delta: Number = definedExternally, options: LeafletMap.ZoomOptions = definedExternally): LeafletMap
Link copied to clipboard
open fun zoomOut(delta: Number = definedExternally, options: LeafletMap.ZoomOptions = definedExternally): LeafletMap