TileWMS类

ol/source/TileWMS~瓦片WMS


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

用于从WMS服务器加载切片数据的图层源。

new TileWMS(options)

Name Type 描述
attributions AttributionLike | undefined

归属。

attributionsCollapsible boolean (defaults to true)

版权信息可折叠。

cacheSize number | undefined

已弃用。请改用图层的 cacheSize 选项。

crossOrigin null | string | undefined

crossOrigin 属性表示已加载的图像。请注意,若需使用Canvas渲染器访问像素数据,必须提供 crossOrigin,请使用此值。参考(https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image)以查看更多详细信息。

interpolate boolean (defaults to true)

重采样时应使用插值方法。默认采用线性插值;若设为 false,则使用最近邻插值。

params Object.<string, *>

WMS请求参数:至少一个。LAYERS参数是必需的。STYLES''默认。VERSION1.3.0默认。WIDTH, HEIGHT, BBOXCRS (SRS当 WMS 版本低于 1.3.0 时,设置将动态进行。

gutter number (defaults to 0)

瓦片周围要忽略的间隙大小(单位:像素)。通过将此属性设置为非零值,系统将请求尺寸大于标准瓦片尺寸的图像,增大的部分即为间隙值。2 x gutter使用非零值可忽略瓦片边缘处的渲染伪影。若您能控制 WMS 服务,建议通过适当配置该服务来解决“瓦片边缘伪影”问题。例如,MapServer 具有一项与 tile_map_edge_buffer 相关的配置参数,请参阅https://mapserver.org/output/tile_mode.html.

hidpi boolean (defaults to true)

使用ol/Map#pixelRatio从远程服务器请求图像时的值。

projection ProjectionLike | undefined

投影。默认为视图投影。

reprojectionErrorThreshold number (defaults to 0.5)

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

tileClass Class<ImageTile> | undefined

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

tileGrid TileGrid | undefined

瓦片网格应基于服务器支持的分辨率、瓦片大小和范围。如果未定义,将使用默认网格:如果存在投影范围,则网格基于该范围;否则,使用一个基于全局范围且原点在 (0,0) 的网格。

serverType ServerType | undefined

远程WMS服务器的类型:mapserver, geoserver, carmentaserver,或者qgis仅在需要时hidpitrue.

tileLoadFunction LoadFunction | undefined

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

function(imageTile, src) {
  imageTile.getImage().src = src;
};
url string | undefined

WMS 服务 URL

urls Array.<string> | undefined

WMS服务URL。请使用此替代。url当 WMS 支持用于 GetMap 请求的多个 URL 时。

wrapX boolean (defaults to true)

是否水平包裹世界。当设置为false只会渲染一个世界。当true,瓦片仅针对一个世界请求,但会水平环绕以渲染多个世界。

transition number | undefined

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

zDirection number | NearestDirectionFunction (defaults to 0)

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

触发事件:

继承

方法

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

清除源中所有缓存的重新投影切片。下一个渲染周期将创建新的切片。

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

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

获取值。

Name Type 描述
key string

键名。

返回:
值。

获取源的归属函数。

返回:
版权功能。

getAttributionsCollapsible(){boolean} inherited

返回:
版权声明可以折叠。

getFeatureInfoUrl(coordinate, resolution, projection, params){string | undefined}

返回指定坐标、分辨率和投影的要素信息查询URL。若无法构造该URL,则返回 undefined

Name Type 描述
coordinate Coordinate

坐标

resolution number

分辨率.

projection ProjectionLike

投影.

params Object

获取要素信息参数INFO_FORMAT至少应提供。如果QUERY_LAYERS若未提供,则使用指定的图层LAYERS将使用参数。VERSION不应在此处指定。

返回:
要素查询 URL。

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性列表。

getLegendUrl(resolution, params){string | undefined}

返回图例图形URL,可根据传入的分辨率进行优化,并可能包含传入的任何特定参数。若无法构建图例图形URL,则返回undefined

Name Type 描述
resolution number | undefined

分辨率。若设置为未定义,SCALE不会被计算,也不会被包含在URL中。

params Object | undefined

获取图例图形参数。如果设置了LAYER,将为该WMS图层生成请求;否则,将尝试使用已配置的WMS图层。默认情况下,FORMATimage/pngVERSION不应在此处指定。

返回:
获取图例图形URL

getParams(){Object}

获取用户通过“params”选项传递给构造函数的参数,并可能使用 updateParams 方法进行更新。

返回:
参数。

getProjection(){Projection | null} inherited

获取数据源的投影。

返回:
投影.

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

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

返回:
对象。

getRevision(){number} inherited

获取此对象的版本号。每次修改对象,其版本号将递增。

返回:
修订。

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

返回:
状态。

getTileGrid(){TileGrid | null} inherited

返回瓦片源的瓦片网格。

返回:
瓦片 网格.

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

返回:
瓦片加载函数

已弃用。请改用 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>, Attribution,或undefined.

setParams(params)

配置WMS源的URL参数。

Name Type 描述
params Object

新增 URL 参数。

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

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

Name Type 描述
tileLoadFunction LoadFunction

瓦片加载函数。

setTileUrlFunction(tileUrlFunction, key) inherited

已弃用。请改用图像瓦片源。设置源的瓦片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

取消设置而不触发事件。

updateParams(params)

更新 URL 参数。此方法可用于更新 WMS 参数的子集。调用 setParams 来设置所有参数。

Name Type 描述
params Object

URL 参数已更新。