Module: ol/tilegrid/WMTS

Classes

WMTSTileGrid

Methods

module:ol/tilegrid/WMTS.createFromCapabilitiesMatrixSet(matrixSet, opt_extent, opt_matrixLimits){module:ol/tilegrid/WMTS~WMTSTileGrid}

tilegrid/WMTS.js, line 108

Create a tile grid from a WMTS capabilities matrix set and an optional TileMatrixSetLimits.

Name	Type	Description
matrixSet	Object	An object representing a matrixSet in the capabilities document.
extent	module:ol/extent~Extent	An optional extent to restrict the tile ranges the server provides.
matrixLimits	Array.<Object>	An optional object representing the available matrices for tileGrid.

Returns:

WMTS tileGrid instance.

Type Definitions

Options{Object}

Properties:

Name	Type	Argument	Description
extent	module:ol/extent~Extent	<optional>	Extent for the tile grid. No tiles outside this extent will be requested by module:ol/source/Tile sources. When no origin or origins are configured, the origin will be set to the top-left corner of the extent.
origin	module:ol/coordinate~Coordinate	<optional>	The tile grid origin, i.e. where the x and y axes meet ([z, 0, 0]). Tile coordinates increase left to right and upwards. If not specified, extent or origins must be provided.
origins	Array.<module:ol/coordinate~Coordinate>	<optional>	Tile grid origins, i.e. where the x and y axes meet ([z, 0, 0]), for each zoom level. If given, the array length should match the length of the resolutions array, i.e. each resolution can have a different origin. Tile coordinates increase left to right and upwards. If not specified, extent or origin must be provided.
resolutions	Array.<number>		Resolutions. The array index of each resolution needs to match the zoom level. This means that even if a minZoom is configured, the resolutions array will have a length of maxZoom + 1
matrixIds	Array.<string>		matrix IDs. The length of this array needs to match the length of the resolutions array.
sizes	Array.<module:ol/size~Size>	<optional>	Number of tile rows and columns of the grid for each zoom level. The values here are the TileMatrixWidth and TileMatrixHeight advertised in the GetCapabilities response of the WMTS, and define the grid's extent together with the origin. An extent can be configured in addition, and will further limit the extent for which tile requests are made by sources. Note that when the top-left corner of the extent is used as origin or origins, then the y value must be negative because OpenLayers tile coordinates increase upwards.
tileSize	number | module:ol/size~Size	<optional>	Tile size.
tileSizes	Array.<module:ol/size~Size>	<optional>	Tile sizes. The length of this array needs to match the length of the resolutions array.
widths	Array.<number>	<optional>	Number of tile columns that cover the grid's extent for each zoom level. Only required when used with a source that has wrapX set to true, and only when the grid's origin differs from the one of the projection's extent. The array length has to match the length of the resolutions array, i.e. each resolution will have a matching entry here.