OpenLayers 3

Class: WMTS

ol.tilegrid.WMTS

Set the grid pattern for sources accessing WMTS tiled-image servers.

new ol.tilegrid.WMTS(options) experimental

src/ol/tilegrid/wmts.js, line 18
Name Type Description
options

WMTS options.

Name Type Description
extent ol.Extent | undefined experimental

Extent for the tile grid. No tiles outside this extent will be requested by 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 ol.Coordinate | undefined

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.<ol.Coordinate> | undefined

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

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 Required.
matrixIds Array.<string> experimental

matrix IDs. The length of this array needs to match the length of the resolutions array. Required.
sizes Array.<ol.Size> | undefined experimental

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 | ol.Size | undefined experimental

Tile size.
tileSizes Array.<(number|ol.Size)> | undefined experimental

Tile sizes. The length of this array needs to match the length of the resolutions array.
widths Array.<number> | undefined experimental

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.

Extends

Methods

ol.tilegrid.WMTS.createFromCapabilitiesMatrixSet(matrixSet, opt_extent){ol.tilegrid.WMTS} experimental

src/ol/tilegrid/wmts.js, line 76

Create a tile grid from a WMTS capabilities matrix set.

Name Type Description
matrixSet Object

An object representing a matrixSet in the capabilities document.
extent ol.Extent

An optional extent to restrict the tile ranges the server provides.
Returns:
WMTS tileGrid instance.

forEachTileCoord(extent, zoom, callback) inherited experimental

src/ol/tilegrid/tilegrid.js, line 149

Call a function with each tile coordinate for a given extent and zoom level.

Name Type Description
extent ol.Extent

Extent.
zoom number

Zoom level.
callback function

Function called with each tile coordinate.

getMatrixIds(){Array.<string>} experimental

src/ol/tilegrid/wmts.js, line 62

Get the list of matrix identifiers.

Returns:
MatrixIds.

getMaxZoom(){number} inherited experimental

src/ol/tilegrid/tilegrid.js, line 196

Get the maximum zoom level for the grid.

Returns:
Max zoom.

getMinZoom(){number} inherited experimental

src/ol/tilegrid/tilegrid.js, line 206

Get the minimum zoom level for the grid.

Returns:
Min zoom.

getOrigin(z){ol.Coordinate} inherited

src/ol/tilegrid/tilegrid.js, line 217

Get the origin for the grid at the given zoom level.

Name Type Description
z number

Z.
Returns:
Origin.

getResolution(z){number} inherited

src/ol/tilegrid/tilegrid.js, line 235

Get the resolution for the given zoom level.

Name Type Description
z number

Z.
Returns:
Resolution.

getResolutions(){Array.<number>} inherited

src/ol/tilegrid/tilegrid.js, line 248

Get the list of resolutions for the tile grid.

Returns:
Resolutions.

getTileCoordExtent(tileCoord, opt_extent){ol.Extent} inherited experimental

src/ol/tilegrid/tilegrid.js, line 343

Get the extent of a tile coordinate.

Name Type Description
tileCoord ol.TileCoord

Tile coordinate.
extent ol.Extent

Temporary extent object.
Returns:
Extent.

getTileCoordForCoordAndResolution(coordinate, resolution, opt_tileCoord){ol.TileCoord} inherited experimental

src/ol/tilegrid/tilegrid.js, line 366

Get the tile coordinate for the given map coordinate and resolution. This method considers that coordinates that intersect tile boundaries should be assigned the higher tile coordinate.

Name Type Description
coordinate ol.Coordinate

Coordinate.
resolution number

Resolution.
tileCoord ol.TileCoord

Destination ol.TileCoord object.
Returns:
Tile coordinate.

getTileCoordForCoordAndZ(coordinate, z, opt_tileCoord){ol.TileCoord} inherited experimental

src/ol/tilegrid/tilegrid.js, line 417

Get a tile coordinate given a map coordinate and zoom level.

Name Type Description
coordinate ol.Coordinate

Coordinate.
z number

Zoom level.
tileCoord ol.TileCoord

Destination ol.TileCoord object.
Returns:
Tile coordinate.

getTileSize(z){number|ol.Size} inherited

src/ol/tilegrid/tilegrid.js, line 445

Get the tile size for a zoom level. The type of the return value matches the tileSize or tileSizes that the tile grid was configured with. To always get an ol.Size, run the result through ol.size.toSize().

Name Type Description
z number

Z.
Returns:
Tile size.

getZForResolution(resolution, opt_direction){number} inherited experimental

src/ol/tilegrid/tilegrid.js, line 481
Name Type Description
resolution number

Resolution.
direction number

If 0, the nearest resolution will be used. If 1, the nearest lower resolution will be used. If -1, the nearest higher resolution will be used. Default is 0.
Returns:
Z.