Class: WMTS

function(imageTile, src) {
  imageTile.getImage().src = src;
};

Extends

• ol.source.TileImage

Methods

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

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

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 58

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

dispatchEvent(event) inherited experimental

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 148

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

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

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

Get the attributions of the source.

Returns:

Attributions.

getDimensions(){Object} experimental

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

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/wmts.js, line 194

Return the image format of the WMTS source.

Returns:

Format.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 162

Get a list of object property names.

Returns:

List of property names.

getLayer(){string} experimental

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

Return the layer of the WMTS source.

Returns:

Layer.

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

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

Get the logo of the source.

Returns:

Logo.

getMatrixSet(){string} experimental

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

Return the matrix set of the WMTS source.

Returns:

MatrixSet.

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

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

Get the projection of the source.

Returns:

Projection.

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

src/ol/object.js, line 172

Get an object of all property names and values.

Returns:

Object.

getRequestEncoding(){ol.source.WMTS.RequestEncoding} experimental

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

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

Returns:

Request encoding.

getRevision(){number} inherited experimental

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 experimental

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

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

Returns:

State.

getStyle(){string} experimental

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

Return the style of the WMTS source.

Returns:

Style.

getTileGrid(){ol.tilegrid.TileGrid} inherited

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

Return the tile grid of the tile source.

Returns:

Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental

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

Return the tile load function of the source.

Returns:

TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental

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

Return the tile URL function of the source.

Returns:

TileUrlFunction

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

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

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} experimental

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

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 experimental

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

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

set(key, value, opt_silent) inherited

src/ol/object.js, line 197

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean	Update without triggering an event.

setAttributions(attributions) inherited experimental

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

Set the attributions of the source.

Name	Type	Description
attributions	ol.AttributionLike | undefined	Attributions. Can be passed as string, Array<string>, ol.Attribution, Array<ol.Attribution> or undefined.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 217

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 experimental

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

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

Name	Type	Description
render	boolean	Render the edges.

setTileGridForProjection(projection, tilegrid) inherited experimental

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

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 experimental

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

Set the tile load function of the source.

Name	Type	Description
tileLoadFunction	ol.TileLoadFunctionType	Tile load function.

setTileUrlFunction(tileUrlFunction, opt_key) inherited experimental

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

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 163

Set the URL to use for requests.

Name	Type	Description
url	string	URL.

setUrls(urls) inherited

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

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.

unByKey(key) inherited

src/ol/observable.js, line 168

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	ol.EventsKey | Array.<ol.EventsKey>	The key returned by on() or once() (or an array of keys).

unset(key, opt_silent) inherited

src/ol/object.js, line 231

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean	Unset without triggering an event.

updateDimensions(dimensions) experimental

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

Update the dimensions.

Name	Type	Description
dimensions	Object	Dimensions.

Type Definitions

ol.source.WMTS.RequestEncoding{string}

Request encoding. One of 'KVP', 'REST'.