Module: ol/source/wms

ol/source/wms


函数s

createLoader(options){ImageObjectPromiseLoader}

source/wms.js, line 163 
import {createLoader} from 'ol/source/wms';

创建a loader for WMS images.

Name Type Description
crossOrigin null | string | undefined 已加载图像的 crossOrigin 属性。注意如果要使用 Canvas 渲染器访问像素数据，必须提供 crossOrigin 值。详见 https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image。
referrerPolicy ReferrerPolicy | undefined

已加载图像的 referrerPolicy 属性。
hidpi boolean (defaults to true)

从远程服务器请求图像时使用 ol/Map#pixelRatio 值。
params 对象。<string, *> | undefined

WMS 请求参数。至少需要 LAYERS 参数。STYLES 默认为 ''。VERSION 默认为 1.3.0。WIDTH、HEIGHT 和 BBOX 将动态设置。CRS（WMS 版本 < 1.3.0 时为 SRS）将从 proection 配置派生。
projection ProjectionLike | undefined

投影。默认为 'EPSG:3857'。
ratio number (defaults to 1.5)

比率。1 表示图像请求为地图视口的大小，2 表示地图视口宽高的两倍，以此类推。必须为 1 或更高。
serverType ServerType | undefined 远程 WMS 服务器的类型：mapserver、geoserver、carmentaserver 或 qgis。仅在 hidpi 为 true 时需要。
url string

WMS 服务 URL。
load function | undefined

执行图像加载的函数。接收创建的 HTMLImageElement 和所需的 src 作为参数，返回解析为已加载或已解码图像的 Promise。默认为 decode。
返回值：
Loader.

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

source/wms.js, line 206 
import {get要素InfoUrl} from 'ol/source/wms';

获取GetFeatureInfo URL for the passed coordinate and resolution. Returns undefined if the GetFeatureInfo URL cannot be constructed.

Name Type Description
options LoaderOptions

传递给 createWMSLoader() 函数的选项。除了加载器所需的参数外，应指定 INFO_FORMAT，默认为 application/json。如果未提供 QUERY_LAYERS，则使用 LAYERS 参数中指定的图层。
coordinate Coordinate

坐标。
resolution number

分辨率。
options.crossOrigin null | string | undefined 已加载图像的 crossOrigin 属性。注意如果要使用 Canvas 渲染器访问像素数据，必须提供 crossOrigin 值。详见 https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image。
options.referrerPolicy ReferrerPolicy | undefined

已加载图像的 referrerPolicy 属性。
options.hidpi boolean (defaults to true)

从远程服务器请求图像时使用 ol/Map#pixelRatio 值。
options.params 对象。<string, *> | undefined

WMS 请求参数。至少需要 LAYERS 参数。STYLES 默认为 ''。VERSION 默认为 1.3.0。WIDTH、HEIGHT 和 BBOX 将动态设置。CRS（WMS 版本 < 1.3.0 时为 SRS）将从 proection 配置派生。
options.projection ProjectionLike | undefined

投影。默认为 'EPSG:3857'。
options.ratio number (defaults to 1.5)

比率。1 表示图像请求为地图视口的大小，2 表示地图视口宽高的两倍，以此类推。必须为 1 或更高。
options.serverType ServerType | undefined 远程 WMS 服务器的类型：mapserver、geoserver、carmentaserver 或 qgis。仅在 hidpi 为 true 时需要。
options.url string

WMS 服务 URL。
options.load function | undefined

执行图像加载的函数。接收创建的 HTMLImageElement 和所需的 src 作为参数，返回解析为已加载或已解码图像的 Promise。默认为 decode。
返回值：
GetFeatureInfo URL.

getLegendUrl(options, resolution){string | undefined}

source/wms.js, line 256 
import {getLegendUrl} from 'ol/source/wms';

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

Name Type Description
options LoaderOptions

传递给 createWMSLoader() 函数的选项。
resolution number | undefined

分辨率。如果未提供，SCALE 将不会被计算并包含在 URL 中。
options.crossOrigin null | string | undefined 已加载图像的 crossOrigin 属性。注意如果要使用 Canvas 渲染器访问像素数据，必须提供 crossOrigin 值。详见 https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image。
options.referrerPolicy ReferrerPolicy | undefined

已加载图像的 referrerPolicy 属性。
options.hidpi boolean (defaults to true)

从远程服务器请求图像时使用 ol/Map#pixelRatio 值。
options.params 对象。<string, *> | undefined

WMS 请求参数。至少需要 LAYERS 参数。STYLES 默认为 ''。VERSION 默认为 1.3.0。WIDTH、HEIGHT 和 BBOX 将动态设置。CRS（WMS 版本 < 1.3.0 时为 SRS）将从 proection 配置派生。
options.projection ProjectionLike | undefined

投影。默认为 'EPSG:3857'。
options.ratio number (defaults to 1.5)

比率。1 表示图像请求为地图视口的大小，2 表示地图视口宽高的两倍，以此类推。必须为 1 或更高。
options.serverType ServerType | undefined 远程 WMS 服务器的类型：mapserver、geoserver、carmentaserver 或 qgis。仅在 hidpi 为 true 时需要。
options.url string

WMS 服务 URL。
options.load function | undefined

执行图像加载的函数。接收创建的 HTMLImageElement 和所需的 src 作为参数，返回解析为已加载或已解码图像的 Promise。默认为 decode。
返回值：
GetLegendGraphic URL.

Type Definitions

LoaderOptions{Object}

Properties:
Name Type Description
crossOrigin null | string | undefined 已加载图像的 crossOrigin 属性。注意如果要使用 Canvas 渲染器访问像素数据，必须提供 crossOrigin 值。详见 https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image。
referrerPolicy ReferrerPolicy | undefined

已加载图像的 referrerPolicy 属性。
hidpi boolean
(defaults to true)

从远程服务器请求图像时使用 ol/Map#pixelRatio 值。
params 对象。<string, *> | undefined

WMS 请求参数。至少需要 LAYERS 参数。STYLES 默认为 ''。VERSION 默认为 1.3.0。WIDTH、HEIGHT 和 BBOX 将动态设置。CRS（WMS 版本 < 1.3.0 时为 SRS）将从 proection 配置派生。
projection ProjectionLike | undefined

投影。默认为 'EPSG:3857'。
ratio number
(defaults to 1.5)

比率。1 表示图像请求为地图视口的大小，2 表示地图视口宽高的两倍，以此类推。必须为 1 或更高。
serverType ServerType | undefined 远程 WMS 服务器的类型：mapserver、geoserver、carmentaserver 或 qgis。仅在 hidpi 为 true 时需要。
url string

WMS 服务 URL。
load function | undefined

执行图像加载的函数。接收创建的 HTMLImageElement 和所需的 src 作为参数，返回解析为已加载或已解码图像的 Promise。默认为 decode。

ServerType{'carmentaserver'} {'geoserver'} {'mapserver'} {'qgis'}

设置服务器类型，以使用 WMS 规范之外的实现特定参数。