kilua-leaflet/dev.kilua.externals.leaflet.layer.overlay/Popup

Popup

class Popup(source: Layer<*> = definedExternally, options: Popup.PopupOptions = definedExternally) : DivOverlay<Popup.PopupOptions> (source)

Used to open popups in certain places of the map. Use LeafletMap.openPopup to open popups while making sure that only one popup is open at one time (recommended for usability), or use LeafletMap.addLayer to open as many as you want.

https://leafletjs.com/SlavaUkraini/reference.html#popup

Constructors

Popup

constructor(source: Layer<*> = definedExternally, options: Popup.PopupOptions = definedExternally)

Types

PopupOptions

interface PopupOptions : DivOverlay.DivOverlayOptions

Properties

options

open var options: Layer.LayerOptions

Functions

addEventListener

open fun addEventListener(eventMap: LeafletEventHandlerFnMap): Evented

open fun addEventListener(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletEventId, fn: LeafletEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletTileEventId, fn: TileEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addEventListener(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: JsAny = definedExternally): Evented

addEventParent

open fun addEventParent(obj: Evented): Evented

addInitHook

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

Adds a constructor hook to the class.

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

addOneTimeEventListener

open fun addOneTimeEventListener(eventMap: LeafletEventHandlerFnMap): Evented

open fun addOneTimeEventListener(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletEventId, fn: LeafletEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletTileEventId, fn: TileEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: JsAny = definedExternally): Evented

open fun addOneTimeEventListener(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: JsAny = definedExternally): Evented

addTo

open fun addTo(map: LayerGroup): Layer<Layer.LayerOptions>

open fun addTo(map: LeafletMap): Layer<Layer.LayerOptions>

beforeAdd

open fun beforeAdd(map: LeafletMap): Layer<Layer.LayerOptions>?

bindPopup

open fun bindPopup(content: Popup, options: Popup.PopupOptions): Layer<Layer.LayerOptions>

open fun bindPopup(content: (layer: Layer<Layer.LayerOptions>) -> JsAny, options: Popup.PopupOptions): Layer<Layer.LayerOptions>

open fun bindPopup(content: String, options: Popup.PopupOptions): Layer<Layer.LayerOptions>

open fun bindPopup(content: HTMLElement, options: Popup.PopupOptions): Layer<Layer.LayerOptions>

bindTooltip

open fun bindTooltip(content: Tooltip, options: Tooltip.TooltipOptions): Layer<Layer.LayerOptions>

open fun bindTooltip(content: (layer: Layer<Layer.LayerOptions>) -> JsAny, options: Tooltip.TooltipOptions): Layer<Layer.LayerOptions>

open fun bindTooltip(content: String, options: Tooltip.TooltipOptions): Layer<Layer.LayerOptions>

open fun bindTooltip(content: HTMLElement, options: Tooltip.TooltipOptions): Layer<Layer.LayerOptions>

bringToBack

open fun bringToBack(): DivOverlay<Popup.PopupOptions>

bringToFront

open fun bringToFront(): DivOverlay<Popup.PopupOptions>

clearAllEventListeners

open fun clearAllEventListeners(): Evented

open fun close()

closePopup

open fun closePopup(): Layer<Layer.LayerOptions>

closeTooltip

open fun closeTooltip(): Layer<Layer.LayerOptions>

fire

open fun fire(type: String, data: JsAny = definedExternally, propagate: Boolean = definedExternally): Evented

fireEvent

open fun fireEvent(type: String, data: JsAny = definedExternally, propagate: Boolean = definedExternally): Evented

getAttribution

open fun getAttribution(): String?

getContent

open fun getContent(): JsAny?

getElement

open fun getElement(): JsAny?

getEvents

open fun getEvents(): LeafletEventHandlerFn?

getLatLng

open fun getLatLng(): LatLng?

getPane

open fun getPane(name: String = definedExternally): HTMLElement?

getPopup

open fun getPopup(): Popup?

getTooltip

open fun getTooltip(): Tooltip?

hasEventListeners

open fun hasEventListeners(type: String): Boolean

include

fun include(props: JsAny): JsAny

Includes a mixin into the current class.

isOpen

open fun isOpen(): Boolean

isPopupOpen

open fun isPopupOpen(): Boolean

isTooltipOpen

open fun isTooltipOpen(): Boolean

listens

open fun listens(type: String): Boolean

mergeOptions

fun mergeOptions(props: JsAny): JsAny

Merges options into the defaults of the class.

off

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: JsAny = definedExternally): Evented

open fun off(type: LeafletErrorEventId, fn: ErrorEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletLayerEventId, fn: LayerEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletControlEventId, fn: LayersControlEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletEventId, fn: LeafletEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletLocationEventId, fn: LocationEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletPopupEventId, fn: PopupEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletResizeEventId, fn: ResizeEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletTileEventId, fn: TileEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun off(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun on(eventMap: LeafletEventHandlerFnMap): Evented

open fun on(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletEventId, fn: LeafletEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletTileEventId, fn: TileEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: JsAny = definedExternally): Evented

open fun on(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: JsAny = definedExternally): Evented

onAdd

open fun onAdd(map: LeafletMap): Layer<Layer.LayerOptions>

once

open fun once(eventMap: LeafletEventHandlerFnMap): Evented

open fun once(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletErrorEventId, fn: ErrorEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletLayerEventId, fn: LayerEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletControlEventId, fn: LayersControlEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletEventId, fn: LeafletEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletLocationEventId, fn: LocationEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletPopupEventId, fn: PopupEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletResizeEventId, fn: ResizeEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletTileEventId, fn: TileEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn, context: JsAny = definedExternally): Evented

open fun once(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn, context: JsAny = definedExternally): Evented

onRemove

open fun onRemove(map: LeafletMap): Layer<Layer.LayerOptions>

openOn

open fun openOn(map: LeafletMap)

openPopup

open fun openPopup(): Layer<Layer.LayerOptions>

open fun openPopup(latlng: LatLng): Layer<Layer.LayerOptions>

openTooltip

open fun openTooltip(): Layer<Layer.LayerOptions>

open fun openTooltip(latlng: LatLng): Layer<Layer.LayerOptions>

remove

open fun remove(): Layer<Layer.LayerOptions>

removeEventListener

open fun removeEventListener(eventMap: LeafletEventHandlerFnMap): Evented

open fun removeEventListener(type: LeafletAnyEventId): Evented

open fun removeEventListener(type: LeafletDragEndEventId, fn: DragEndEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletErrorEventId, fn: ErrorEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletLayerEventId, fn: LayerEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletControlEventId, fn: LayersControlEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletEventId, fn: LeafletEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletKeyboardEventId, fn: LeafletKeyboardEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletMouseEventId, fn: LeafletMouseEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletLocationEventId, fn: LocationEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletPopupEventId, fn: PopupEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletResizeEventId, fn: ResizeEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletTileErrorId, fn: TileErrorEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletTileEventId, fn: TileEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletTooltipEventId, fn: TooltipEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

open fun removeEventListener(type: LeafletZoomAnimEventId, fn: ZoomAnimEventHandlerFn = definedExternally, context: JsAny = definedExternally): Evented

removeEventParent

open fun removeEventParent(obj: Evented): Evented

removeFrom

open fun removeFrom(map: LeafletMap): Layer<Layer.LayerOptions>

setContent

open fun setContent(htmlContent: (source: Layer<*>) -> JsAny): DivOverlay<Popup.PopupOptions>

open fun setContent(htmlContent: String): DivOverlay<Popup.PopupOptions>

open fun setContent(htmlContent: HTMLElement): DivOverlay<Popup.PopupOptions>

setLatLng

open fun setLatLng(latlng: LatLng): DivOverlay<Popup.PopupOptions>

setPopupContent

open fun setPopupContent(content: Popup): Layer<Layer.LayerOptions>

open fun setPopupContent(content: String): Layer<Layer.LayerOptions>

open fun setPopupContent(content: HTMLElement): Layer<Layer.LayerOptions>

setTooltipContent

open fun setTooltipContent(content: Tooltip): Layer<Layer.LayerOptions>

open fun setTooltipContent(content: String): Layer<Layer.LayerOptions>

open fun setTooltipContent(content: HTMLElement): Layer<Layer.LayerOptions>

toggle

open fun toggle(): DivOverlay<Popup.PopupOptions>?

togglePopup

open fun togglePopup(): Layer<Layer.LayerOptions>

toggleTooltip

open fun toggleTooltip(): Layer<Layer.LayerOptions>

unbindPopup

open fun unbindPopup(): Layer<Layer.LayerOptions>

unbindTooltip

open fun unbindTooltip(): Layer<Layer.LayerOptions>

update

open fun update()