3.5. Web Map Tile Service (WMTS)

The 1.0.0 WMTS standard implemented in QGIS Server provides a HTTP interface to request tiled map images generated from a QGIS project. A typical WMTS request defined the QGIS project to use, some WMS parameters like layers to render, as well as tile parameters.

Specifications document of the service:

Standard requests provided by QGIS Server:

Request

Description

GetCapabilities

Returns XML metadata with information about the server

GetTile

Returns a tile

GetFeatureInfo

Retrieves data (geometry and values) for a pixel location

3.5.1. GetCapabilities

Standard parameters for the GetCapabilities request according to the OGC WMTS 1.0.0 specifications:

Parameter

Required

Description

SERVICE

Yes

Name of the service (WMTS)

REQUEST

Yes

Name of the request (GetCapabilities)

In addition to the standard ones, QGIS Server supports the following extra parameters:

Parameter

Required

Description

MAP

Yes

QGIS project file

URL example:

http://localhost/?
SERVICE=WMTS
&REQUEST=GetCapabilities
&MAP=/home/qgis/projects/world.qgs

3.5.2. GetTile

Standard parameters for the GetTile request according to the OGC WMTS 1.0.0 specifications:

Parameter

Required

Description

SERVICE

Yes

Name of the service (WMTS)

REQUEST

Yes

Name of the request (GetTile)

LAYER

Yes

Layer identifier

FORMAT

Yes

Output format of the tile

TILEMATRIXSET

Yes

Name of the pyramid

TILEMATRIX

Yes

Meshing

TILEROW

Yes

Row coordinate in the mesh

TILECOL

Yes

Column coordinate in the mesh

In addition to the standard ones, QGIS Server supports the following extra parameters:

Parameter

Required

Description

MAP

Yes

QGIS project file

URL example:

http://localhost/?
SERVICE=WMTS
&REQUEST=GetTile
&MAP=/home/qgis/projects/world.qgs
&LAYER=mylayer
&FORMAT=image/png
&TILEMATRIXSET=EPSG:4326
&TILEROW=0
&TILECOL=0

FORMAT

This parameter may be used to specify the format of tile image. Available values are:

  • jpg

  • jpeg

  • image/jpeg

  • image/png

If the FORMAT parameter is different from one of these values, then the default format PNG is used instead.

TILEMATRIXSET

This parameter defines the CRS to use when computing the underlying pyramid. Format: EPSG:XXXX.

TILEMATRIX

This parameter allows to define the matrix to use for the output tile.

TILEROW

This parameter allows to select the row of the tile to get within the matrix.

TILECOL

This parameter allows to select the column of the tile to get within the matrix.

3.5.3. GetFeatureInfo

Standard parameters for the GetFeatureInfo request according to the OGC WMTS 1.0.0 specification:

Parameter

Required

Description

SERVICE

Yes

Name of the service (WMTS)

REQUEST

Yes

Name of the request (GetFeatureInfo)

LAYER

Yes

Layer identifier

INFOFORMAT

No

Output format

I

No

X coordinate of a pixel

J

No

Y coordinate of a pixel

TILEMATRIXSET

Yes

Name of the pyramid

TILEMATRIX

Meshing

TILEROW

Yes

Row coordinate in the mesh

TILECOL

Yes

Column coordinate in the mesh

In addition to the standard ones, QGIS Server supports the following extra parameters:

Parameter

Required

Description

MAP

Yes

QGIS project file

URL example:

http://localhost/?
SERVICE=WMTS
&REQUEST=GetFeatureInfo
&MAP=/home/qgis/projects/world.qgs
&LAYER=mylayer
&INFOFORMAT=image/html
&I=10
&J=5

INFOFORMAT

This parameter allows to define the output format of the result. Available values are:

  • text/xml

  • text/html

  • text/plain

  • application/vnd.ogc.gml

The default value is text/plain.

I

This parameter allows to define the X coordinate of the pixel for which we want to retrieve underlying information.

J

This parameter allows to define the Y coordinate of the pixel for which we want to retrieve underlying information.