类:OGCVectorTile

ol/source/OGCVectorTile~OGC矢量切片


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

图层数据源用于从提供“矢量”类型瓦片的服务(OGC API - Tiles)获取地图瓦片。该服务必须至少符合核心(http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/core)和瓦片集(http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/tileset)一致性类。为支持 collections 选项,该服务必须符合集合选择(http://www.opengis.net/spec/ogcapi-tiles-1/1.0/conf/collections-selection)一致性类。

矢量切片可采用多种格式(如 GeoJSON、MVT)。format 选项用于确定使用所声明的哪种媒体类型。若需强制使用特定媒体类型,可通过提供 mediaType 选项来实现。

new OGCVectorTile(options)

Name Type 描述
url string

OGC矢量瓦片集端点的URL

context Object | undefined

用于瓦片URL模板的值查找。{tileMatrix}(缩放级别),{tileRow},和{tileCol}URL中的变量将始终由源提供。

format FeatureFormat<FeatureType> | undefined

瓦片要素格式。默认使用并必需。

mediaType string | undefined

瓦片的内容类型(例如 "application/vnd.mapbox-vector-tile")。如果未指定,数据源将尝试查找具有 rel="item" 属性的链接,该链接所支持的矢量瓦片格式由配置决定。

attributions AttributionLike | undefined

版权信息。

attributionsCollapsible boolean (defaults to true)

版权信息是可折叠的。

cacheSize number | undefined

已弃用。建议改用图层的 cacheSize 选项。

overlaps boolean (defaults to true)

该数据源可能存在重叠的几何图形。将其设置为false(例如,对于表示行政边界的多边形源或 TopoJSON 源)可使渲染器优化填充与描边操作。

projection ProjectionLike (defaults to 'EPSG:3857')

瓦片网格的投影。

tileClass Class<VectorTile> | undefined

用于实例化图像瓦片的类。默认为VectorTile.

transition number | undefined

瓦片不透明度过渡效果的持续时间(单位:毫秒)。设置为 0 时将禁用不透明度过渡效果。

wrapX boolean (defaults to true)

是否水平环绕世界。当设置为false,仅渲染一个世界。当设置为true,瓦片将水平重复以渲染多个世界。

zDirection number | NearestDirectionFunction (defaults to 1)

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

collections Array.<string> | undefined

要包含的地理空间数据子资源列表。如果未提供,则包含整个数据集。当请求单个集合的瓦片集时,此选项不适用。

触发事件:

继承

方法

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

清除源中所有已缓存的重新投影瓦片。下一个渲染周期将生成新的瓦片。

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

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

获取一个值。

Name Type 描述
key string

键名。

返回:
值。

获取数据源的归属函数。

返回:
归属功能。

getAttributionsCollapsible(){boolean} inherited

返回:
归属信息是可折叠的。

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性名称列表。

getProjection(){Projection | null} inherited

获取数据源的投影。

返回:
投影.

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

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

返回:
对象。

getRevision(){number} inherited

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

返回:
修订。

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

返回:
状态

getTileGrid(){TileGrid | null} inherited

返回瓦片源的瓦片网格。

返回:
瓦片 网格.

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

返回:
瓦片加载函数

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

返回:
瓦片URL函数

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

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

返回:
网址。

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>, Attributionundefined.

setProperties(values, silent) inherited

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

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

值。

silent boolean | undefined

更新时不触发事件。

setTileLoadFunction(tileLoadFunction) inherited

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

Name Type 描述
tileLoadFunction LoadFunction

瓦片加载函数

setTileUrlFunction(tileUrlFunction, key) inherited

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

Name Type 描述
tileUrlFunction UrlFunction

瓦片 URL 函数。

key string | undefined

源的可选新瓦片键。

设置请求的URL。

Name Type 描述
url string

网址。

此功能已弃用,请改用 ImageTile 源并设置请求所使用的 URL。

Name Type 描述
urls Array.<string>

网址。

un(type, listener) inherited

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

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

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

listener function

监听器函数。

unset(key, silent) inherited

清除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

取消设置且不触发事件。