Class: BaseLayer

ol/layer/Base~BaseLayer 


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

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

new BaseLayer(options)

layer/Base.js, line 66
Name Type Description
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 时，添加到地图 layers 集合的图层假定 zIndex 为 0，或使用图层 setMap() 方法时为 Infinity。
minResolution number | undefined

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

此图层可见的最大分辨率（不含）。
minZoom number | undefined

此图层可见的最小视图缩放级别（不含）。
maxZoom number | undefined

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

图层的背景颜色。如果未指定，则不会渲染背景。
properties Properties | undefined

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

Subclasses

Extends

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

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

键名。
返回值：
值。

getExtent(){Extent | undefined}

layer/Base.js, line 210

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

返回值：
图层范围。

getKeys(){Array.<string>} inherited

Object.js, line 149

获取对象属性名列表。

返回值：
属性名列表。

getMaxResolution(){number}

layer/Base.js, line 223

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

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

getMaxZoom(){number}

layer/Base.js, line 256

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

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

getMinResolution(){number}

layer/Base.js, line 234

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

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

getMinZoom(){number}

layer/Base.js, line 245

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

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

getOpacity(){number}

layer/Base.js, line 266

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

返回值：
图层的不透明度。

getProperties(){NoInfer.<Properties>} inherited

Object.js, line 158

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

返回值：
对象。

getRevision(){number} inherited

Observable.js, line 79

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

返回值：
版本号。

getVisible(){boolean}

layer/Base.js, line 285

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

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

getZIndex(){number | undefined}

layer/Base.js, line 296

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

返回值：
图层的 Z-index。

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)

layer/Base.js, line 316

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

Name Type Description
extent Extent | undefined

图层的范围。

setMaxResolution(maxResolution)

layer/Base.js, line 326

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

Name Type Description
maxResolution number

图层的最大分辨率。

setMaxZoom(maxZoom)

layer/Base.js, line 348

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

Name Type Description
maxZoom number

图层的最大缩放。

setMinResolution(minResolution)

layer/Base.js, line 336

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

Name Type Description
minResolution number

图层的最小分辨率。

setMinZoom(minZoom)

layer/Base.js, line 360

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

Name Type Description
minZoom number

图层的最小缩放。

setOpacity(opacity)

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

更新但不触发事件。

setVisible(visible)

layer/Base.js, line 381

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

Name Type Description
visible boolean

图层的可见性。

setZIndex(zindex)

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

取消设置但不触发事件。