kvision/io.kvision.maps.externals.leaflet.layer/LayerGroup

LayerGroup

open external class LayerGroup(layers: Array<Layer<*>> = definedExternally, options: Layer.LayerOptions = definedExternally) : Layer<Layer.LayerOptions>

Used to group several layers and handle them as one.

If you add it to the map, any layers added or removed from the group will be added/removed on the map as well. Extends Layer.

Inheritors

Constructors

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

Properties

Link copied to clipboard
open var feature: dynamic

Type is one of:

Link copied to clipboard

Functions

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 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: 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
Link copied to clipboard
open fun bindPopup(content: <Error class: unknown class>, options: Popup.PopupOptions = definedExternally): Layer<Layer.LayerOptions>
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>
Link copied to clipboard
open fun bindTooltip(content: <Error class: unknown class>, options: Tooltip.TooltipOptions = definedExternally): Layer<Layer.LayerOptions>
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>
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: Any = 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: 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 getAttribution(): String?
Link copied to clipboard
Link copied to clipboard
open fun getLayer(id: Number): Layer<*>?
Link copied to clipboard
open fun getLayerId(layer: Layer<*>): Number
Link copied to clipboard
open fun getLayers(): Array<Layer<*>>
Link copied to clipboard
open fun getPane(name: String = definedExternally): <Error class: unknown class>?
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
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.

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
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
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
Link copied to clipboard
open fun openPopup(): Layer<Layer.LayerOptions>
open fun openPopup(latlng: LatLng = definedExternally): Layer<Layer.LayerOptions>
Link copied to clipboard
open fun openTooltip(): Layer<Layer.LayerOptions>
open fun openTooltip(latlng: LatLng = definedExternally): Layer<Layer.LayerOptions>
Link copied to clipboard
open fun remove(): Layer<Layer.LayerOptions>
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
Link copied to clipboard
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.

Link copied to clipboard
open fun setPopupContent(content: <Error class: unknown class>): Layer<Layer.LayerOptions>
open fun setPopupContent(content: Popup): Layer<Layer.LayerOptions>
open fun setPopupContent(content: String): Layer<Layer.LayerOptions>
Link copied to clipboard
open fun setTooltipContent(content: <Error class: unknown class>): Layer<Layer.LayerOptions>
open fun setTooltipContent(content: Tooltip): Layer<Layer.LayerOptions>
open fun setTooltipContent(content: String): Layer<Layer.LayerOptions>
Link copied to clipboard
open fun setZIndex(zIndex: Number): LayerGroup
Link copied to clipboard
open fun toGeoJSON(precision: Number = definedExternally): dynamic

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

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