ImageWMS类

ol/source/ImageWMS~图像WMS


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

WMS服务器提供单个、非瓦片图像。

new ImageWMS(options)

Name Type 描述
attributions AttributionLike | undefined

版权信息。

crossOrigin null | string | undefined

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

hidpi boolean (defaults to true)

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

serverType ServerType | undefined

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

imageLoadFunction LoadFunction | undefined

可选函数,用于加载指定 URL 的图像。

interpolate boolean (defaults to true)

重采样时默认采用线性插值;若将设置设为 false,则改用最近邻插值。

params Object.<string, *> | undefined

WMS请求参数:至少一个LAYERS参数为必填项。STYLES''默认情况下。VERSION1.3.0默认情况下。WIDTH, HEIGHT, BBOXCRS (SRS当 WMS 版本低于 1.3.0 时,将动态设置。

projection ProjectionLike | undefined

投影。默认为视图投影。

ratio number (defaults to 1.5)

比率。1这意味着图像请求的尺寸与地图视口相同。2表示地图视口的宽度和高度均为两倍,以此类推。必须是1或更高版本。

resolutions Array.<number> | undefined

分辨率。如果指定了分辨率,请求将仅使用这些分辨率。

url string | undefined

WMS服务的URL。

触发事件:

继承

方法

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

getImageLoadFunction(){LoadFunction}

返回源的图像加载函数。

返回:
图像加载功能。

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 了解可能的状态。

返回:
状态。

getUrl(){string | undefined}

返回此 WMS 源所使用的 URL。

返回:
网址。

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.

setImageLoadFunction(imageLoadFunction)

设置源的图像加载函数。

Name Type 描述
imageLoadFunction LoadFunction

图像加载函数。

setParams(params)

设置用户提供的参数。

Name Type 描述
params Object

参数

setProperties(values, silent) inherited

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

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

值。

silent boolean | undefined

更新时不触发事件。

设置请求的URL。

Name Type 描述
url string | undefined

网址。

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)

更新用户提供的参数。

Name Type 描述
params Object

参数。