-
Name Type 描述 styleStyle | undefined 应用于图层的样式。
classNamestring (defaults to 'ol-layer') 图层元素的CSS类名。
opacitynumber (defaults to 1) 不透明度(0至1)。
visibleboolean (defaults to true) 可见.
extentExtent | undefined 图层渲染的边界范围。图层不会在此范围之外进行渲染。
zIndexnumber | undefined 图层渲染的 z 索引。在渲染时,图层将首先按 z 索引排序,然后按位置排序。
undefined, azIndex对于添加到地图的图层,默认值为0。layers集合或Infinity当图层的setMap()采用了方法。minResolutionnumber | undefined 该图层可见的最小分辨率(包含)。
maxResolutionnumber | undefined 最大分辨率(不含),低于此分辨率时图层可见。
minZoomnumber | undefined 最小视图缩放级别(不含),高于此级别时图层可见。
maxZoomnumber | undefined 该图层可见的最大视图缩放级别(含)。
preloadnumber (defaults to 0) 预加载。加载低分辨率瓦片最多
preload级别。0表示无预加载。sourceSourceType | undefined 此图层的来源。
sourcesArray.<SourceType> | function | undefined 该图层的数据源数组。优先级高于
source可以是源数组,也可以是接受范围和分辨率(以每像素视图投影单位为单位)并返回源数组的函数。参见sourcesFromTileGrid用于生成以金字塔结构组织、遵循瓦片网格模式的数据源的辅助函数。注意:所有来源必须具有相同的波段数和内容。mapMap | undefined 将图层设置为地图上的叠加图层。地图不会在其图层集合中管理该图层,且该图层将渲染于顶层。此方式适用于临时图层。将图层添加至地图并由地图管理的标准方式是使用
addLayer.useInterimTilesOnErrorboolean (defaults to true) 已弃用。发生错误时使用临时图块。
cacheSizenumber (defaults to 512) 内部纹理缓存大小需要足够大,以渲染两个缩放级别的瓦片。
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:preload(ObjectEvent) -
change:source(ObjectEvent) -
change:useInterimTilesOnError(ObjectEvent) -
change:visible(ObjectEvent) -
change:zIndex(ObjectEvent) error基础事件(BaseEvent) - 通用错误事件。在错误发生时触发。postrender(RenderEvent渲染事件) - 在图层渲染后触发。prerenderRenderEvent渲染事件 - 在图层渲染之前触发。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 |
图层的不透明度 |
preload |
number | 是的 | change:preload |
预加载瓦片的最高级别。 |
source |
SourceType | null | 是的 | change:source |
图层源(或 |
useInterimTilesOnError |
boolean | 是的 | change:useinterimtilesonerror |
出错时使用临时瓦片。 |
visible |
boolean | 是的 | change:visible |
该值 |
zIndex |
number | undefined | 是的 | change:zindex |
图层的Z索引。 |
方法
-
增加修订计数器并触发 'change' 事件。
-
触发事件并调用所有监听该类型事件的监听器。事件参数可以是字符串,也可以是具有
type属性的对象。Name Type 描述 eventBaseEvent | string 事件对象。
返回:
false如果有人在事件对象上调用了 preventDefault,或者任何侦听器返回了 false。
-
释放底层 WebGL 资源。
-
获取值。
Name Type 描述 keystring 键名。
返回:
值。
-
获取指定视图对应的图层源归属信息
Name Type 描述 viewView | ViewStateLayerStateExtent | undefined 查看或
FrameState仅当图层未添加到地图时才需要。返回:
在当前视图中,该图层的归属信息。
-
getData(pixel){Uint8ClampedArray | Uint8Array | Float32Array | DataView | null} inherited
-
获取像素坐标处的数据。返回类型取决于源数据。对于图像瓦片,将返回一个四元 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 索引,用于在渲染前对图层进行排序。若图层未受管理,则返回未定义。
返回:
图层的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 描述 preloadnumber 预加载瓦片的上限级别。
-
设置键值对集合。注意:此操作将修改现有属性并添加新属性,但不会删除任何现有属性。
Name Type 描述 valuesObject.<string, *> 值。
silentboolean | undefined 更新时不触发事件。
-
设置图层源。
Name Type 描述 sourceSourceType | null 图层源。
-
已弃用。设置是否在发生错误时使用临时图块。
Name Type 描述 useInterimTilesOnErrorboolean 出错时使用临时瓦片。
-
设置图层可见性(
true或false)。Name Type 描述 visibleboolean 图层的可见性。
-
设置图层的Z索引,用于在渲染前对图层进行排序。默认Z索引为0。
Name Type 描述 zindexnumber 图层的z-index。
-
取消监听特定类型的事件。
Name Type 描述 typestring | Array.<string> 事件类型或事件类型数组。
listenerfunction 监听器函数
-
清除属性。
Name Type 描述 keystring 键名。
silentboolean | undefined 在不触发事件的情况下取消设置。
-
更新图层样式所使用的任何变量,并触发重新渲染。
Name Type 描述 variablesObject.<string, number> 待更新的变量。