OpenLayers

Class: TileWMS

ol/source/TileWMS~TileWMS 


import TileWMS from 'ol/source/TileWMS';

Layer source for tile data from WMS servers.

new TileWMS(opt_options)

source/TileWMS.js, line 82
Name Type Description
options

Tile WMS options.

Name Type Description
attributions module:ol/source/Source~AttributionLike

Attributions.
cacheSize number

Tile cache size. The default depends on the screen size. Will increase if too small.
crossOrigin null | string

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.
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.
gutter number (defaults to 0)

The size in pixels of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. Using a non-zero value allows artifacts of rendering at tile edges to be ignored. If you control the WMS service it is recommended to address "artifacts at tile edges" issues by properly configuring the WMS service. For example, MapServer has a tile_map_edge_buffer configuration parameter for this. See http://mapserver.org/output/tile_mode.html.
hidpi boolean (defaults to true)

Use the ol/Map#pixelRatio value when requesting the image from the remote server.
projection module:ol/proj~ProjectionLike

Projection. Default is the view projection.
reprojectionErrorThreshold number (defaults to 0.5)

Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
tileClass Class.<module:ol/ImageTile~ImageTile>

Class used to instantiate image tiles. Default is module:ol/ImageTile~ImageTile.
tileGrid module:ol/tilegrid/TileGrid~TileGrid

Tile grid. Base this on the resolutions, tilesize and extent supported by the server. If this is not defined, a default grid will be used: if there is a projection extent, the grid will be based on that; if not, a grid based on a global extent with origin at 0,0 will be used..
serverType module:ol/source/WMSServerType | string

The type of the remote WMS server. Currently only used when hidpi is true.
tileLoadFunction module:ol/Tile~LoadFunction

Optional function to load a tile given a URL. The default is

function(imageTile, src) {
  imageTile.getImage().src = src;
};
url string

WMS service URL.
urls Array.<string>

WMS service urls. Use this instead of url when the WMS supports multiple urls for GetMap requests.
wrapX boolean (defaults to true)

Whether to wrap the world horizontally. When set to false, only one world will be rendered. When true, tiles will be requested for one world only, but they will be wrapped horizontally to render multiple worlds.
transition number

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.
Fires:

Extends

Methods

changed() inherited

Observable.js, line 36

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

clear() inherited

source/Tile.js, line 316

Remove all cached tiles from the source. The next render cycle will fetch new tiles.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 96

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 Object | module:ol/events/Event~BaseEvent | string

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

get(key){*} inherited

Object.js, line 119

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

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

source/TileWMS.js, line 162

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

Name Type Description
coordinate module:ol/coordinate~Coordinate

Coordinate.
resolution number

Resolution.
projection module: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.

getKeys(){Array.<string>} inherited

Object.js, line 132

Get a list of object property names.

Returns:
List of property names.

getLegendUrl(resolution, params){string|undefined}

source/TileWMS.js, line 229

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

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

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}

source/TileWMS.js, line 275

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(){module:ol/proj/Projection~Projection} inherited

source/Source.js, line 119

Get the projection of the source.

Returns:
Projection.

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

Object.js, line 141

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 47

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

Returns:
Revision.

getState(){module:ol/source/State} inherited

source/Source.js, line 136

Get the state of the source, see module:ol/source/State~State for possible states.

Returns:
State.

getTileGrid(){module:ol/tilegrid/TileGrid~TileGrid} inherited

source/Tile.js, line 235

Return the tile grid of the tile source.

Returns:
Tile grid.

getTileLoadFunction(){module:ol/Tile~LoadFunction} inherited

source/UrlTile.js, line 102

Return the tile load function of the source.

Returns:
TileLoadFunction

getTileUrlFunction(){module:ol/Tile~UrlFunction} inherited

source/UrlTile.js, line 111

Return the tile URL function of the source.

Returns:
TileUrlFunction

getUrls(){!Array.<string>|null} inherited

source/UrlTile.js, line 122

Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

Returns:
URLs.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 60

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){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 82

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.

set(key, value, opt_silent) inherited

Object.js, line 164

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setAttributions(attributions) inherited

source/Source.js, line 162

Set the attributions of the source.

Name Type Description
attributions module:ol/source/Source~AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, module:ol/source/Source~Attribution, or undefined.

setProperties(values, opt_silent) inherited

Object.js, line 183

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

Update without triggering an event.

setRenderReprojectionEdges(render) inherited

source/TileImage.js, line 358

Sets whether to render reprojection edges or not (usually for debugging).

Name Type Description
render boolean

Render the edges.

setTileGridForProjection(projection, tilegrid) inherited

source/TileImage.js, line 382

Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

Name Type Description
projection module:ol/proj~ProjectionLike

Projection.
tilegrid module:ol/tilegrid/TileGrid~TileGrid

Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited

source/UrlTile.js, line 155

Set the tile load function of the source.

Name Type Description
tileLoadFunction module:ol/Tile~LoadFunction

Tile load function.

setTileUrlFunction(tileUrlFunction, key) inherited

source/UrlTile.js, line 167

Set the tile URL function of the source.

Name Type Description
tileUrlFunction module:ol/Tile~UrlFunction

Tile URL function.
key string

Optional new tile key for the source.

setUrl(url) inherited

source/UrlTile.js, line 182

Set the URL to use for requests.

Name Type Description
url string

URL.

setUrls(urls) inherited

source/UrlTile.js, line 193

Set the URLs to use for requests.

Name Type Description
urls Array.<string>

URLs.

un(type, listener) inherited

Observable.js, line 101

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, opt_silent) inherited

Object.js, line 195

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.

updateParams(params)

source/TileWMS.js, line 377

Update the user-provided params.

Name Type Description
params Object

Params.