瓦片图层类

继承

• BaseTileLayer

可观察属性

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-index。

方法

changed() inherited

Observable.js, line 68

递增修订计数器并分发“更改”事件。

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} inherited

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

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

返回：

图层的最大分辨率。

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

返回：

图层的不透明度。

getPreload(){number} inherited

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} inherited

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-index，用于在渲染前对图层进行排序。若图层未管理，则返回未定义。

返回：

图层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) inherited

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) inherited

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-index，以在渲染前确定图层顺序。默认 Z-index 为 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	取消设置且不触发事件。