Class: QgsTileMatrixSet

class qgis.core.QgsTileMatrixSet

Bases: sip.wrapper

Defines a set of tile matrices for multiple zoom levels.

New in version 3.22.6:

Methods

addGoogleCrs84QuadTiles

Adds tile matrices corresponding to the standard web mercator/GoogleCRS84Quad setup.

addMatrix

Adds a matrix to the set.

calculateTileScaleForMap

Calculates the correct scale to use for the tiles when rendered using the specified map properties.

crs

Returns the coordinate reference system associated with the tiles.

dropMatricesOutsideZoomRange

Deletes any existing matrices which fall outside the zoom range specified by minimumZoom to maximumZoom, inclusive.

isEmpty

Returns True if the matrix set is empty.

maximumZoom

Returns the maximum zoom level for tiles present in the set.

minimumZoom

Returns the minimum zoom level for tiles present in the set.

readXml

Reads the set from an XML element.

rootMatrix

Returns the root tile matrix (usually corresponding to zoom level 0).

scaleForRenderContext

Calculates the correct scale to use for the tiles when rendered using the specified render context.

scaleToTileZoomMethod

Returns the scale to tile zoom method.

scaleToZoom

Calculates a fractional zoom level given a map scale denominator.

scaleToZoomLevel

Finds the best fitting (integer) zoom level given a map scale denominator.

setRootMatrix

Sets the root tile matrix (usually corresponding to zoom level 0).

setScaleToTileZoomMethod

Sets the scale to tile zoom method.

tileAvailability

Returns the availability of the given tile in this matrix.

tileMatrix

Returns the tile matrix corresponding to the specified zoom.

tilesInRange

Returns a list of tiles in the given tile range.

writeXml

Writes the set to an XML element.
addGoogleCrs84QuadTiles(self, minimumZoom: int = 0, maximumZoom: int = 14)

Adds tile matrices corresponding to the standard web mercator/GoogleCRS84Quad setup.

Parameters:

  • minimumZoom (int = 0) –

  • maximumZoom (int = 14) –

addMatrix(self, matrix: QgsTileMatrix)

Adds a matrix to the set.

Any existing matrix with the same QgsTileMatrix.zoomLevel() will be replaced.

Parameters:

matrix (QgsTileMatrix) –

calculateTileScaleForMap(self, actualMapScale: float, mapCrs: QgsCoordinateReferenceSystem, mapExtent: QgsRectangle, mapSize: QSize, mapDpi: float) → float

Calculates the correct scale to use for the tiles when rendered using the specified map properties.

New in version 3.26.

Parameters:
Return type:

float

crs(self) → QgsCoordinateReferenceSystem

Returns the coordinate reference system associated with the tiles.

In the case of a tile set containing mixed CRS at different zoom levels this method will return the crs of the minimum zoom tile matrix.

Return type:

QgsCoordinateReferenceSystem

dropMatricesOutsideZoomRange(self, minimumZoom: int, maximumZoom: int)

Deletes any existing matrices which fall outside the zoom range specified by minimumZoom to maximumZoom, inclusive.

Parameters:

  • minimumZoom (int) –

  • maximumZoom (int) –

isEmpty(self) → bool

Returns True if the matrix set is empty.

Return type:

bool

maximumZoom(self) → int

Returns the maximum zoom level for tiles present in the set.

See also

minimumZoom()

Return type:

int

minimumZoom(self) → int

Returns the minimum zoom level for tiles present in the set.

See also

maximumZoom()

Return type:

int

readXml(self, element: QDomElement, context: QgsReadWriteContext) → bool

Reads the set from an XML element.

See also

writeXml()

Parameters:
Return type:

bool

rootMatrix(self) → QgsTileMatrix

Returns the root tile matrix (usually corresponding to zoom level 0).

New in version 3.28.

Return type:

QgsTileMatrix

scaleForRenderContext(self, context: QgsRenderContext) → float

Calculates the correct scale to use for the tiles when rendered using the specified render context.

New in version 3.26.

Parameters:

context (QgsRenderContext) –

Return type:

float

scaleToTileZoomMethod(self) → Qgis.ScaleToTileZoomLevelMethod

Returns the scale to tile zoom method.

See also

setScaleToTileZoomMethod()

Return type:

Qgis.ScaleToTileZoomLevelMethod

scaleToZoom(self, scale: float) → float

Calculates a fractional zoom level given a map scale denominator.

The zoom level will be linearly interpolated between zoom levels present in the set.

Parameters:

scale (float) –

Return type:

float

scaleToZoomLevel(self, scale: float) → int

Finds the best fitting (integer) zoom level given a map scale denominator.

Values are constrained to the zoom levels between minimumZoom() and maximumZoom().

Parameters:

scale (float) –

Return type:

int

setRootMatrix(self, matrix: QgsTileMatrix)

Sets the root tile matrix (usually corresponding to zoom level 0).

New in version 3.28.

Parameters:

matrix (QgsTileMatrix) –

setScaleToTileZoomMethod(self, method: Qgis.ScaleToTileZoomLevelMethod)

Sets the scale to tile zoom method.

See also

scaleToTileZoomMethod()

Parameters:

method (Qgis.ScaleToTileZoomLevelMethod) –

tileAvailability(self, id: QgsTileXYZ) → Qgis.TileAvailability

Returns the availability of the given tile in this matrix.

This method can be used to determine whether a particular tile actually exists within the matrix, or is not available (e.g. due to holes within the matrix).

This method returns Qgis.TileAvailability.Available by default, unless specific tile availability is known for the given id.

New in version 3.32.

Parameters:

id (QgsTileXYZ) –

Return type:

Qgis.TileAvailability

tileMatrix(self, zoom: int) → QgsTileMatrix

Returns the tile matrix corresponding to the specified zoom.

Parameters:

zoom (int) –

Return type:

QgsTileMatrix

tilesInRange(self, range: QgsTileRange, zoomLevel: int) → List[QgsTileXYZ]

Returns a list of tiles in the given tile range.

New in version 3.32.

Parameters:
Return type:

List[QgsTileXYZ]

writeXml(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement

Writes the set to an XML element.

Parameters:
Return type:

QDomElement