Tile Matrix Sets

specstableimplmature

Provides definitions of the Tile Matrix Sets used in the API.

Scope

This building block provides information about the tiling schemes supported by the API.

The following preconfigured tiling schemes are available:

Conformance Classes

This building block implements the conformance classes "TileMatrixSet", and "JSONTileMatrixSet" of the OGC Two Dimensional Tile Matrix Set and Tile Set Metadata 2.0 Standardopen in new window.

Operations

ResourcePathMethodsMedia TypesDescription
Tile Matrix Sets
tileMatrixSets
GET
HTML, JSON
Returns the list of tiling schemes.
Tile Matrix Set
tileMatrixSets/{tileMatrixSetId}
GET
HTML, JSON
Returns the definition of a tiling scheme.

Path Parameters

NameResourcesDescription
tileMatrixSetId
Tile Matrix Set
The identifier of the tiling scheme.

Query Parameters

NameResourcesDescription
f
TileMatrixSets, TileMatrixSet
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.

Configuration

Custom Tiling Schemes

Additional tiling schemes can be configured as JSON files according to the OGC Two Dimensional Tile Matrix Set and Tile Set Metadata 2.0 Standardopen in new window in the data directory at api-resources/tile-matrix-sets/{tileMatrixSetId}.json.

Options

NameDefaultDescriptionTypeSince
buildingBlock
Always TILE_MATRIX_SETS.
string
v3.1
enabled
false
Enable the building block?
boolean
v3.1
caching
{}
Sets fixed values for HTTP Caching Headers for the resources.
object
v3.1
includePredefined
[ "WebMercatorQuad" ]
The list of pre-defined tile matrix sets that are published via this API.
array
v3.1

Examples

The JSON representation of the pre-defined tiling schemes are available on GitHubopen in new window.

A configuration for an API that provides tiles in three tiling schemas could be the following:


- buildingBlock: TILE_MATRIX_SETS
  enabled: true
  includePredefined:
  - WebMercatorQuad
  - WorldCRS84Quad
  - WorldMercatorWGS84Quad