模块：ol/source/wms

ol/source/wms


函数

createLoader(options){ImageObjectPromiseLoader}

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

创建WMS图像的加载器。

Name Type 描述
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从远程服务器请求图像时的值。
params Object.<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，该Promise解析为已加载或已解码的图像。默认为decode.
返回：
加载器。

getFeatureInfoUrl(options, coordinate, resolution){string | undefined}

source/wms.js, line 201 
import {getFeatureInfoUrl} from 'ol/source/wms';

为传入的坐标和分辨率生成 GetFeatureInfo URL；如果无法生成，则返回 undefined。

Name Type 描述
options LoaderOptions

传入的选项createWMSLoader()函数。除加载器所需参数外，INFO_FORMAT必须指定，默认为application/json如果QUERY_LAYERS若未提供，则使用指定的图层。LAYERS参数将被使用。
coordinate Coordinate

坐标。
resolution number

分辨率.
options.crossOrigin null | string | undefined

crossOrigin 表示已加载图像的属性。请注意，您必须提供 crossOrigin。若需通过 Canvas 渲染器访问像素数据，请使用此值。参见文档（https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image）了解更多详情。
options.hidpi boolean (defaults to true)

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

WMS请求参数。至少一个。LAYERS参数为必填项。STYLES是''默认情况下。VERSION是1.3.0默认。WIDTH, HEIGHT和BBOX将被动态设置。CRS (SRS对于 WMS 版本 < 1.3.0，将源自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.
返回：
要素查询 URL。

getLegendUrl(options, resolution){string | undefined}

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

获取 GetLegendGraphic URL，可针对传入的分辨率进行优化，并可能包含任意传入的特定参数。若无法生成 GetLegendGraphic URL，则返回 undefined。

Name Type 描述
options LoaderOptions

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

分辨率。如果未提供，SCALE不会计入URL。
options.crossOrigin null | string | undefined

crossOrigin 表示已加载图像的属性。请注意，您必须提供 crossOrigin；若需使用 Canvas 渲染器访问像素数据，请使用此值。请参见文档（https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image）以获取更多详情。
options.hidpi boolean (defaults to true)

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

WMS 请求参数。至少一个LAYERS参数是必填的。STYLES是''默认情况下。VERSION是1.3.0默认情况下。WIDTH, HEIGHT和BBOX将被动态设置。CRS (SRS对于WMS版本小于1.3.0，将派生自该。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，该Promise解析为加载或解码的图像。默认为decode.
返回：
图例图形URL

类型定义

LoaderOptions{Object}

属性:
Name Type 描述
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在从远程服务器请求图像时的值。
params Object.<string, *> | undefined

WMS 请求参数。至少一个LAYERS参数为必填项。STYLES是''默认情况下。VERSION是1.3.0默认情况下。WIDTH, HEIGHT和BBOX将被动态设置。CRS (SRS对于WMS版本低于1.3.0，将派生自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，该Promise解析为加载或解码后的图像。默认为decode.

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

将服务器类型设置为使用超出WMS规范的实现特定参数。

  • 'carmentaserver': 地图（Carmenta Server）的 HiDPI 支持
  • 'geoserver': 地理服务器（GeoServer）的高DPI支持
  • 'mapserver': 地图服务器的高DPI支持（MapServer）
  • 'qgis': QGIS（QGIS）的 HiDPI 支持