Class: QgsVectorTileRenderer

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

Added in version 3.14.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: clone(), readXml(), renderBackground(), renderSelectedFeatures(), renderTile(), startRender(), stopRender(), type(), willRenderFeature(), writeXml()

Class Hierarchy

Subclasses

QgsVectorTileBasicRenderer

The default vector tile renderer implementation.

Abstract 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.
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

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsVectorTileRenderer. See the FAQ for more details.

requiredLayers	Returns a list of the layers required for rendering.
resolveReferences	Resolves references to other objects - second phase of loading - after readXml()

class qgis.core.QgsVectorTileRenderer

Bases: object

abstract clone(self) → QgsVectorTileRenderer | None

Returns a clone of the renderer

Return type:

Optional[QgsVectorTileRenderer]

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

Reads renderer’s properties from given XML element

Parameters:

• elem (QDomElement)

• context (QgsReadWriteContext)

abstract renderBackground(self, context: QgsRenderContext)

Renders the background if defined

Parameters:

context (QgsRenderContext)

abstract 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.

Added in version 3.28.

Parameters:

• selection (Iterable[QgsFeature])

• context (QgsRenderContext)

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

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

Parameters:

• tile (QgsVectorTileRendererData)

• context (QgsRenderContext)

virtual 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.

Added in version 3.16.

Parameters:

• context (QgsRenderContext)

• tileZoom (int)

Return type:

Set[str]

virtual resolveReferences(self, project: QgsProject)

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

Parameters:

project (QgsProject)

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

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

Parameters:

• context (QgsRenderContext)

• tileZoom (int)

• tileRange (QgsTileRange)

abstract stopRender(self, context: QgsRenderContext)

Finishes rendering and cleans up any resources

Parameters:

context (QgsRenderContext)

abstract type(self) → str

Returns unique type name of the renderer implementation

Return type:

str

abstract willRenderFeature(self, feature: QgsFeature, tileZoom: int, layerName: str | None, context: QgsRenderContext) → bool

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

Added in version 3.28.

Parameters:

• feature (QgsFeature)

• tileZoom (int)

• layerName (Optional[str])

• context (QgsRenderContext)

Return type:

bool

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

Writes renderer’s properties to given XML element

Parameters:

• elem (QDomElement)

• context (QgsReadWriteContext)