OpenLayers 3 API Documentation

Class: TileWMS

ol.source. TileWMS

experimental new ol.source.TileWMS(opt_options)

src/ol/source/tilewmssource.js, line 29
Name Type Argument Description
options optional

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

crossOrigin setting for image requests.
extent ol.Extent | undefined

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

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

Logo.
tileGrid ol.tilegrid.TileGrid | undefined

Tile grid.
maxZoom number | undefined

Maximum zoom.
projection ol.proj.ProjectionLike

Projection.
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.
tileLoadFunction ol.TileLoadFunctionType | undefined

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:
  • change

Extends

Methods

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

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}

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

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}

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

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

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

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

experimental inherited getTileGrid(){ol.tilegrid.TileGrid}

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

experimental getUrls(){Array.<string>|undefined}

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

Return the URLs used for this WMS source.

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

src/ol/observable.js, line 61

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}

src/ol/observable.js, line 74

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 inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

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)

src/ol/observable.js, line 96

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

Name Type Description
key goog.events.Key

Key.

experimental updateParams(params)

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

Update the user-provided params.

Name Type Description
params Object

Params.