类:WMTS

ol/source/WMTS~网络地图切片服务


import WMTS from 'ol/source/WMTS.js';

从WMTS服务器获取切片数据的图层源。

new WMTS(options)

Name Type 描述
attributions AttributionLike | undefined

归属。

attributionsCollapsible boolean (defaults to true)

归属信息是可折叠的。

cacheSize number | undefined

已弃用。请使用图层上的 cacheSize 选项。

crossOrigin null | string | undefined

已加载图像的crossOrigin属性。请注意,您必须提供crossOrigin。若要使用Canvas渲染器访问像素数据,请使用此值。参见文档(https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image)了解更多详情。

interpolate boolean (defaults to true)

重采样时请使用插值。默认采用线性插值;将其设置为 false 以改用最近邻法。

tileGrid WMTSTileGrid

瓦片 网格.

projection ProjectionLike | undefined

投影默认为视图投影。

reprojectionErrorThreshold number (defaults to 0.5)

最大允许重投影误差(像素单位)。较高的值可提升重投影性能,但会降低精度。

requestEncoding RequestEncoding (defaults to 'KVP')

请求编码。

layer string

WMTS能力文档中声明的图层名称。

style string

WMTS能力文档中声明的样式名称。

tileClass Class<ImageTile> | undefined

用于实例化图像切片的类。默认为ImageTile.

tilePixelRatio number (defaults to 1)

切片服务所使用的像素比。例如,如果切片服务声明其切片为 256x256 像素,但实际发送 512x512 像素的图像(针对视网膜/高DPI设备),则tilePixelRatio应设置为2.

format string (defaults to 'image/jpeg')

图像格式。仅在以下情况下使用requestEncoding'KVP'.

version string (defaults to '1.0.0')

WMTS版本

matrixSet string

矩阵集。

dimensions Object | undefined

瓦片请求的附加维度。该对象的属性名称类似于WMTS声明的维度。

url string | undefined

服务URL。在RESTful请求编码中,这是一个URL模板;对于KVP编码,它就是一个普通URL。{?-?}模板模式,例如subdomain{a-f}.domain.com,可用于替代在...中分别定义每个urls选项。

tileLoadFunction LoadFunction | undefined

可选函数,用于通过给定 URL 加载瓦片。默认为

function(imageTile, src) {
  imageTile.getImage().src = src;
};
urls Array.<string> | undefined

URL 数组。请求将在此数组中的各URL间进行分布。

wrapX boolean (defaults to false)

是否水平环绕世界?

transition number | undefined

渲染过程中不透明度过渡的持续时间。要禁用不透明度过渡,请传递transition: 0.

zDirection number | NearestDirectionFunction (defaults to 0)

在整数缩放级别之间,选择是否使用更高或更低缩放级别的瓦片。参见getZForResolution.

触发事件:

继承

方法

递增修订计数器并触发变更事件。

从源中清除所有缓存的重投影瓦片。下一个渲染循环将创建新的瓦片。

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果事件对象的preventDefault方法被调用,或者任何事件监听器返回了false。

获取值。

Name Type 描述
key string

键名。

返回:
值。

获取源的归属函数。

返回:
归属功能。

getAttributionsCollapsible(){boolean} inherited

返回:
归属信息可折叠。

getDimensions(){Object}

获取构造函数中通过“dimensions”选项传入的维度,并可能使用 updateDimensions 方法进行更新。

返回:
维度。

getFormat(){string}

返回 WMTS 源的图像格式。

返回:
格式。

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性名列表。

getLayer(){string}

返回WMTS源的图层。

返回:
图层.

getMatrixSet(){string}

返回 WMTS 源的瓦片矩阵集。

返回:
矩阵集。

getProjection(){Projection | null} inherited

获取源的投影。

返回:
投影.

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

获取包含所有属性名及其值的对象。

返回:
对象。

getRequestEncoding(){RequestEncoding}

返回请求编码,选项为“KVP”或“REST”。

返回:
请求编码。

getRevision(){number} inherited

获取该对象的版本号。每次修改对象时,其版本号都会递增。

返回:
修订。

获取源的状态,请参阅 State 了解可能的状态。

返回:
状态。

getStyle(){string}

返回 WMTS 源的样式。

返回:
样式。

getTileGrid(){TileGrid | null} inherited

返回瓦片源的瓦片网格。

返回:
瓦片 网格.

已弃用。请改用ImageTile源。返回源的瓦片加载函数。

返回:
瓦片加载函数

已弃用。请改用ImageTile源。返回源的瓦片URL函数。

返回:
瓦片URL函数

getUrls(){!Array.<string> | null} inherited

已弃用。请改用 ImageTile 源。 返回此源所使用的 URL。 当使用 tileUrlFunction 而不是 url 或 urls 时,将返回 null。

返回:
网址。

getVersion(){string}

返回 WMTS 源的版本。

返回:
版本。

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

更新时避免触发事件。

setAttributions(attributions) inherited

设置来源的归属。

Name Type 描述
attributions AttributionLike | undefined

归属。可以传递为string, Array<string>, Attribution,或者undefined.

setProperties(values, silent) inherited

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

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

值。

silent boolean | undefined

更新时不触发事件。

setRenderReprojectionEdges(render) inherited

控制是否渲染重投影边缘(通常用于调试)

Name Type 描述
render boolean

渲染边线。

setTileGridForProjection(projection, tilegrid) inherited

设置用于将瓦片重新投影到给定投影的瓦片网格,而非该投影的默认瓦片网格。

当默认图块网格无法创建时(例如投影未定义范围),或为优化性能(如自定义图块大小、分辨率等),此方法可能非常有用。

Name Type 描述
projection ProjectionLike

投影.

tilegrid TileGrid

用于投影的瓦片网格。

setTileLoadFunction(tileLoadFunction) inherited

已弃用。请改用ImageTile源。设置源的瓦片加载函数。

Name Type 描述
tileLoadFunction LoadFunction

瓦片加载函数

setTileUrlFunction(tileUrlFunction, key) inherited

已弃用。请改用图像瓦片源。设置源的瓦片URL函数。

Name Type 描述
tileUrlFunction UrlFunction

瓦片 URL 功能。

key string | undefined

源的可选新瓦片键。

配置请求所使用的URL。

Name Type 描述
url string

网址。

un(type, listener) inherited

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

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

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

listener function

监听器函数。

unset(key, silent) inherited

移除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

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

updateDimensions(dimensions)

更新尺寸。

Name Type 描述
dimensions Object

尺寸。