OpenLayers 3

ol.source. ol.source.ImageWMS

new ImageWMS

Stability: experimental
Parameters:
Name Type Argument Description
options olx.source.ImageWMSOptions <optional>

Options.

Properties
Name Type Description
attributions Array.<ol.Attribution> | undefined

Attributions.
crossOrigin null | string | undefined

crossOrigin setting for image requests.
extent ol.Extent | undefined

Extent.
hidpi boolean | undefined

Use the ol.Map#pixelRatio value when requesting the image from the remote server. Default is true.
serverType ol.source.wms.ServerType | string | undefined

The type of the remote WMS server: mapserver, geoserver or qgis. Only needed if hidpi is true. Default is undefined.
logo string | undefined

Logo.
params Object.<string, *>

WMS request parameters. At least a LAYERS param is required. STYLES is ` by default.VERSIONis1.3.0by default.WIDTH,HEIGHT,BBOXandCRS(SRS` for WMS version < 1.3.0) will be set dynamically.
projection ol.proj.ProjectionLike

Projection.
ratio number | undefined

Ratio. 1 means image requests are the size of the map viewport, 2 means twice the size of the map viewport, and so on. Default is 1.5.
resolutions Array.<number> | undefined

Resolutions. If specified, requests will be made for these resolutions only.
url string | undefined

WMS service URL.
Source:
  • imagewmssource.js, line 25

Extends

  • ol.source.Image

Methods

getGetFeatureInfoUrl

Stability: experimental

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

Parameters:
Name Type Description
coordinate ol.Coordinate

Coordinate.
resolution number

Resolution.
projection ol.proj.Projection

Projection.
params Object

GetFeatureInfo params. INFO_FORMAT at least should be provided. If QUERY_LAYERS is not provided then the layers specified in the LAYERS parameter will be used. VERSION should not be specified here.
Source:
  • imagewmssource.js, line 130
Returns:

GetFeatureInfo URL.

Type
string | undefined

getParams

Stability: experimental

Get the user-provided params, i.e. those passed to the constructor through the "params" option, and possibly updated using the updateParams method.

Source:
  • imagewmssource.js, line 180
Returns:

Params.

Type
Object

getUrl

Stability: experimental

Return the URL used for this WMS source.

Source:
  • imagewmssource.js, line 323
Returns:

URL.

Type
string | undefined

setUrl

Stability: experimental
Parameters:
Name Type Description
url string | undefined

URL.
Source:
  • imagewmssource.js, line 332

updateParams

Stability: experimental

Update the user-provided params.

Parameters:
Name Type Description
params Object

Params.
Source:
  • imagewmssource.js, line 346