OpenLayers 3

Class: WMTS

ol.source.WMTS

Layer source for tile data from WMTS servers.

new ol.source.WMTS(options)

src/ol/source/wmtssource.js, line 38
Name Type Description
options

WMTS options.

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

Attributions.
crossOrigin string | null | undefined experimental

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.
logo string | olx.LogoOptions | undefined experimental

Logo.
tileGrid ol.tilegrid.WMTS experimental

Tile grid.
projection ol.proj.ProjectionLike experimental

Projection.
requestEncoding ol.source.WMTSRequestEncoding | string | undefined

Request encoding. Default is KVP.
layer string

Layer name as advertised in the WMTS capabilities.
style string

Style name as advertised in the WMTS capabilities.
tileClass function | undefined experimental

Class used to instantiate image tiles. Default is ol.ImageTile.
tilePixelRatio number | undefined experimental

The pixel ratio used by the tile service. For example, if the tile service advertizes 256px by 256px tiles but actually sends 512px by 512px images (for retina/hidpi devices) then tilePixelRatio should be set to 2. Default is 1.
version string | undefined

WMTS version. Default is 1.0.0.
format string | undefined

Image format. Default is image/jpeg.
matrixSet string

Matrix set.
dimensions Object | undefined

Additional "dimensions" for tile requests. This is an object with properties named like the advertised WMTS dimensions.
url string | undefined

A URL for the service. For the RESTful request encoding, this is a URL template. For KVP encoding, it is normal URL. A {?-?} template pattern, for example subdomain{a-f}.domain.com, may be used instead of defining each one separately in the urls option.
maxZoom number | undefined experimental

Maximum zoom.
tileLoadFunction ol.TileLoadFunctionType | undefined experimental

Optional function to load a tile given a URL.
urls Array.<string> | undefined

An array of URLs. Requests will be distributed among the URLs in this array.
wrapX boolean | undefined experimental

Whether to wrap the world horizontally. Default is false.
Fires:

Extends

Methods

ol.source.WMTS.optionsFromCapabilities(wmtsCap, config){olx.source.WMTSOptions} experimental

src/ol/source/wmtssource.js, line 338

Generate source options from a capabilities object.

Name Type Description
wmtsCap Object

An object representing the capabilities document.
config Object

Configuration properties for the layer. Defaults for the layer will apply if not provided.

Required config properties: layer - {String} The layer identifier.

Optional config properties: matrixSet - {String} The matrix set identifier, required if there is more than one matrix set in the layer capabilities. projection - {String} The desired CRS when no matrixSet is specified. eg: "EPSG:3857". If the desired projection is not available, an error is thrown. requestEncoding - {String} url encoding format for the layer. Default is the first tile url format found in the GetCapabilities response. style - {String} The name of the style format - {String} Image format for the layer. Default is the first format returned in the GetCapabilities response.
Returns:
WMTS source options object.

changed() inherited experimental

src/ol/observable.js, line 51

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

get(key){*} inherited

src/ol/object.js, line 150

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

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

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

Get the attributions of the source.

Returns:
Attributions.

getDimensions(){Object} experimental

src/ol/source/wmtssource.js, line 207

Get the dimensions, i.e. those passed to the constructor through the "dimensions" option, and possibly updated using the updateDimensions method.

Returns:
Dimensions.

getFormat(){string} experimental

src/ol/source/wmtssource.js, line 217

Return the image format of the WMTS source.

Returns:
Format.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 164

Get a list of object property names.

Returns:
List of property names.

getLayer(){string} experimental

src/ol/source/wmtssource.js, line 235

Return the layer of the WMTS source.

Returns:
Layer.
src/ol/source/source.js, line 114

Get the logo of the source.

Returns:
Logo.

getMatrixSet(){string} experimental

src/ol/source/wmtssource.js, line 245

Return the matrix set of the WMTS source.

Returns:
MatrixSet.

getProjection(){ol.proj.Projection} inherited experimental

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

Get the projection of the source.

Returns:
Projection.

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

src/ol/object.js, line 174

Get an object of all property names and values.

Returns:
Object.

getRequestEncoding(){ol.source.WMTSRequestEncoding} experimental

src/ol/source/wmtssource.js, line 255

Return the request encoding, either "KVP" or "REST".

Returns:
Request encoding.

getRevision(){number} inherited experimental

src/ol/observable.js, line 70

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 140

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

Returns:
State.

getStyle(){string} experimental

src/ol/source/wmtssource.js, line 265

Return the style of the WMTS source.

Returns:
Style.

getTileGrid(){ol.tilegrid.TileGrid} inherited

src/ol/source/tilesource.js, line 187

Return the tile grid of the tile source.

Returns:
Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental

src/ol/source/tileimagesource.js, line 120

Return the tile load function of the source.

Returns:
TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental

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

Return the tile URL function of the source.

Returns:
TileUrlFunction

getUrls(){Array.<string>} experimental

src/ol/source/wmtssource.js, line 275

Return the URLs used for this WMTS source.

Returns:
URLs.

getVersion(){string} experimental

src/ol/source/wmtssource.js, line 285

Return the version of the WMTS source.

Returns:
Version.

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

src/ol/observable.js, line 83

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 96

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

src/ol/object.js, line 203

Sets a value.

Name Type Description
key string

Key name.
value *

Value.

setAttributions(attributions) inherited experimental

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

Set the attributions of the source.

Name Type Description
attributions Array.<ol.Attribution>

Attributions.

setProperties(values) inherited

src/ol/object.js, line 216

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.

setTileLoadFunction(tileLoadFunction) inherited experimental

src/ol/source/tileimagesource.js, line 164

Set the tile load function of the source.

Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction) inherited experimental

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

Set the tile URL function of the source.

Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 109

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 122

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

unset(key) inherited

src/ol/object.js, line 229

Unsets a property.

Name Type Description
key string

Key name.

updateDimensions(dimensions) experimental

src/ol/source/wmtssource.js, line 308

Update the dimensions.

Name Type Description
dimensions Object

Dimensions.