Class: LayerGroup

ol/layer/Group~LayerGroup 


import LayerGroup from 'ol/layer/Group';

A module:ol/Collection~Collection of layers that are handled together.

A generic change event is triggered when the group/Collection changes.

new LayerGroup(opt_options)

layer/Group.js, line 89
Name Type Description
options

Layer options.

Name Type Description
opacity number (defaults to 1)

Opacity (0, 1).
visible boolean (defaults to true)

Visibility.
extent module:ol/extent~Extent | undefined

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
zIndex number | undefined

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. When undefined, a zIndex of 0 is assumed for layers that are added to the map's layers collection, or Infinity when the layer's setMap() method was used.
minResolution number | undefined

The minimum resolution (inclusive) at which this layer will be visible.
maxResolution number | undefined

The maximum resolution (exclusive) below which this layer will be visible.
minZoom number | undefined

The minimum view zoom level (exclusive) above which this layer will be visible.
maxZoom number | undefined

The maximum view zoom level (inclusive) at which this layer will be visible.
layers Array.<module:ol/layer/Base~BaseLayer> | module:ol/Collection~Collection.<module:ol/layer/Base~BaseLayer> | undefined

Child layers.
properties Object.<string, *> | undefined

Arbitrary observable properties. Can be accessed with #get() and #set().
Fires:

Extends

Observable Properties

Name Type Settable ol/Object.ObjectEvent type Description
extent module:ol/extent~Extent | undefined yes change:extent

The layer extent.
layers module:ol/Collection~Collection.<module:ol/layer/Base~BaseLayer> yes change:layers

Collection of layers that are part of this group.
maxResolution number yes change:maxresolution

The maximum resolution of the layer.
maxZoom number yes change:maxzoom

The maximum zoom level of the layer.
minResolution number yes change:minresolution

The minimum resolution of the layer.
minZoom number yes change:minzoom

The minimum zoom level of the layer.
opacity number yes change:opacity

The opacity of the layer.
visible boolean yes change:visible

The visibility of the layer.
zIndex number yes change:zindex

The Z-index of the layer.

Methods

changed() inherited

Observable.js, line 68

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event module:ol/events/Event~BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getExtent(){module:ol/extent~Extent|undefined} inherited

layer/Base.js, line 205

Return the extent of the layer or undefined if it will be visible regardless of extent.

Returns:
The layer extent.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

getLayers(){module:ol/Collection~Collection.<module:ol/layer/Base~BaseLayer>}

layer/Group.js, line 252

Returns the collection of layers in this group.

Returns:
Collection of layers that are part of this group.

getMaxResolution(){number} inherited

layer/Base.js, line 217

Return the maximum resolution of the layer.

Returns:
The maximum resolution of the layer.

getMaxZoom(){number} inherited

layer/Base.js, line 247

Return the maximum zoom level of the layer.

Returns:
The maximum zoom level of the layer.

getMinResolution(){number} inherited

layer/Base.js, line 227

Return the minimum resolution of the layer.

Returns:
The minimum resolution of the layer.

getMinZoom(){number} inherited

layer/Base.js, line 237

Return the minimum zoom level of the layer.

Returns:
The minimum zoom level of the layer.

getOpacity(){number} inherited

layer/Base.js, line 257

Return the opacity of the layer (between 0 and 1).

Returns:
The opacity of the layer.

getProperties(){Object.<string, *>} inherited

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 79

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

getVisible(){boolean} inherited

layer/Base.js, line 275

Return the visibility of the layer (true or false).

Returns:
The visibility of the layer.

getZIndex(){number} inherited

layer/Base.js, line 286

Return the Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.

Returns:
The Z-index of the layer.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 153

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 165

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited

Object.js, line 207

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean | undefined

Update without triggering an event.

setExtent(extent) inherited

layer/Base.js, line 306

Set the extent at which the layer is visible. If undefined, the layer will be visible at all extents.

Name Type Description
extent module:ol/extent~Extent | undefined

The extent of the layer.

setLayers(layers)

layer/Group.js, line 266

Set the collection of layers in this group.

Name Type Description
layers module:ol/Collection~Collection.<module:ol/layer/Base~BaseLayer>

Collection of layers that are part of this group.

setMaxResolution(maxResolution) inherited

layer/Base.js, line 316

Set the maximum resolution at which the layer is visible.

Name Type Description
maxResolution number

The maximum resolution of the layer.

setMaxZoom(maxZoom) inherited

layer/Base.js, line 338

Set the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Name Type Description
maxZoom number

The maximum zoom of the layer.

setMinResolution(minResolution) inherited

layer/Base.js, line 326

Set the minimum resolution at which the layer is visible.

Name Type Description
minResolution number

The minimum resolution of the layer.

setMinZoom(minZoom) inherited

layer/Base.js, line 350

Set the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Name Type Description
minZoom number

The minimum zoom of the layer.

setOpacity(opacity) inherited

layer/Base.js, line 360

Set the opacity of the layer, allowed values range from 0 to 1.

Name Type Description
opacity number

The opacity of the layer.

setProperties(values, opt_silent) inherited

Object.js, line 227

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.
silent boolean | undefined

Update without triggering an event.

setVisible(visible) inherited

layer/Base.js, line 371

Set the visibility of the layer (true or false).

Name Type Description
visible boolean

The visibility of the layer.

setZIndex(zindex) inherited

layer/Base.js, line 382

Set Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.

Name Type Description
zindex number

The z-index of the layer.

un(type, listener) inherited

Observable.js, line 174

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.

unset(key, opt_silent) inherited

Object.js, line 251

Unsets a property.

Name Type Description
key string

Key name.
silent boolean | undefined

Unset without triggering an event.