Class: Layer

Subclasses

• BaseImageLayer
• BaseTileLayer
• BaseVectorLayer

Extends

• BaseLayer

Observable Properties

Name	Type	Settable	ObjectEvent type	Description
extent	Extent | undefined	yes	change:extent	图层范围。
maxResolution	number	yes	change:maxresolution	图层的最大分辨率。
maxZoom	number	yes	change:maxzoom	图层的最大缩放级别。
minResolution	number	yes	change:minresolution	图层的最小分辨率。
minZoom	number	yes	change:minzoom	图层的最小缩放级别。
opacity	number	yes	change:opacity	图层的不透明度。
source	SourceType | null	yes	change:source	图层数据源（如果尚未设置则为 null）。
visible	boolean	yes	change:visible	图层 visible 属性的值。
zIndex	number | undefined	yes	change:zindex	图层的 Z-index。

Methods

changed() inherited

Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

分发事件并调用所有监听此类型事件的监听器。事件参数可以是一个字符串或一个 具有 type 属性的对象。

Name	Type	Description
event	BaseEvent | string	事件对象。

返回值：

如果有人在事件对象上调用了 preventDefault 或任何监听器返回 false，则返回 false。

get(key){*} inherited

Object.js, line 136

获取一个值。

Name	Type	Description
key	string	键名。

返回值：

值。

getAttributions(view){Array.<string>}

layer/Layer.js, line 347

获取此图层数据源在给定视图下的归属信息。

Name	Type	Description
view	View | ViewStateLayerStateExtent | undefined	View 或 FrameState。仅在图层未添加到地图时需要。

返回值：

此图层在给定视图下的归属信息。

getExtent(){Extent | undefined} inherited

layer/Base.js, line 210

返回图层的 范围，如果无论范围如何都可见则返回 undefined。

返回值：

图层范围。

getKeys(){Array.<string>} inherited

Object.js, line 149

获取对象属性名列表。

返回值：

属性名列表。

getMaxResolution(){number} inherited

layer/Base.js, line 223

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

返回值：

图层的最大分辨率。

getMaxZoom(){number} inherited

layer/Base.js, line 256

返回图层的最大缩放级别。如果图层未设置最大缩放则返回 Infinity。

返回值：

图层的最大缩放级别。

getMinResolution(){number} inherited

layer/Base.js, line 234

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

返回值：

图层的最小分辨率。

getMinZoom(){number} inherited

layer/Base.js, line 245

返回图层的最小缩放级别。如果图层未设置最小缩放则返回 -Infinity。

返回值：

图层的最小缩放级别。

getOpacity(){number} inherited

layer/Base.js, line 266

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

返回值：

图层的不透明度。

getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

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

返回值：

对象。

getRevision(){number} inherited

Observable.js, line 79

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

返回值：

版本号。

getSource(){SourceType | null}

layer/Layer.js, line 212

获取图层数据源。

返回值：

图层数据源（如果尚未设置则为 null）。

getVisible(){boolean} inherited

layer/Base.js, line 285

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

返回值：

图层 visible 属性的值。

getZIndex(){number | undefined} inherited

layer/Base.js, line 296

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

返回值：

图层的 Z-index。

isVisible(view){boolean}

layer/Layer.js, line 303

图层在地图视图中可见，即在其最小/最大分辨率或缩放级别和范围内，未设置为 visible: false，且不在设置为 visible: false 的图层组内。

Name	Type	Description
view	View | ViewStateLayerStateExtent | undefined	View 或 FrameState。仅在图层未添加到地图时需要。

返回值：

图层在地图视图中可见。

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

Observable.js, line 152

监听特定类型的事件。

Name	Type	Description
type	string | Array.<string>	事件类型或事件类型数组。
listener	function	监听器函数。

返回值：

监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

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

Observable.js, line 164

仅监听一次特定类型的事件。

Name	Type	Description
type	string | Array.<string>	事件类型或事件类型数组。
listener	function	监听器函数。

返回值：

监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

set(key, value, silent) inherited

Object.js, line 218

设置一个值。

Name	Type	Description
key	string	键名。
value	*	值。
silent	boolean | undefined	更新但不触发事件。

setExtent(extent) inherited

layer/Base.js, line 316

设置图层可见的范围。如果为 undefined，图层在所有范围中都可见。

Name	Type	Description
extent	Extent | undefined	图层的范围。

setMap(map)

layer/Layer.js, line 442

将图层设置为在地图上渲染在其他图层之上。地图不会在其图层集合中管理此图层。这适用于临时图层。要从地图中移除非托管图层，请使用 #setMap(null)。

要将图层添加到地图并由地图管理，请改用 addLayer。

Name	Type	Description
map	Map | null	地图。

setMaxResolution(maxResolution) inherited

layer/Base.js, line 326

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

Name	Type	Description
maxResolution	number	图层的最大分辨率。

setMaxZoom(maxZoom) inherited

layer/Base.js, line 348

设置图层可见的最大缩放（不含）。注意，图层可见性的缩放级别基于视图缩放级别，这可能与瓦片数据源的缩放级别不同。

Name	Type	Description
maxZoom	number	图层的最大缩放。

setMinResolution(minResolution) inherited

layer/Base.js, line 336

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

Name	Type	Description
minResolution	number	图层的最小分辨率。

setMinZoom(minZoom) inherited

layer/Base.js, line 360

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

Name	Type	Description
minZoom	number	图层的最小缩放。

setOpacity(opacity) inherited

layer/Base.js, line 370

设置图层的不透明度，允许值范围为 0 到 1。

Name	Type	Description
opacity	number	图层的不透明度。

setProperties(values, silent) inherited

Object.js, line 238

设置一组键值对。 注意，这会更改任何现有属性并添加新属性（不会移除任何现有属性）。

Name	Type	Description
values	Partial.<NoInfer.<Properties>>	值。
silent	boolean | undefined	更新但不触发事件。

setSource(source)

layer/Layer.js, line 490

设置图层数据源。

Name	Type	Description
source	SourceType | null	图层数据源。

setVisible(visible) inherited

layer/Base.js, line 381

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

Name	Type	Description
visible	boolean	图层的可见性。

setZIndex(zindex) inherited

layer/Base.js, line 392

设置图层的 Z-index，用于在渲染前排列图层顺序。 默认 Z-index 为 0。

Name	Type	Description
zindex	number	图层的 z-index。

un(type, listener) inherited

Observable.js, line 173

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

Name	Type	Description
type	string | Array.<string>	事件类型或事件类型数组。
listener	function	监听器函数。

unset(key, silent) inherited

Object.js, line 262

取消设置一个属性。

Name	Type	Description
key	string	键名。
silent	boolean | undefined	取消设置但不触发事件。