OpenLayers 3

Class: TileWMS

ol.source.TileWMS

Layer source for tile data from WMS servers.

new ol.source.TileWMS(opt_options)

src/ol/source/tilewms.js, line 29
Name Type Description
options

Tile WMS options.

Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
cacheSize number | undefined experimental

Cache size. Default is 2048.
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. Required.
crossOrigin null | string | undefined

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or 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.
gutter number | undefined

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. Defaults to zero. 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 | undefined experimental

Use the ol.Map#pixelRatio value when requesting the image from the remote server. Default is true.
logo string | olx.LogoOptions | undefined

Logo.
tileGrid ol.tilegrid.TileGrid | undefined

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

Projection.
reprojectionErrorThreshold number | undefined experimental

Maximum allowed reprojection error (in pixels). Default is 0.5. Higher values can increase reprojection performance, but decrease precision.
serverType ol.source.WMSServerType | string | undefined experimental

The type of the remote WMS server. Currently only used when hidpi is true. Default is undefined.
tileLoadFunction ol.TileLoadFunctionType | undefined experimental

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

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

WMS service URL.
urls Array.<string> | undefined

WMS service urls. Use this instead of url when the WMS supports multiple urls for GetMap requests.
wrapX boolean | undefined experimental

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. The default is true.
Fires:

Extends

Methods

changed() inherited experimental

src/ol/observable.js, line 58

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

dispatchEvent(event) inherited experimental

src/ol/observable.js, line 75

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 | ol.events.Event | string

Event object.

get(key){*} inherited

src/ol/object.js, line 148

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

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

src/ol/source/source.js, line 111

Get the attributions of the source.

Returns:
Attributions.

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

src/ol/source/tilewms.js, line 117

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

src/ol/object.js, line 162

Get a list of object property names.

Returns:
List of property names.
src/ol/source/source.js, line 121

Get the logo of the source.

Returns:
Logo.

getParams(){Object}

src/ol/source/tilewms.js, line 191

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 131

Get the projection of the source.

Returns:
Projection.

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

src/ol/object.js, line 172

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 84

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

Returns:
Revision.

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

src/ol/source/source.js, line 148

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

Returns:
State.

getTileGrid(){ol.tilegrid.TileGrid} inherited

src/ol/source/tile.js, line 210

Return the tile grid of the tile source.

Returns:
Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental

src/ol/source/urltile.js, line 77

Return the tile load function of the source.

Returns:
TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental

src/ol/source/urltile.js, line 87

Return the tile URL function of the source.

Returns:
TileUrlFunction

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

src/ol/source/urltile.js, line 99

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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

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. If called with an array of event types as the first argument, the return will be an array of keys.

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

src/ol/observable.js, line 124

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. If called with an array of event types as the first argument, the return will be an array of keys.

refresh() inherited experimental

src/ol/source/source.js, line 165

Refreshes the source and finally dispatches a 'change' event.

set(key, value, opt_silent) inherited

src/ol/object.js, line 197

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setAttributions(attributions) inherited experimental

src/ol/source/source.js, line 177

Set the attributions of the source.

Name Type Description
attributions ol.AttributionLike | undefined

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

setProperties(values, opt_silent) inherited

src/ol/object.js, line 217

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 experimental

src/ol/source/tileimage.js, line 327

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

Name Type Description
render boolean

Render the edges.

setTileGridForProjection(projection, tilegrid) inherited experimental

src/ol/source/tileimage.js, line 352

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

Projection.
tilegrid ol.tilegrid.TileGrid

Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited experimental

src/ol/source/urltile.js, line 135

Set the tile load function of the source.

Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction, opt_key) inherited experimental

src/ol/source/urltile.js, line 148

Set the tile URL function of the source.

Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.
key string

Optional new tile key for the source.

setUrl(url) inherited

src/ol/source/urltile.js, line 163

Set the URL to use for requests.

Name Type Description
url string

URL.

setUrls(urls) inherited

src/ol/source/urltile.js, line 176

Set the URLs to use for requests.

Name Type Description
urls Array.<string>

URLs.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

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 168

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key ol.EventsKey | Array.<ol.EventsKey>

The key returned by on() or once() (or an array of keys).

unset(key, opt_silent) inherited

src/ol/object.js, line 231

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.

updateParams(params)

src/ol/source/tilewms.js, line 372

Update the user-provided params.

Name Type Description
params Object

Params.