Class: ImageWMS

ol/source/ImageWMS~ImageWMS


import ImageWMS from 'ol/source/ImageWMS';

Source for WMS servers providing single, untiled images.

new ImageWMS(options)

Name Type Description
attributions AttributionLike | undefined

Attributions.

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 https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image 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.

Fires:

Extends

Methods

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event){boolean | undefined} inherited

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event BaseEvent | string

Event object.

Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

Get the attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

Returns:
Attributions are collapsible.

getFeatureInfoUrl(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 Coordinate

Coordinate.

resolution number

Resolution.

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

getImageLoadFunction(){LoadFunction}

Return the image load function of the source.

Returns:
The image load function.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

getLegendUrl(resolution, params){string | undefined}

Return the GetLegendGraphic URL, optionally optimized for the passed resolution and possibly including any passed specific parameters. Returns undefined if the GetLegendGraphic URL cannot be constructed.

Name Type Description
resolution number | undefined

Resolution. If set to undefined, SCALE will not be calculated and included in URL.

params Object | undefined

GetLegendGraphic params. If LAYER is set, the request is generated for this wms layer, else it will try to use the configured wms layer. Default FORMAT is image/png. VERSION should not be specified here.

Returns:
GetLegendGraphic URL.

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.

Returns:
Params.

getProjection(){Projection | null} inherited

Get the projection of the source.

Returns:
Projection.

getProperties(){Object.<string, *>} inherited

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

Get the state of the source, see State for possible states.

Returns:
State.

getUrl(){string | undefined}

Return the URL used for this WMS source.

Returns:
URL.

on(type, listener){EventsKey | Array<EventsKey>} inherited

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.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){EventsKey | Array<EventsKey>} inherited

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.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, silent) inherited

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean | undefined

Update without triggering an event.

setAttributions(attributions) inherited

Set the attributions of the source.

Name Type Description
attributions AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, Attribution, or undefined.

setImageLoadFunction(imageLoadFunction)

Set the image load function of the source.

Name Type Description
imageLoadFunction LoadFunction

Image load function.

setProperties(values, silent) inherited

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.

silent boolean | undefined

Update without triggering an event.

Set the URL to use for requests.

Name Type Description
url string | undefined

URL.

un(type, listener) inherited

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.

unset(key, silent) inherited

Unsets a property.

Name Type Description
key string

Key name.

silent boolean | undefined

Unset without triggering an event.

updateParams(params)

Update the user-provided params.

Name Type Description
params Object

Params.