类：基础瓦片图层

子类

• TileLayer
• WebGLTileLayer

继承

• Layer

可观察属性

Name	Type	可设置	ObjectEvent type	描述
extent	Extent | undefined	是的	change:extent	图层范围。
maxResolution	number	是的	change:maxresolution	图层的最大分辨率。
maxZoom	number	是的	change:maxzoom	图层的最大缩放级别。
minResolution	number	是的	change:minresolution	图层的最小分辨率。
minZoom	number	是	change:minzoom	图层的最小缩放级别。
opacity	number	是的	change:opacity	图层的不透明度。
preload	number	是的	change:preload	预加载的瓦片级别。
source	SourceType | null	是	change:source	图层源（或null若尚未设置）
useInterimTilesOnError	boolean	是的	change:useinterimtilesonerror	出错时使用临时瓦片。
visible	boolean	是的	change:visible	其值visible图层属性
zIndex	number | undefined	是的	change:zindex	图层的Z轴索引

方法

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	键名。

返回：

值。

getAttributions(view){Array.<string>} inherited

layer/Layer.js, line 344

获取给定视图下该图层源的版权信息。

Name	Type	描述
view	View | ViewStateLayerStateExtent | undefined	查看或FrameState仅当图层未添加到地图时才需要。

返回：

该图层在给定视图中的归属信息。

getData(pixel){Uint8ClampedArray | Uint8Array | Float32Array | DataView | null}

layer/BaseTile.js, line 177

获取像素位置的数据。返回类型取决于源数据：对于图像图块，返回一个四元素RGBA数组；对于数据图块，数组长度与数据集中的波段数一致。对于图层范围之外的请求，将返回null。仅当设置了源的crossOrigin属性时，才能检索图像图块的数据。

// display layer data on every pointer move
map.on('pointermove', (event) => {
  console.log(layer.getData(event.pixel));
});

Name	Type	描述
pixel	Pixel	像素.

返回：

像素数据。

getExtent(){Extent | undefined} inherited

layer/Base.js, line 207

返回图层的 extent；若其在任何范围下均可见，则返回 undefined。

返回：

图层范围。

getKeys(){Array.<string>} inherited

Object.js, line 148

获取对象属性名称列表。

返回：

属性名称列表。

getMaxResolution(){number} inherited

layer/Base.js, line 220

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

返回：

图层的最大分辨率。

getMaxZoom(){number} inherited

layer/Base.js, line 253

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

返回：

图层的最大缩放级别。

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之间）。

返回：

图层透明度

getPreload(){number}

layer/BaseTile.js, line 124

返回预加载瓦片的缩放级别。

返回：

预加载瓦片的级别。

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

Object.js, line 157

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

返回：

对象。

getRevision(){number} inherited

Observable.js, line 79

获取该对象的版本号。每当对象被修改时，其版本号将自动递增。

返回：

修订。

getSource(){SourceType | null} inherited

layer/Layer.js, line 209

获取图层源。

返回：

图层源（若未设置，则为 null）。

getUseInterimTilesOnError(){boolean}

layer/BaseTile.js, line 144

已弃用。是否在出错时使用临时图块？

返回：

错误时使用临时瓦片。

getVisible(){boolean} inherited

layer/Base.js, line 282

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

返回：

图层中 visible 属性的值。

getZIndex(){number | undefined} inherited

layer/Base.js, line 293

返回图层的Z索引，用于在渲染前对图层排序。若图层未受管理，则返回undefined。

返回：

图层的Z索引。

isVisible(view){boolean} inherited

layer/Layer.js, line 300

图层在地图视图中可见，需同时满足以下条件：其分辨率处于最小/最大值之间或缩放级别在有效范围内，未设置为visible: false，且不属于已设置为visible: false的图层组。

Name	Type	描述
view	View | ViewStateLayerStateExtent | undefined	视图或FrameState仅当图层未添加到地图中时才需要。

返回：

图层在地图视图中可见。

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	图层范围。

setMap(map) inherited

layer/Layer.js, line 439

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

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

Name	Type	描述
map	Map | null	地图.

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	图层的不透明度。

setPreload(preload)

layer/BaseTile.js, line 134

设置预加载图块的最大级别。

Name	Type	描述
preload	number	预加载图块的级别。

setProperties(values, silent) inherited

Object.js, line 235

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

Name	Type	描述
values	Object.<string, *>	值。
silent	boolean | undefined	在不触发事件的前提下更新。

setSource(source) inherited

layer/Layer.js, line 487

设置图层源。

Name	Type	描述
source	SourceType | null	图层源。

setUseInterimTilesOnError(useInterimTilesOnError)

layer/BaseTile.js, line 156

已弃用。设置是否在出错时使用临时瓦片。

Name	Type	描述
useInterimTilesOnError	boolean	出错时使用临时图块。

setVisible(visible) inherited

layer/Base.js, line 378

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

Name	Type	描述
visible	boolean	图层可见性。

setZIndex(zindex) inherited

layer/Base.js, line 389

设置图层的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	取消设置而不触发事件。