-
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 此图层可见的最大视图缩放级别(包含)。
sourceSourceType | undefined 该图层的源。若未在构造函数中提供,可通过调用来设置。
layer.setSource(source)构建后。mapMap | null | undefined 地图.
renderRenderFunction | undefined 渲染函数:以框架状态作为输入,并应返回一个HTML元素。它将覆盖图层的默认渲染。
propertiesObject.<string, *> | undefined 任意可观察属性。可通过以下方式访问。
#get()和#set().触发事件:
changeBaseEvent基事件 - 通用变更事件,在修订计数器递增时触发。-
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基础事件) - 通用错误事件。在发生错误时触发。postrender(RenderEvent) - 图层渲染完成后触发。prerender(渲染事件(RenderEvent)) - 在图层渲染之前触发。propertychange(ObjectEvent) - 属性变更时触发。-
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 |
该值 |
zIndex |
number | undefined | 是的 | change:zindex |
图层的Z索引。 |
方法
-
递增修订计数器并触发'change'事件。
-
分发事件并调用所有监听此类型事件的监听器。事件参数可以是字符串,也可以是具有
type属性的对象。Name Type 描述 eventBaseEvent | string 事件对象。
返回:
false如果事件对象上调用了preventDefault,或者任何监听器返回了false。
-
获取值。
Name Type 描述 keystring 键名
返回:
值。
-
获取给定视图下该图层数据源的归属信息。
Name Type 描述 viewView | ViewStateLayerStateExtent | undefined 查看或
FrameState仅当图层未添加到地图时才需要。返回:
该图层在给定视图中的归属。
-
返回图层的
extent或undefined(如果无论范围如何都可见)。返回:
图层范围。
-
获取对象属性名称列表。
返回:
属性名称列表。
-
返回图层的最大分辨率;若图层未设置最大分辨率,则返回无穷大。
返回:
图层的最大分辨率。
-
返回图层的最大缩放级别。若图层未设置最大缩放级别,则返回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-index,用于在渲染前确定图层顺序。默认 Z-index 为 0。
Name Type 描述 zindexnumber 图层的z-index。
-
取消监听特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数
-
清除属性。
Name Type 描述 keystring 键名。
silentboolean | undefined 在不触发事件的情况下取消设置。