OpenLayers 3 API Documentation

Class: ImageWMS

ol.source.ImageWMS

Source for WMS servers providing single, untiled images.

new ol.source.ImageWMS(opt_options)

src/ol/source/imagewmssource.js, line 28
Name Type Description
options

Options.

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

Attributions.
crossOrigin null | string | undefined

crossOrigin setting for image requests.
hidpi boolean | undefined experimental

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

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

Logo.
params Object.<string, *>

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 ol.proj.ProjectionLike experimental

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.
Fires:
  • change - Triggered when the state of the source changes.

Extends

Methods

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:
  • change experimental

getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 96
Returns:
Attributions.

getGetFeatureInfoUrl(coordinate, resolution, projection, params){string|undefined}

src/ol/source/imagewmssource.js, line 128

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

Name Type Description
coordinate ol.Coordinate

Coordinate.
resolution number

Resolution.
projection ol.proj.ProjectionLike

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.
Returns:
GetFeatureInfo URL.
src/ol/source/source.js, line 105
Returns:
Logo.

getParams(){Object}

src/ol/source/imagewmssource.js, line 168

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

Returns:
Params.

getProjection(){ol.proj.Projection} inherited experimental

src/ol/source/source.js, line 114
Returns:
Projection.

getRevision(){number} inherited experimental

src/ol/observable.js, line 52
Returns:
Revision.

getState(){ol.source.State} inherited experimental

src/ol/source/source.js, line 129
Returns:
State.

getUrl(){string|undefined}

src/ol/source/imagewmssource.js, line 309

Return the URL used for this WMS source.

Returns:
URL.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 65

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object

The object to use as this in listener.
Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 78

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object

The object to use as this in listener.
Returns:
Unique key for the listener.

setUrl(url)

src/ol/source/imagewmssource.js, line 318
Name Type Description
url string | undefined

URL.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object

The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 101

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.

updateParams(params)

src/ol/source/imagewmssource.js, line 332

Update the user-provided params.

Name Type Description
params Object

Params.