Class: QgsVectorTileRenderer

class qgis.core.QgsVectorTileRenderer

Bases: sip.wrapper

Abstract base class for all vector tile renderer implementations.

For rendering it is expected that client code calls:

# startRender() to prepare renderer # renderTile() for each tile # stopRender() to clean up renderer and free resources

New in version 3.14:

Methods

clone

Returns a clone of the renderer

readXml

Reads renderer's properties from given XML element

renderBackground

Renders the background if defined

renderSelectedFeatures

Renders the specified features in a selected state.

renderTile

Renders given vector tile.

requiredLayers

Returns a list of the layers required for rendering.

resolveReferences

Resolves references to other objects - second phase of loading - after readXml()

startRender

Initializes rendering.

stopRender

Finishes rendering and cleans up any resources

type

Returns unique type name of the renderer implementation

willRenderFeature

Returns True if the specified feature will be rendered in the given render context.

writeXml

Writes renderer's properties to given XML element

clone(self) QgsVectorTileRenderer

Returns a clone of the renderer

Return type:

QgsVectorTileRenderer

readXml(self, elem: QDomElement, context: QgsReadWriteContext)

Reads renderer’s properties from given XML element

Parameters:
renderBackground(self, context: QgsRenderContext)

Renders the background if defined

Parameters:

context (QgsRenderContext) –

renderSelectedFeatures(self, selection: Iterable[QgsFeature], context: QgsRenderContext)

Renders the specified features in a selected state.

This will be called after rendering the tiles, so that the selected features are always visible on the top of the layer.

New in version 3.28.

Parameters:
renderTile(self, tile: QgsVectorTileRendererData, context: QgsRenderContext)

Renders given vector tile. Must be called between startRender/stopRender.

Parameters:
requiredLayers(self, context: QgsRenderContext, tileZoom: int) Set[str]

Returns a list of the layers required for rendering.

Only layers which are visible at the specified tileZoom should be included in this list.

An empty string present in the list indicates that all layer in the tiles are required.

New in version 3.16.

Parameters:
Return type:

Set[str]

resolveReferences(self, project: QgsProject)

Resolves references to other objects - second phase of loading - after readXml()

Parameters:

project (QgsProject) –

startRender(self, context: QgsRenderContext, tileZoom: int, tileRange: QgsTileRange)

Initializes rendering. It should be paired with a stopRender() call.

Parameters:
stopRender(self, context: QgsRenderContext)

Finishes rendering and cleans up any resources

Parameters:

context (QgsRenderContext) –

type(self) str

Returns unique type name of the renderer implementation

Return type:

str

willRenderFeature(self, feature: QgsFeature, tileZoom: int, layerName: str, context: QgsRenderContext) bool

Returns True if the specified feature will be rendered in the given render context.

New in version 3.28.

Parameters:
Return type:

bool

writeXml(self, elem: QDomElement, context: QgsReadWriteContext)

Writes renderer’s properties to given XML element

Parameters: