类:WebGLTileLayer

ol/layer/WebGLTile~WebGL瓦片图层


import WebGLTileLayer from 'ol/layer/WebGLTile.js';

对于提供预渲染瓦片图像的图层源,这些图像按缩放级别在网格中组织,对应特定分辨率。请注意,在选项中设置的任何属性都将作为 BaseObject 属性设置在图层对象上;例如,设置 title: 'My Title' 意味着 title 是可观察的,并且具有 get/set 访问器。

new WebGLTileLayer(options)

Name Type 描述
style Style | undefined

应用于图层的样式。

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 索引。在渲染时,图层将首先按 z 索引排序,然后按位置排序。undefined, a zIndex对于添加到地图的图层,默认值为0。layers集合或Infinity当图层的setMap()采用了方法。

minResolution number | undefined

该图层可见的最小分辨率(包含)。

maxResolution number | undefined

最大分辨率(不含),低于此分辨率时图层可见。

minZoom number | undefined

最小视图缩放级别(不含),高于此级别时图层可见。

maxZoom number | undefined

该图层可见的最大视图缩放级别(含)。

preload number (defaults to 0)

预加载。加载低分辨率瓦片最多preload级别。0表示无预加载。

source SourceType | undefined

此图层的来源。

sources Array.<SourceType> | function | undefined

该图层的数据源数组。优先级高于source可以是源数组,也可以是接受范围和分辨率(以每像素视图投影单位为单位)并返回源数组的函数。参见sourcesFromTileGrid用于生成以金字塔结构组织、遵循瓦片网格模式的数据源的辅助函数。注意:所有来源必须具有相同的波段数和内容。

map Map | undefined

将图层设置为地图上的叠加图层。地图不会在其图层集合中管理该图层,且该图层将渲染于顶层。此方式适用于临时图层。将图层添加至地图并由地图管理的标准方式是使用addLayer.

useInterimTilesOnError boolean (defaults to true)

已弃用。发生错误时使用临时图块。

cacheSize number (defaults to 512)

内部纹理缓存大小需要足够大,以渲染两个缩放级别的瓦片。

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

图层的不透明度

preload number 是的 change:preload

预加载瓦片的最高级别。

source SourceType | null 是的 change:source

图层源(或null如果尚未设置。

useInterimTilesOnError boolean 是的 change:useinterimtilesonerror

出错时使用临时瓦片。

visible boolean 是的 change:visible

该值visible图层属性。

zIndex number | undefined 是的 change:zindex

图层的Z索引。

方法

增加修订计数器并触发 'change' 事件。

dispatchEvent(event){boolean | undefined} inherited

触发事件并调用所有监听该类型事件的监听器。事件参数可以是字符串,也可以是具有 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果有人在事件对象上调用了 preventDefault,或者任何侦听器返回了 false。

释放底层 WebGL 资源。

获取值。

Name Type 描述
key string

键名。

返回:
值。

getAttributions(view){Array.<string>} inherited

获取指定视图对应的图层源归属信息

Name Type 描述
view View | 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 描述
pixel Pixel

像素.

返回:
像素数据。

getExtent(){Extent | undefined} inherited

返回图层的 extent;若图层在任何范围内均可见,则返回 undefined

返回:
图层范围。

getKeys(){Array.<string>} inherited

获取对象属性名称列表

返回:
属性名称列表

getMaxResolution(){number} inherited

返回图层的最大分辨率;若未设置,则返回 Infinity。

返回:
图层的最大分辨率。

getMaxZoom(){number} inherited

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

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

getMinResolution(){number} inherited

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

返回:
图层的最小分辨率。

getMinZoom(){number} inherited

返回图层的最小缩放级别;若图层未设置最小缩放级别,则返回 -Infinity。

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

getOpacity(){number} inherited

返回图层的不透明度(值在0到1之间)。

返回:
图层的不透明度。

getPreload(){number} inherited

返回预加载瓦片的缩放级别。

返回:
预加载瓦片的缩放级别。

getProperties(){Object.<string, *>} inherited

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

返回:
对象。

getRevision(){number} inherited

获取此对象的版本号。每当对象被修改时,其版本号将自动递增。

返回:
修订。

getSource(){SourceType | null} inherited

获取图层源。

返回:
图层源(若尚未设置,则使用 null)。

getUseInterimTilesOnError(){boolean} inherited

已弃用。是否在出错时使用临时图块?

返回:
出错时使用临时瓦片。

getVisible(){boolean} inherited

返回此图层 visible 属性的值。若要确定图层在地图上是否可见,请使用 isVisible() 替代。

返回:
图层的 visible 属性值。

getZIndex(){number | undefined} inherited

返回图层的 Z 索引,用于在渲染前对图层进行排序。若图层未受管理,则返回未定义。

返回:
图层的Z索引

isVisible(view){boolean} inherited

该图层在地图视图上可见,即在其最小/最大分辨率或缩放级别与范围内,且未设置为 visible: false,同时不在设置为 visible: false 的图层组内。

Name Type 描述
view View | ViewStateLayerStateExtent | undefined

查看或FrameState仅当图层未添加到地图时才需要。

返回:
图层在地图视图中可见。

on(type, listener){EventsKey | Array<EventsKey>} inherited

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数

返回:
监听器的唯一键。如果以事件类型数组作为第一个参数调用,则返回将是键的数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited

对特定类型的事件进行单次监听。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组

listener function

监听器函数

返回:
监听器的唯一键。当以事件类型数组作为第一个参数调用时,返回值将是一个键数组。

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名。

value *

值。

silent boolean | undefined

更新而不触发事件。

setExtent(extent) inherited

设置图层的可见范围。若 undefined,则图层在所有范围内均可见。

Name Type 描述
extent Extent | undefined

图层的范围。

设置图层以在地图其他图层之上渲染。地图不会在其图层集合中管理此图层。这对临时图层非常有用。要移除地图中的非托管图层,请使用 #setMap(null)

要将图层添加到地图并交由地图管理,请使用 addLayer 替代。

Name Type 描述
map Map | null

地图.

setMaxResolution(maxResolution) inherited

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

Name Type 描述
maxResolution number

图层的最大分辨率。

setMaxZoom(maxZoom) inherited

设置图层可见的最大缩放级别(不包含)。请注意,图层可见的缩放级别基于视图缩放级别,而视图缩放级别可能与图块源缩放级别不同。

Name Type 描述
maxZoom number

图层的最大缩放级别。

setMinResolution(minResolution) inherited

设定图层开始可见的最小分辨率。

Name Type 描述
minResolution number

图层的最小分辨率

setMinZoom(minZoom) inherited

设置图层可见的最小缩放级别(包含)。请注意,图层可见的缩放级别基于视图的缩放级别,而视图缩放级别可能与瓦片源缩放级别不同。

Name Type 描述
minZoom number

图层的最小缩放级别。

setOpacity(opacity) inherited

设置图层的不透明度,取值范围为0到1。

Name Type 描述
opacity number

图层的不透明度。

setPreload(preload) inherited

设置预加载图块的最大缩放级别。

Name Type 描述
preload number

预加载瓦片的上限级别。

setProperties(values, silent) inherited

设置键值对集合。注意:此操作将修改现有属性并添加新属性,但不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

更新时不触发事件。

setSource(source) inherited

设置图层源。

Name Type 描述
source SourceType | null

图层源。

setUseInterimTilesOnError(useInterimTilesOnError) inherited

已弃用。设置是否在发生错误时使用临时图块。

Name Type 描述
useInterimTilesOnError boolean

出错时使用临时瓦片。

setVisible(visible) inherited

设置图层可见性(truefalse)。

Name Type 描述
visible boolean

图层的可见性。

setZIndex(zindex) inherited

设置图层的Z索引,用于在渲染前对图层进行排序。默认Z索引为0。

Name Type 描述
zindex number

图层的z-index。

un(type, listener) inherited

取消监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数

unset(key, silent) inherited

清除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

在不触发事件的情况下取消设置。

updateStyleVariables(variables)

更新图层样式所使用的任何变量,并触发重新渲染。

Name Type 描述
variables Object.<string, number>

待更新的变量。