Class: TileWMS

ol/source/TileWMS~TileWMS


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

来自 WMS 服务器的瓦片数据图层数据源。

new TileWMS(options)

Name Type Description
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 可使用 the nearest neighbor instead.

params 对象。<string, *>

WMS 请求参数。至少需要 LAYERS 参数。STYLES 默认为 ''VERSION 默认为 1.3.0WIDTHHEIGHTBBOXCRS(WMS 版本 < 1.3.0 时为 SRS)将动态设置。

gutter number (defaults to 0)

图像瓦片周围要忽略的边距大小(像素)。将此属性设置为非零值时,将请求比瓦片尺寸宽和高 2 x gutter 值的图像。使用非零值可以忽略瓦片边缘的渲染伪影。如果您控制 WMS 服务,建议通过正确配置 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。仅在 hidpi 为 true 时需要。
tileLoad函数 Load函数 | undefined

给定 URL 加载瓦片的可选函数。默认为

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

WMS 服务 URL。

urls Array.<string> | undefined

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

wrapX boolean (defaults to true)

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

transition number | undefined

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

zDirection number | NearestDirection函数 (defaults to 0)

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

触发事件:

Extends

Methods

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

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type Description
event BaseEvent | string

事件对象。

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

获取一个值。

Name Type Description
key string

键名。

返回值:
值。

获取数据源的归属函数。

返回值:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

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

get要素InfoUrl(coordinate, resolution, projection, params){string | undefined}

返回GetFeatureInfo URL for the passed coordinate, resolution, and projection. Return undefined if the GetFeatureInfo URL cannot be constructed.

Name Type Description
coordinate Coordinate

坐标。

resolution number

分辨率。

projection ProjectionLike

投影。

params Object

GetFeatureInfo 参数。至少应提供 INFO_FORMAT。如果未提供 QUERY_LAYERS,则使用 LAYERS 参数中指定的图层。此处不应指定 VERSION

返回值:
GetFeatureInfo URL.

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回值:
属性名列表。

getLegendUrl(resolution, params){string | undefined}

返回 GetLegendGraphic URL,可选择针对指定分辨率进行优化,并可能包含任何传入的特定参数。如果无法构造 GetLegendGraphic URL 则返回 undefined。

Name Type Description
resolution number | undefined

分辨率。如果设置为 undefined,SCALE 将不会被计算并包含在 URL 中。

params Object | undefined

GetLegendGraphic 参数。如果设置了 LAYER,则为此 WMS 图层生成请求,否则将尝试使用已配置的 WMS 图层。默认 FORMATimage/png。此处不应指定 VERSION

返回值:
GetLegendGraphic URL.

getParams(){Object}

获取用户提供的参数,即通过"params"选项传递给构造函数的参数,可能已通过 updateParams 方法更新。

返回值:
参数。

getProjection(){Projection | null} inherited

获取数据源的投影。

返回值:
投影。

getProperties(){NoInfer.<Properties>} inherited

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

返回值:
对象。

getRevision(){number} inherited

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

返回值:
版本号。

获取数据源的状态,可能的状态参见 State。

返回值:
状态。

getTileGrid(){TileGrid | null} inherited

返回瓦片数据源的瓦片网格。

返回值:
瓦片网格。

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

返回值:
TileLoad函数

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

返回值:
TileUrl函数

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

已弃用。 请改用 ImageTile 数据源。 返回此数据源使用的 URL。 当使用 tileUrl函数 时ad of url or urls, null will be returned.

返回值:
URL 列表。

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

监听特定类型的事件。

Name Type Description
type string | Array.<string>

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

listener function

监听器函数。

返回值:
监听器的唯一键。如果第一个参数是事件类型数组,则返回键的数组。

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

仅监听一次特定类型的事件。

Name Type Description
type string | Array.<string>

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

listener function

监听器函数。

返回值:
监听器的唯一键。如果第一个参数是事件类型数组,则返回键的数组。

set(key, value, silent) inherited

设置一个值。

Name Type Description
key string

键名。

value *

值。

silent boolean | undefined

更新但不触发事件。

setAttributions(attributions) inherited

设置数据源的归属信息。

Name Type Description
attributions AttributionLike | undefined

归属信息。可以作为字符串、Array<string>、Attribution 或 undefined 传入。

setParams(params)

设置传递给 WMS 数据源的 URL 参数。

Name Type Description
params Object

新的 URL 参数。

setProperties(values, silent) inherited

设置一组键值对。 注意,这会更改任何现有属性并添加新属性(不会移除任何现有属性)。

Name Type Description
values Partial.<NoInfer.<Properties>>

值。

silent boolean | undefined

更新但不触发事件。

setRenderReprojectionEdges(render) inherited

设置是否渲染重投影边缘(通常用于调试)。

Name Type Description
render boolean

渲染边缘。

setTileGridForProjection(projection, tilegrid) inherited

设置在将瓦片重投影到给定投影时使用的瓦片网格, 而不是默认的瓦片网格rojection.

当无法创建默认瓦片网格(例如投影未定义范围)或出于优化原因(自定义瓦片尺寸、分辨率等)时,这可能很有用。

Name Type Description
projection ProjectionLike

投影。

tilegrid TileGrid

用于投影的瓦片网格。

setTileLoad函数(tileLoad函数) inherited

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

Name Type Description
tileLoad函数 Load函数

瓦片加载函数。

setTileUrl函数(tileUrl函数, key) inherited

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

Name Type Description
tileUrl函数 Url函数

瓦片 URL 函数。

key string | undefined

数据源的可选新瓦片键。

设置用于请求的 URL。

Name Type Description
url string

URL.

已弃用。 请改用 ImageTile 数据源。 设置用于请求的 URL。

Name Type Description
urls Array.<string>

URL 列表。

un(type, listener) inherited

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

Name Type Description
type string | Array.<string>

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

listener function

监听器函数。

unset(key, silent) inherited

取消设置一个属性。

Name Type Description
key string

键名。

silent boolean | undefined

取消设置但不触发事件。

updateParams(params)

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

Name Type Description
params Object

更新后的 URL 参数。