kvision-maps/io.kvision.maps.externals.leaflet.layer/FeatureGroup

FeatureGroup

open external class FeatureGroup(layers: Array<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

GeoJSON

Constructors

FeatureGroup

constructor(layers: Array<Layer<*>> = definedExternally, options: Layer.LayerOptions = definedExternally)

Properties

feature

open var feature: dynamic

Type is one of:

options

open var options: Layer.LayerOptions

Functions

addEventListener

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

addEventParent

open fun addEventParent(obj: Evented): Evented

addLayer

open fun addLayer(layer: Layer<*>): LayerGroup

Adds the given layer to the group.

addOneTimeEventListener

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

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 = definedExternally): Layer<Layer.LayerOptions>

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

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

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

bindTooltip

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

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

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

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

bringToBack

open fun bringToBack(): FeatureGroup

bringToFront

open fun bringToFront(): FeatureGroup

clearAllEventListeners

open fun clearAllEventListeners(): Evented

clearLayers

open fun clearLayers(): LayerGroup

Removes all the layers from the group.

closePopup

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

closeTooltip

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

eachLayer

open fun eachLayer(fn: (layer: Layer<*>) -> Unit, context: Any = definedExternally): LayerGroup

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

fire

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

fireEvent

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

getAttribution

open fun getAttribution(): String?

getBounds

open fun getBounds(): LatLngBounds

getEvents

open fun getEvents(): LeafletEventHandlerFn?

getLayer

open fun getLayer(id: Number): Layer<*>?

getLayerId

open fun getLayerId(layer: Layer<*>): Number

getLayers

open fun getLayers(): Array<Layer<*>>

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

hasLayer

open fun hasLayer(layer: Layer<*>): Boolean

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

invoke

open fun invoke(methodName: String, vararg params: Any): 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.

isPopupOpen

open fun isPopupOpen(): Boolean

isTooltipOpen

open fun isTooltipOpen(): Boolean

listens

open fun listens(type: String): Boolean

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: 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

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

onAdd

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

once

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

onRemove

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

openPopup

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

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

openTooltip

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

open fun openTooltip(latlng: LatLng = definedExternally): 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: 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

removeEventParent

open fun removeEventParent(obj: Evented): Evented

removeFrom

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

removeLayer

open fun removeLayer(layer: Layer<*>): LayerGroup

Removes the given layer from the group.

open fun removeLayer(layer: Number): LayerGroup

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

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>

setStyle

open fun setStyle(style: Path.PathOptions): FeatureGroup

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>

setZIndex

open fun setZIndex(zIndex: Number): LayerGroup

toGeoJSON

open fun toGeoJSON(precision: Number = definedExternally): dynamic

Returns a GeoJSON representation of the layer group (as a GeoJSON GeometryCollection, Feature or GeometryCollection).

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>