类：基础图层

ol/layer/Base~基础图层


import BaseLayer from 'ol/layer/Base.js';

抽象基类通常仅用于创建子类，而不应在应用程序中实例化。请注意，对于 BaseLayer 及其所有子类，选项中的任何属性都会作为 BaseObject 属性设置在图层对象上，因此是可观察的，并具有 get/set 访问器。

new BaseLayer(options)

layer/Base.js, line 63
Name Type 描述
className string (defaults to 'ol-layer')

用于设置图层元素的CSS类名。
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

该图层可见的最大视图缩放级别（包含）。
background BackgroundColor | undefined

图层背景色。若未指定，则不渲染。
properties Object.<string, *> | undefined

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

子类

继承

可观测属性

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

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

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

图层的Z轴顺序。

方法

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

键名。
返回：
值。

getExtent(){Extent | undefined}

layer/Base.js, line 207

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

返回：
图层范围

getKeys(){Array.<string>} inherited

Object.js, line 148

获取对象属性名列表。

返回：
属性名称列表。

getMaxResolution(){number}

layer/Base.js, line 220

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

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

getMaxZoom(){number}

layer/Base.js, line 253

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

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

getMinResolution(){number}

layer/Base.js, line 231

获取图层的最小分辨率。若图层未设置最小分辨率，则返回0。

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

getMinZoom(){number}

layer/Base.js, line 242

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

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

getOpacity(){number}

layer/Base.js, line 263

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

返回：
图层的不透明度。

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

Object.js, line 157

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

返回：
对象。

getRevision(){number} inherited

Observable.js, line 79

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

返回：
修订。

getVisible(){boolean}

layer/Base.js, line 282

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

返回：
图层的visible属性值

getZIndex(){number | undefined}

layer/Base.js, line 293

返回图层的Z轴顺序，用于在渲染前对图层进行排序。如果图层未受管理，则返回 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)

layer/Base.js, line 313

设置图层的可见范围。若 undefined，图层将在所有范围内可见。

Name Type 描述
extent Extent | undefined

图层的范围。

setMaxResolution(maxResolution)

layer/Base.js, line 323

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

Name Type 描述
maxResolution number

图层的最大分辨率。

setMaxZoom(maxZoom)

layer/Base.js, line 345

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

Name Type 描述
maxZoom number

图层的最大缩放级别。

setMinResolution(minResolution)

layer/Base.js, line 333

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

Name Type 描述
minResolution number

图层的最小分辨率。

setMinZoom(minZoom)

layer/Base.js, line 357

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

Name Type 描述
minZoom number

图层的最小缩放级别。

setOpacity(opacity)

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)

layer/Base.js, line 378

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

Name Type 描述
visible boolean

图层的可见性。

setZIndex(zindex)

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

取消设置且不触发事件。