类：图层组

ol/layer/Group~图层组


import LayerGroup from 'ol/layer/Group.js';

Collection 由一起处理的图层组成。

当组/集合发生变化时，会触发通用 change 事件。

new LayerGroup(options)

layer/Group.js, line 105
Name Type 描述
opacity number (defaults to 1)

不透明度（范围 0 到 1）
visible boolean (defaults to true)

可见.
extent Extent | undefined

图层渲染的边界范围。在此范围之外，图层不会被渲染。
zIndex number | undefined

图层渲染的 z-index。渲染时，图层将首先按 z-index 排序，然后按位置排序。undefined, a zIndex地图中添加的图层，默认值为 0layers集合或Infinity当图层的setMap()采用了该方法。
minResolution number | undefined

该图层可见的最小分辨率（包含）。
maxResolution number | undefined

最大分辨率（排他性），低于此分辨率时图层可见。
minZoom number | undefined

图层在视图缩放级别高于此值（不包含）时可见。
maxZoom number | undefined

该图层可见的最大视图缩放级别（包含）。
layers Array<BaseLayer> | Collection<BaseLayer> | undefined

子图层。
properties Object.<string, *> | undefined

任意可观察属性。可以通过以下方式访问#get()和#set().
触发事件：

继承

可观察属性

Name Type 可设置 ObjectEvent type 描述
extent Extent | undefined 是的 change:extent

图层范围。
layers Collection<BaseLayer> 是的 change:layers

集合layers属于该组。
maxResolution number 是的 change:maxresolution

图层的最大分辨率。
maxZoom number 是的 change:maxzoom

图层的最大缩放级别。
minResolution number 是 change:minresolution

图层的最小分辨率。
minZoom number 是的 change:minzoom

图层的最小缩放级别。
opacity number 是的 change:opacity

图层的不透明度。
visible boolean 是的 change:visible

其价值visible层的属性。
zIndex number | undefined 是 change:zindex

图层的堆叠顺序。

方法

changed() inherited

Observable.js, line 68

增加修订计数器并触发'change'事件。

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

分发事件并调用所有侦听此类事件的侦听器。事件参数可以是字符串或包含 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。
返回：
false 如果事件对象上被调用了 preventDefault 或任何监听器返回了 false。

get(key){*} inherited

Object.js, line 135

获取值。

Name Type 描述
key string

键名。
返回：
值。

getExtent(){Extent | undefined} inherited

layer/Base.js, line 207

返回图层的 extent 或 undefined（若图层在任何范围下均可见）。

返回：
图层范围。

getKeys(){Array.<string>} inherited

Object.js, line 148

获取对象属性名称列表

返回：
属性名称列表

getLayers(){Collection<BaseLayer>}

layer/Group.js, line 277

返回该组中 layers 的 collection。

返回：
该组中 layers 的集合

getMaxResolution(){number} inherited

layer/Base.js, line 220

返回图层的最大分辨率。如果图层未设置最大分辨率，则返回 Infinity。

返回：
图层的最大分辨率。

getMaxZoom(){number} inherited

layer/Base.js, line 253

返回图层的最大缩放级别。若图层未设置最大缩放级别，则返回无穷大。

返回：
图层的最大缩放级别。

getMinResolution(){number} inherited

layer/Base.js, line 231

返回图层的最小分辨率。如果图层没有设置最小分辨率，则返回 0。

返回：
图层的最小分辨率。

getMinZoom(){number} inherited

layer/Base.js, line 242

返回图层的最小缩放层级。若图层未设置最小缩放层级，则返回 -Infinity。

返回：
图层的最小缩放级别。

getOpacity(){number} inherited

layer/Base.js, line 263

返回图层的不透明度（介于 0 和 1 之间）。

返回：
图层的不透明度。

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

Object.js, line 157

获取包含所有属性名称和值的对象。

返回：
对象。

getRevision(){number} inherited

Observable.js, line 79

获取该对象的版本号。每次修改对象时，其版本号将递增。

返回：
修订。

getVisible(){boolean} inherited

layer/Base.js, line 282

返回此图层的 visible 属性值。要检查图层在地图上是否可见，请使用 isVisible()。

返回：
图层中 visible 属性的值。

getZIndex(){number | undefined} inherited

layer/Base.js, line 293

返回图层的 Z-index，用于在渲染前对图层进行排序。如果图层未受管理，则返回 undefined。

返回：
图层的 Z 轴索引。

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。
listener function

监听器函数。
返回：
监听器的唯一键。如果以事件类型数组作为首个参数调用，返回值将是一个键数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

对特定事件类型进行单次监听。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。
listener function

监听器函数。
返回：
监听器的唯一键。若以事件类型数组作为第一个参数调用，则返回值为键的数组。

set(key, value, silent) inherited

Object.js, line 215

设置值。

Name Type 描述
key string

键名。
value *

值。
silent boolean | undefined

更新而不触发事件。

setExtent(extent) inherited

layer/Base.js, line 313

设置图层的可见范围。如果 undefined，则图层在所有范围内均可见。

Name Type 描述
extent Extent | undefined

图层的范围

setLayers(layers)

layer/Group.js, line 291

设置该组内 layers 的 collection。

Name Type 描述
layers Collection<BaseLayer>

集合layers属于该组。

setMaxResolution(maxResolution) inherited

layer/Base.js, line 323

设置图层可见的最大分辨率。

Name Type 描述
maxResolution number

图层的最大分辨率。

setMaxZoom(maxZoom) inherited

layer/Base.js, line 345

设置图层可见的最大缩放级别（不包括该级别）。请注意，图层可见性的缩放级别基于视图缩放级别，而视图缩放级别可能与瓦片源缩放级别不同。

Name Type 描述
maxZoom number

图层的最大缩放级别。

setMinResolution(minResolution) inherited

layer/Base.js, line 333

设置图层的最小可见分辨率。

Name Type 描述
minResolution number

图层的最小分辨率。

setMinZoom(minZoom) inherited

layer/Base.js, line 357

设置图层可见的最小缩放级别（包含）。请注意，图层可见的缩放级别基于视图的缩放级别，而视图缩放级别可能与瓦片源的缩放级别不同。

Name Type 描述
minZoom number

图层的最小缩放级别。

setOpacity(opacity) inherited

layer/Base.js, line 367

设置图层的不透明度，取值范围为0至1。

Name Type 描述
opacity number

图层的不透明度。

setProperties(values, silent) inherited

Object.js, line 235

设置一组键值对。请注意，此操作将修改现有属性并添加新属性，但不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。
silent boolean | undefined

更新而不触发事件。

setVisible(visible) inherited

layer/Base.js, line 378

设置图层的可见性（true 或 false）。

Name Type 描述
visible boolean

图层可见性。

setZIndex(zindex) inherited

layer/Base.js, line 389

设置图层的Z索引，用于在渲染前对图层排序。默认Z索引为0。

Name Type 描述
zindex number

图层的 z-index。

un(type, listener) inherited

Observable.js, line 173

取消监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。
listener function

监听器函数

unset(key, silent) inherited

Object.js, line 259

清除属性。

Name Type 描述
key string

键名。
silent boolean | undefined

取消设置而不触发事件。