OpenLayers v6.6.1 API - Module: ol/source/WMTS

Module: ol/source/WMTS

ol/source/WMTS

Classes

WMTS

Methods

module:ol/source/WMTS.optionsFromCapabilities(wmtsCap, config){module:ol/source/WMTS~Options} source/WMTS.js, line 365

import {optionsFromCapabilities} from 'ol/source/WMTS';

Generate source options from a capabilities object.

Name Type Description

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

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.

Type Definitions

Options{Object}

Properties:

Name	Type	Argument	Default	Description
`attributions`	module:ol/source/Source~AttributionLike	<optional>		Attributions.
`attributionsCollapsible`	boolean	<optional>	true	Attributions are collapsible.
`cacheSize`	number	<optional>		Initial tile cache size. Will auto-grow to hold at least the number of tiles in the viewport.
`crossOrigin`	null \| string	<optional>		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	<optional>	true	Enable image smoothing.
`tileGrid`	module:ol/tilegrid/WMTS~WMTSTileGrid			Tile grid.
`projection`	module:ol/proj~ProjectionLike	<optional>		Projection. Default is the view projection.
`reprojectionErrorThreshold`	number	<optional>	0.5	Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
`requestEncoding`	module:ol/source/WMTSRequestEncoding \| string	<optional>	'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>	<optional>		Class used to instantiate image tiles. Default is `module:ol/ImageTile~ImageTile`.
`tilePixelRatio`	number	<optional>	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	<optional>	'image/jpeg'	Image format. Only used when `requestEncoding` is `'KVP'`.
`version`	string	<optional>	'1.0.0'	WMTS version.
`matrixSet`	string			Matrix set.
`dimensions`	Object	<optional>		Additional "dimensions" for tile requests. This is an object with properties named like the advertised WMTS dimensions.
`url`	string	<optional>		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	<optional>		Optional function to load a tile given a URL. The default is `function(imageTile, src) { imageTile.getImage().src = src; };`
`urls`	Array.<string>	<optional>		An array of URLs. Requests will be distributed among the URLs in this array.
`wrapX`	boolean	<optional>	false	Whether to wrap the world horizontally.
`transition`	number	<optional>		Duration of the opacity transition for rendering. To disable the opacity transition, pass `transition: 0`.
`zDirection`	number \| module:ol/array~NearestDirectionFunction	<optional>	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`.