OpenLayers

Class: WMTS

ol.source.WMTS 


import WMTS from 'ol/source/wmts';

Layer source for tile data from WMTS servers.

new ol.source.WMTS(options)

src/ol/source/wmts.js, line 24
Name Type Description
options

WMTS options.

Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
cacheSize number | undefined

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

Logo.
tileGrid ol.tilegrid.WMTS

Tile grid. Required.
projection ol.ProjectionLike

Projection.
reprojectionErrorThreshold number | undefined

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

Request encoding. Default is KVP.
layer string

Layer name as advertised in the WMTS capabilities. Required.
style string

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

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

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

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

function(imageTile, src) {
  imageTile.getImage().src = src;
};
urls Array.<string> | undefined

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

Whether to wrap the world horizontally. Default is false.
transition number | undefined

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

Extends

Methods

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

src/ol/source/wmts.js, line 313

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.
  • crossOrigin - {string|null|undefined} Cross origin. Default is undefined.
Returns:
WMTS source options object or null if the layer was not found.

changed() inherited

src/ol/observable.js, line 58

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

dispatchEvent(event) inherited

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 101

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

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

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

Get the attributions of the source.

Returns:
Attributions.

getDimensions(){Object}

src/ol/source/wmts.js, line 199

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}

src/ol/source/wmts.js, line 209

Return the image format of the WMTS source.

Returns:
Format.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:
List of property names.

getLayer(){string}

src/ol/source/wmts.js, line 219

Return the layer of the WMTS source.

Returns:
Layer.

getLogo(){string|olx.LogoOptions|undefined} inherited

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

Get the logo of the source.

Returns:
Logo.

getMatrixSet(){string}

src/ol/source/wmts.js, line 229

Return the matrix set of the WMTS source.

Returns:
MatrixSet.

getProjection(){ol.proj.Projection} inherited

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

Get the projection of the source.

Returns:
Projection.

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

src/ol/object.js, line 125

Get an object of all property names and values.

Returns:
Object.

getRequestEncoding(){ol.source.WMTSRequestEncoding}

src/ol/source/wmts.js, line 239

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

Returns:
Request encoding.

getRevision(){number} inherited

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

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

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

Returns:
State.

getStyle(){string}

src/ol/source/wmts.js, line 249

Return the style of the WMTS source.

Returns:
Style.

getTileGrid(){ol.tilegrid.TileGrid} inherited

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

Return the tile grid of the tile source.

Returns:
Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} inherited

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

Return the tile load function of the source.

Returns:
TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited

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

Return the tile URL function of the source.

Returns:
TileUrlFunction

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

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

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

Returns:
URLs.

getVersion(){string}

src/ol/source/wmts.js, line 259

Return the version of the WMTS source.

Returns:
Version.

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

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

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

set(key, value, opt_silent) inherited

src/ol/object.js, line 150

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setAttributions(attributions) inherited

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

Set the attributions of the source.

Name Type Description
attributions ol.AttributionLike | undefined

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

setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

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

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

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

Name Type Description
render boolean

Render the edges.

setTileGridForProjection(projection, tilegrid) inherited

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

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

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

Set the tile load function of the source.

Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction, opt_key) inherited

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

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 173

Set the URL to use for requests.

Name Type Description
url string

URL.

setUrls(urls) inherited

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

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.

unset(key, opt_silent) inherited

src/ol/object.js, line 184

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.

updateDimensions(dimensions)

src/ol/source/wmts.js, line 283

Update the dimensions.

Name Type Description
dimensions Object

Dimensions.