类：基础矢量图层

ol/layer/BaseVector~基础矢量图层


import BaseVectorLayer from 'ol/layer/BaseVector.js';

客户端渲染的矢量数据。注意：在选项中设置的任何属性都会成为图层对象的 BaseObject 属性；例如，设置 title: 'My Title' 表示 title 是可观察的，并具备 get/set 访问器。

new BaseVectorLayer(options)

layer/BaseVector.js, line 92
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对于添加到地图的图层，默认值为0。layers集合，或Infinity当图层的setMap()采用了该方法。
minResolution number | undefined

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

最大分辨率（排他性），低于此分辨率时该图层可见。
minZoom number | undefined

最小视图缩放级别（不包含），高于该级别时图层可见。
maxZoom number | undefined

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

渲染顺序。在渲染之前对要素进行排序时使用的函数。默认情况下，要素按照创建的顺序绘制。使用null避免排序，但绘制顺序未定义。
renderBuffer number (defaults to 100)

渲染器在从矢量数据源获取要素以进行渲染或命中检测时，所使用的视口范围周围的像素缓冲区。推荐值：最大符号、线宽或标签的尺寸。
source VectorSourceType | undefined

数据源.
map Map | undefined

将图层设为地图的叠加层。地图不会在其图层集合中管理此图层，且该图层将渲染在最上层。这适用于临时图层。将图层添加到地图并由地图管理的标准方法是使用map.addLayer().
declutter boolean | string | number (defaults to false)

清理图像和文本。任何真值都将启用去重功能。在图层内，先渲染的要素具有更高的优先级。所有图层具有相同的优先级。declutter值将进行去重处理。优先级由相同优先级的图层的绘制顺序决定。declutter值：在图层堆栈中，位置越高，优先级越高。要分别为不同的图层或图层组设置 declutter，请使用不同的真值。declutter.
style StyleLike | FlatStyleLike | null | undefined

图层样式：当设置为null仅具有自身样式的要素会被渲染。参见Style若未设置，则使用默认样式。
background BackgroundColor | undefined

图层的背景色。若未指定，则不渲染背景。
updateWhileAnimating boolean (defaults to false)

当设置为true, 要素批次将在动画期间重新创建。这意味着矢量数据不会被裁剪显示，但该设置会对大量矢量数据产生性能影响。当设置为false，当无动画活动时，将重新创建批次。
updateWhileInteracting boolean (defaults to false)

当设置为true，要素批次将在交互期间重新创建。参见updateWhileAnimating.
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

图层的不透明度。
source SourceType | null 是的 change:source

图层源（或null若尚未设置）。
visible boolean 是的 change:visible

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

图层的Z-index

方法

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仅当图层未添加到地图中时才需要。
返回：
该图层在给定视图中的属性。

getExtent(){Extent | undefined} inherited

layer/Base.js, line 207

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

返回：
图层范围。

getFeatures(pixel){Promise<Array<FeatureLike>>}

layer/BaseVector.js, line 178

获取与视口给定像素相交的最顶层要素。返回一个Promise，该Promise解析为一个要素数组。当检测到命中时，该数组将包含最顶层要素；否则为空。

该方法的命中检测算法针对性能进行了优化，但其准确性低于 map.getFeaturesAtPixel() 中使用的算法。文本不被考虑，图标仅以其边界框表示，而非精确图像。

Name Type 描述
pixel Pixel

像素.
返回：
返回要素数组的Promise。

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

返回：
图层的不透明度。

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

getStyle(){StyleLike | FlatStyleLike | null | undefined}

layer/BaseVector.js, line 204

获取要素的样式。该方法返回在构造时传递给 style 选项或 setStyle 方法的任何内容。

返回：
图层样式。

getStyleFunction(){StyleFunction | undefined}

layer/BaseVector.js, line 213

获取样式函数。

返回：
图层样式函数。

getVisible(){boolean} inherited

layer/Base.js, line 282

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

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

getZIndex(){number | undefined} inherited

layer/Base.js, line 293

返回图层的Z-index，用于渲染前对图层排序。若图层为非托管，则返回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

更新而不触发事件。

setDeclutter(declutter)

layer/BaseVector.js, line 288
Name Type 描述
declutter boolean | string | number

精简图像和文本。

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

图层不透明度。

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

图层源。

setStyle(style)

layer/BaseVector.js, line 276

设置要素的样式。这可以是一个单个样式对象、一个样式数组，或一个接收要素和分辨率并返回样式数组的函数。如果设置为 null，则图层没有样式（即一个 null 样式），因此只有具有自身样式的要素才会在该图层中渲染。调用不带参数的 setStyle() 可重置为默认样式。有关默认样式的详细信息，请参阅 the ol/style/Style module。

如果图层具有静态样式，可以改用 flat style 对象字面量，而非使用 Style 和符号构造函数（Fill、Stroke 等）：

vectorLayer.setStyle({
  "fill-color": "yellow",
  "stroke-color": "black",
  "stroke-width": 4
})
Name Type 描述
style StyleLike | FlatStyleLike | null | undefined

图层样式。

setVisible(visible) inherited

layer/Base.js, line 378

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

Name Type 描述
visible boolean

图层可见性。

setZIndex(zindex) inherited

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

取消设置而不触发事件。