Class: WMTS

ol/source/WMTS~WMTS 


import WMTS from 'ol/source/WMTS';

Layer source for tile data from WMTS servers.

new WMTS(options)

source/WMTS.js, line 73
Name Type Description
options

WMTS options.

Name Type Description
attributions module:ol/source/Source~AttributionLike | undefined

Attributions.
attributionsCollapsible boolean (defaults to true)

Attributions are collapsible.
cacheSize number | undefined

Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
crossOrigin null | string | undefined

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value 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.
imageSmoothing boolean (defaults to true)

Deprecated. Use the interpolate option instead.
interpolate boolean (defaults to true)

Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
tileGrid module:ol/tilegrid/WMTS~WMTSTileGrid

Tile grid.
projection module:ol/proj~ProjectionLike | undefined

Projection. Default is the view projection.
reprojectionErrorThreshold number (defaults to 0.5)

Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
requestEncoding module:ol/source/WMTS~RequestEncoding (defaults to 'KVP')

Request encoding.
layer string

Layer name as advertised in the WMTS capabilities.
style string

Style name as advertised in the WMTS capabilities.
tileClass Class.<module:ol/ImageTile~ImageTile> | undefined

Class used to instantiate image tiles. Default is module:ol/ImageTile~ImageTile.
tilePixelRatio number (defaults to 1)

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.
format string (defaults to 'image/jpeg')

Image format. Only used when requestEncoding is 'KVP'.
version string (defaults to '1.0.0')

WMTS version.
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.
tileLoadFunction module:ol/Tile~LoadFunction | 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 (defaults to false)

Whether to wrap the world horizontally.
transition number | undefined

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.
zDirection number | module:ol/array~NearestDirectionFunction (defaults to 0)

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See module:ol/tilegrid/TileGrid~TileGrid#getZForResolution.
Fires:

Extends

Methods

changed() inherited

Observable.js, line 68

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

clear() inherited

source/Tile.js, line 343

Remove all cached tiles from the source. The next render cycle will fetch new tiles.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

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 module:ol/events/Event~BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getAttributions(){module:ol/source/Source~Attribution} inherited

source/Source.js, line 133

Get the attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 141
Returns:
Attributions are collapsible.

getDimensions(){Object}

source/WMTS.js, line 194

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}

source/WMTS.js, line 203

Return the image format of the WMTS source.

Returns:
Format.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

getLayer(){string}

source/WMTS.js, line 212

Return the layer of the WMTS source.

Returns:
Layer.

getMatrixSet(){string}

source/WMTS.js, line 221

Return the matrix set of the WMTS source.

Returns:
MatrixSet.

getProjection(){module:ol/proj/Projection~Projection|null} inherited

source/Source.js, line 150

Get the projection of the source.

Returns:
Projection.

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

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRequestEncoding(){module:ol/source/WMTS~RequestEncoding}

source/WMTS.js, line 230

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

Returns:
Request encoding.

getRevision(){number} inherited

Observable.js, line 79

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

Returns:
Revision.

getState(){module:ol/source/Source~State} inherited

source/Source.js, line 174

Get the state of the source, see module:ol/source/Source~State for possible states.

Returns:
State.

getStyle(){string}

source/WMTS.js, line 239

Return the style of the WMTS source.

Returns:
Style.

getTileGrid(){module:ol/tilegrid/TileGrid~TileGrid|null} inherited

source/Tile.js, line 262

Return the tile grid of the tile source.

Returns:
Tile grid.

getTileLoadFunction(){module:ol/Tile~LoadFunction} inherited

source/UrlTile.js, line 101

Return the tile load function of the source.

Returns:
TileLoadFunction

getTileUrlFunction(){module:ol/Tile~UrlFunction} inherited

source/UrlTile.js, line 110

Return the tile URL function of the source.

Returns:
TileUrlFunction

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

source/UrlTile.js, line 123

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}

source/WMTS.js, line 248

Return the version of the WMTS source.

Returns:
Version.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 153

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.
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){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 165

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

source/Source.js, line 196

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, opt_silent) inherited

Object.js, line 207

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean | undefined

Update without triggering an event.

setAttributions(attributions) inherited

source/Source.js, line 207

Set the attributions of the source.

Name Type Description
attributions module:ol/source/Source~AttributionLike | undefined

Attributions. Can be passed as string, Array<string>, module:ol/source/Source~Attribution, or undefined.

setProperties(values, opt_silent) inherited

Object.js, line 227

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

Update without triggering an event.

setRenderReprojectionEdges(render) inherited

source/TileImage.js, line 423

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

Name Type Description
render boolean

Render the edges.

setTileGridForProjection(projection, tilegrid) inherited

source/TileImage.js, line 449

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 module:ol/proj~ProjectionLike

Projection.
tilegrid module:ol/tilegrid/TileGrid~TileGrid

Tile grid to use for the projection.

setTileLoadFunction(tileLoadFunction) inherited

source/UrlTile.js, line 159

Set the tile load function of the source.

Name Type Description
tileLoadFunction module:ol/Tile~LoadFunction

Tile load function.

setTileUrlFunction(tileUrlFunction, key) inherited

source/UrlTile.js, line 171

Set the tile URL function of the source.

Name Type Description
tileUrlFunction module:ol/Tile~UrlFunction

Tile URL function.
key string | undefined

Optional new tile key for the source.

setUrl(url) inherited

source/UrlTile.js, line 186

Set the URL to use for requests.

Name Type Description
url string

URL.

un(type, listener) inherited

Observable.js, line 174

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.

unset(key, opt_silent) inherited

Object.js, line 251

Unsets a property.

Name Type Description
key string

Key name.
silent boolean | undefined

Unset without triggering an event.

updateDimensions(dimensions)

source/WMTS.js, line 270

Update the dimensions.

Name Type Description
dimensions Object

Dimensions.