Class: ImageWMS

ol.source. ImageWMS

experimental new ol.source.ImageWMS(opt_options)

Name Type Argument Description
options optional

Options.

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. 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

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

Extends

Methods

experimental inherited dispatchChangeEvent()

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:
  • change

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

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.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.

Returns:
URL.

experimental getParams(){Object}

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

experimental getUrl(){string|undefined}

Return the URL used for this WMS source.

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

Listen for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>
optional

The object to use as this in listener.

Returns:
key for the listener.

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

Listen once for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>
optional

The object to use as this in listener.

Returns:
key for the listener.

experimental setUrl(url)

Name Type Description
url string | undefined

URL.

experimental inherited un(type, listener, opt_this)

Unlisten for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>
optional

The object to use as this in listener.

experimental inherited unByKey(key)

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

Name Type Description
key goog.events.Key

Key.

experimental updateParams(params)

Update the user-provided params.

Name Type Description
params Object

Params.