-
Name Type 描述 classNamestring (defaults to 'ol-layer') 要设置到图层元素的 CSS 类名。
opacitynumber (defaults to 1) 不透明度(0,1)。
visibleboolean (defaults to true) 可见.
extentExtent | undefined 图层渲染的边界范围。图层不会在此范围外渲染。
zIndexnumber | undefined 图层渲染的 z-index。在渲染过程中,图层将首先按 z-index 排序,然后按位置排序。当
undefined, azIndex对于添加到地图的图层,默认为0。layers集合,或Infinity当图层的setMap()采用了该方法。minResolutionnumber | undefined 该图层可见的最小分辨率(包含)。
maxResolutionnumber | undefined 当分辨率低于此最大分辨率(排他性)时,图层可见。
minZoomnumber | undefined 最小视图缩放级别(不包括),高于此级别时图层可见。
maxZoomnumber | undefined 该图层可见的最大视图缩放级别(包含)。
mapMap | undefined 将图层设置为地图的叠加层。地图不会在其图层集合中管理该图层,且该图层将渲染于顶层。这适用于临时图层。将图层添加到地图并由地图管理的标准方法是使用
map.addLayer().sourceImageSource | undefined 该图层的数据源。
propertiesObject.<string, *> | undefined 任意可观测属性。可通过以下方式访问。
#get()和#set().触发事件:
change(BaseEvent) - 通用变更事件。当修订计数器增加时触发。-
change:extent(ObjectEvent) -
change:maxResolution(ObjectEvent) -
change:maxZoom(ObjectEvent) -
change:minResolution(ObjectEvent) -
change:minZoom(ObjectEvent) -
change:opacity(ObjectEvent) -
change:source(ObjectEvent) -
change:visible(ObjectEvent) -
change:zIndex(ObjectEvent) error(基础事件(BaseEvent)) - 通用错误事件。当错误发生时触发。postrenderRenderEvent渲染事件 - 在图层渲染后触发。prerender(RenderEvent) - 在图层渲染前触发。propertychangeObjectEvent对象事件 - 属性变更时触发。-
sourceready(BaseEvent)
继承
可观察的属性
| 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 |
图层源(或 |
visible |
boolean | 是的 | change:visible |
The value of the |
zIndex |
number | undefined | 是的 | change:zindex |
图层的 z-index。 |
方法
-
递增修订计数器并触发更改事件。
-
派发事件并调用所有监听该类型事件的监听器。事件参数可以是字符串,也可以是包含
type属性的对象。Name Type 描述 eventBaseEvent | string 事件对象。
返回:
false如果事件对象上调用了 preventDefault,或者任何侦听器返回了 false。
-
获取一个值。
Name Type 描述 keystring 键名。
返回:
值。
-
获取给定视图中该图层源的归属。
Name Type 描述 viewView | ViewStateLayerStateExtent | undefined 视图或
FrameState。仅当图层未添加到地图时才是必需的。返回:
给定视图中该图层的归属信息。
-
getData(pixel){Uint8ClampedArray | Uint8Array | Float32Array | DataView | null}
-
获取指定像素位置的数据,将返回一个四元素 RGBA 数组。对于超出图层范围的请求,将返回
null;仅当数据源的crossOrigin属性被设置时,才能检索图像数据。// display layer data on every pointer move map.on('pointermove', (event) => { console.log(layer.getData(event.pixel)); });Name Type 描述 pixelPixel 像素.
返回:
像素数据。
-
返回图层的
extent;若图层无论范围如何均可见,则返回undefined。返回:
图层范围。
-
获取对象属性名列表。
返回:
属性名称列表
-
获取图层的最大分辨率。若图层未设置最大分辨率,则返回 Infinity。
返回:
图层的最大分辨率。
-
返回图层的最大缩放级别。若图层未设置最大缩放级别,则返回 Infinity。
返回:
图层的最大缩放级别。
-
返回图层的最小分辨率;若未设置,则返回0。
返回:
图层的最小分辨率
-
返回图层的最小缩放级别。若未设置最小缩放,则返回 -Infinity。
返回:
图层的最小缩放级别。
-
返回图层的不透明度(在 0 到 1 之间)。
返回:
图层不透明度
-
获取包含所有属性名和属性值的对象。
返回:
对象。
-
获取该对象的版本号。每当对象被修改时,其版本号将自动递增。
返回:
修订。
-
获取图层数据源。
返回:
图层源(如果未设置,则使用null)
-
返回此图层的
visible属性值。要确定图层在地图上是否可见,请改用isVisible()。返回:
图层visible属性值。
-
返回图层的 Z-index,用于在渲染前对图层进行排序。若图层为非托管状态,则返回 undefined。
返回:
图层的z索引。
-
该图层在地图视图中可见,即处于其最小/最大分辨率或缩放级别与范围内,且未设置为
visible: false,同时不在被设置为visible: false的图层组内。Name Type 描述 viewView | ViewStateLayerStateExtent | undefined 视图或
FrameState:仅当图层未添加到地图时才需要。返回:
图层在地图视图中可见。
-
监听特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数
返回:
监听器的唯一键。若以事件类型数组作为第一个参数调用,则返回将是键的数组。
-
仅监听一次特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或其数组。
listenerfunction 监听函数。
返回:
监听器的唯一键。若以事件类型数组作为第一个参数调用,则返回值为键的数组。
-
设置值。
Name Type 描述 keystring 键名。
value* 值。
silentboolean | undefined 更新而不触发事件。
-
设置图层的可见范围。如果
undefined,图层将在所有范围内可见。Name Type 描述 extentExtent | undefined 图层范围
-
设置要在地图上其他图层之上渲染的图层。地图不会在其图层集合中管理此图层。这对于临时图层非常有用。要从地图中移除非托管图层,请使用
#setMap(null)。要将图层添加到地图并由地图管理,请改用
addLayer。Name Type 描述 mapMap | null 地图.
-
设置图层可见时的最大分辨率。
Name Type 描述 maxResolutionnumber 图层的最大分辨率。
-
设置图层可见的最大缩放级别(不包含该级别)。注意,图层可见性的缩放级别基于视图缩放级别,其级别可能与瓦片源缩放级别不同。
Name Type 描述 maxZoomnumber 图层的最大缩放级别。
-
设置图层可见的最小分辨率。
Name Type 描述 minResolutionnumber 图层的最小分辨率。
-
设置图层可见的最小缩放级别(包含)。请注意,图层可见的缩放级别基于视图缩放级别,而视图缩放级别可能与瓦片源缩放级别不同。
Name Type 描述 minZoomnumber 图层的最小缩放级别。
-
设置图层的不透明度,允许值范围为0到1。
Name Type 描述 opacitynumber 图层的不透明度。
-
设置键值对集合。注意:此操作会修改现有属性并添加新属性,但不会删除任何现有属性。
Name Type 描述 valuesObject.<string, *> 值。
silentboolean | undefined 更新时不触发事件。
-
设置图层源。
Name Type 描述 sourceSourceType | null 图层源
-
设置图层可见性(
true或false)Name Type 描述 visibleboolean 图层的可见性。
-
设置图层的Z索引,用于在渲染前对图层进行排序。默认Z索引为0。
Name Type 描述 zindexnumber 图层的z-index。
-
取消监听特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听函数
-
清除属性。
Name Type 描述 keystring 键名
silentboolean | undefined 在不触发事件的情况下取消设置。