Module: ol/source/ImageWMS




Type Definitions


Name Type Description
attributions AttributionLike | undefined


crossOrigin null | string | undefined

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you want to access pixel data with the Canvas renderer. See for more detail.

hidpi boolean
(defaults to true)

Use the ol/Map#pixelRatio value when requesting the image from the remote server.

serverType ServerType | undefined

The type of the remote WMS server: mapserver, geoserver, carmentaserver, or qgis. Only needed if hidpi is true.

imageLoadFunction LoadFunction | undefined

Optional function to load an image given a URL.

interpolate boolean
(defaults to true)

Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.

params Object.<string, *> | undefined

WMS request parameters. At least a LAYERS param is required. STYLES is '' by default. VERSION is 1.3.0 by default. WIDTH, HEIGHT, BBOX and CRS (SRS for WMS version < 1.3.0) will be set dynamically.

projection ProjectionLike | undefined

Projection. Default is the view projection.

ratio number
(defaults to 1.5)

Ratio. 1 means image requests are the size of the map viewport, 2 means twice the width and height of the map viewport, and so on. Must be 1 or higher.

resolutions Array.<number> | undefined

Resolutions. If specified, requests will be made for these resolutions only.

url string | undefined

WMS service URL.