OpenLayers 3 API Documentation

Class: TileWMS

ol.source.TileWMS

Layer source for tile data from WMS servers.

new ol.source.TileWMS(opt_options)

src/ol/source/tilewmssource.js, line 34
Name Type Description
options

Tile WMS options.

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

Attributions.
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.
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.
maxZoom number | undefined experimental

Maximum zoom.
projection ol.proj.ProjectionLike experimental

Projection.
serverType ol.source.wms.ServerType | 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.
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.
Fires:

Extends

Methods

bindTo(key, target, opt_targetKey){ol.ObjectAccessor} inherited experimental

src/ol/object.js, line 326

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an object with a transform method that you can use to provide from and to functions to transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );
Name Type Description
key string

Key name.
target ol.Object

Target.
targetKey string

Target key.

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:
  • change experimental

get(key){*} inherited experimental

src/ol/object.js, line 354

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

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

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

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

src/ol/source/tilewmssource.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.

getKeys(){Array.<string>} inherited experimental

src/ol/object.js, line 373

Get a list of object property names.

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

getParams(){Object}

src/ol/source/tilewmssource.js, line 201

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.

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

src/ol/object.js, line 405

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

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

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

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

getTileGrid(){ol.tilegrid.TileGrid} inherited

src/ol/source/tilesource.js, line 175
Returns:
Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental

src/ol/source/tileimagesource.js, line 114
Returns:
TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental

src/ol/source/tileimagesource.js, line 123
Returns:
TileUrlFunction

getUrls(){Array.<string>}

src/ol/source/tilewmssource.js, line 301

Return the URLs used for this WMS source.

Returns:
URLs.

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

src/ol/observable.js, line 75

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 88

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.

set(key, value) inherited experimental

src/ol/object.js, line 437

Sets a value.

Name Type Description
key string

Key name.
value *

Value.

setProperties(values) inherited experimental

src/ol/object.js, line 456

Sets a collection of key-value pairs.

Name Type Description
values Object.<string, *>

Values.

setTileLoadFunction(tileLoadFunction) inherited experimental

src/ol/source/tileimagesource.js, line 156
Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction) inherited experimental

src/ol/source/tileimagesource.js, line 167
Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.

setUrl(url)

src/ol/source/tilewmssource.js, line 331
Name Type Description
url string | undefined

URL.

setUrls(urls)

src/ol/source/tilewmssource.js, line 341
Name Type Description
urls Array.<string> | undefined

URLs.

un(type, listener, opt_this) inherited

src/ol/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.
this Object

The object which was used as this by the listener.

unbind(key) inherited experimental

src/ol/object.js, line 470

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name Type Description
key string

Key name.

unbindAll() inherited experimental

src/ol/object.js, line 487

Removes all bindings.

unByKey(key) inherited

src/ol/observable.js, line 114

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 goog.events.Key

The key returned by on() or once().

updateParams(params)

src/ol/source/tilewmssource.js, line 405

Update the user-provided params.

Name Type Description
params Object

Params.