kilua-leaflet/dev.kilua.externals.leaflet.layer/FeatureGroup

FeatureGroup

open class FeatureGroup(layers: JsArray<Layer<*>> = definedExternally, options: Layer.LayerOptions = definedExternally) : LayerGroup(source)

Extended LayerGroup that makes it easier to do the same thing to all its member layers:

  • Layer.bindPopup binds a popup to all the layers at once (likewise with Layer.bindTooltip)

  • Events are propagated to the FeatureGroup, so if the group has an event handler, it will handle events from any of the layers. This includes mouse events and custom events.

  • Has layeradd and layerremove events

Inheritors

Constructors

Link copied to clipboard
constructor(layers: JsArray<Layer<*>> = definedExternally, options: Layer.LayerOptions = definedExternally)

Properties

Link copied to clipboard
open var feature: JsAny
Link copied to clipboard

Functions

Link copied to clipboard
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
Link copied to clipboard
open fun addEventParent(obj: Evented): Evented
Link copied to clipboard
fun addInitHook(initHookFn: () -> Unit): JsAny

Adds a constructor hook to the class.

fun addInitHook(methodName: String, vararg args: JsAny): JsAny
Link copied to clipboard
open fun addLayer(layer: Layer<*>): LayerGroup

Adds the given layer to the group.

Link copied to clipboard
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
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun clearLayers(): LayerGroup

Removes all the layers from the group.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun eachLayer(fn: (layer: Layer<*>) -> Unit, context: JsAny = definedExternally): LayerGroup

Iterates over the layers of the group, optionally specifying context of the iterator function.

Link copied to clipboard
open fun fire(type: String, data: JsAny = definedExternally, propagate: Boolean = definedExternally): Evented
Link copied to clipboard
open fun fireEvent(type: String, data: JsAny = definedExternally, propagate: Boolean = definedExternally): Evented
Link copied to clipboard
open fun getAttribution(): String?
Link copied to clipboard
open fun getBounds(): LatLngBounds
Link copied to clipboard
Link copied to clipboard
open fun getLayer(id: Int): Layer<*>?
Link copied to clipboard
open fun getLayerId(layer: Layer<*>): Int
Link copied to clipboard
open fun getLayers(): JsArray<Layer<*>>
Link copied to clipboard
open fun getPane(name: String = definedExternally): HTMLElement?
Link copied to clipboard
open fun getPopup(): Popup?
Link copied to clipboard
open fun getTooltip(): Tooltip?
Link copied to clipboard
open fun hasEventListeners(type: String): Boolean
Link copied to clipboard
open fun hasLayer(layer: Layer<*>): Boolean

Returns true if the given layer is currently added to the group.

Link copied to clipboard
fun include(props: JsAny): JsAny

Includes a mixin into the current class.

Link copied to clipboard
open fun invoke(methodName: String, vararg params: JsAny): LayerGroup

Calls methodName on every layer contained in this group, passing any additional parameters. Has no effect if the layers contained do not implement methodName.

Link copied to clipboard
open fun isPopupOpen(): Boolean
Link copied to clipboard
open fun isTooltipOpen(): Boolean
Link copied to clipboard
open fun listens(type: String): Boolean
Link copied to clipboard
fun mergeOptions(props: JsAny): JsAny

Merges options into the defaults of the class.

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: 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
Link copied to clipboard
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
Link copied to clipboard
Link copied to clipboard
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
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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: 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
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun removeLayer(layer: Layer<*>): LayerGroup

Removes the given layer from the group.

open fun removeLayer(layer: Int): LayerGroup

Removes the layer with the given internal ID from the group.

Link copied to clipboard
open fun setPopupContent(content: Popup): Layer<Layer.LayerOptions>
open fun setPopupContent(content: String): Layer<Layer.LayerOptions>
open fun setPopupContent(content: HTMLElement): Layer<Layer.LayerOptions>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun setZIndex(zIndex: Int): LayerGroup
Link copied to clipboard
open fun toGeoJSON(precision: Double = definedExternally): JsAny

Returns a GeoJSON representation of the layer group.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard