Class LayerGroup

L.Class powers the OOP facilities of Leaflet and is used to create almost all of the Leaflet classes documented.

Hierarchy

Index

Constructor methods

Methods

Constructor methods

constructor(layers?: Array<T extends L.ILayer>): LayerGroup

Create a layer group, optionally given an initial set of layers.

Parameters

  • layers?: Array<T extends L.ILayer> optional

Returns

LayerGroup

Methods

public addLayer(layer: T in L.LayerGroup<T extends ILayer>): LayerGroup

Adds a given layer to the group.

Parameters

  • layer: T in L.LayerGroup<T extends ILayer>

Returns

LayerGroup

public addTo(map: Map): LayerGroup

Adds the group of layers to the map.

Parameters

Returns

LayerGroup

public clearLayers(): LayerGroup

Removes all the layers from the group.

Returns

LayerGroup

public eachLayer(fn: (layer: T) => void, context?: any): LayerGroup

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

Parameters

  • fn: (layer: T) => void
  • context?: any optional

Returns

LayerGroup

public getLayer(id: string): T in L.LayerGroup<T extends ILayer>

Returns the layer with the given id.

Parameters

  • id: string

Returns

T in L.LayerGroup<T extends ILayer>

public getLayers(): Array<T extends L.ILayer>

Returns an array of all the layers added to the group.

Returns

Array<T extends L.ILayer>

public hasLayer(layer: T in L.LayerGroup<T extends ILayer>): boolean

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

Parameters

  • layer: T in L.LayerGroup<T extends ILayer>

Returns

boolean

public onAdd(map: Map)

Should contain code that creates DOM elements for the overlay, adds them to map panes where they should belong and puts listeners on relevant map events. Called on map.addLayer(layer).

Parameters

public onRemove(map: Map)

Should contain all clean up code that removes the overlay's elements from the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer).

Parameters

public removeLayer(layer: T in L.LayerGroup<T extends ILayer>): LayerGroup

Removes a given layer from the group.

Parameters

  • layer: T in L.LayerGroup<T extends ILayer>

Returns

LayerGroup

public removeLayer(id: string): LayerGroup

Removes a given layer of the given id from the group.

Parameters

  • id: string

Returns

LayerGroup

public toGeoJSON(): any

Returns a GeoJSON representation of the layer group (GeoJSON FeatureCollection).

Returns

any