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 resourcesMethods
Returns a clone of the renderer
Reads renderer’s properties from given XML element
Renders given vector tile.
Resolves references to other objects - second phase of loading - after
readXml()
Initializes rendering.
Finishes rendering and cleans up any resources
Returns unique type name of the renderer implementation
Writes renderer’s properties to given XML element
-
clone
(self) → QgsVectorTileRenderer¶ Returns a clone of the renderer
- Return type
-
readXml
(self, elem: QDomElement, context: QgsReadWriteContext)¶ Reads renderer’s properties from given XML element
- Parameters
elem (QDomElement) –
context (QgsReadWriteContext) –
-
renderTile
(self, tile: QgsVectorTileRendererData, context: QgsRenderContext)¶ Renders given vector tile. Must be called between startRender/stopRender.
- Parameters
tile (QgsVectorTileRendererData) –
context (QgsRenderContext) –
-
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
context (QgsRenderContext) –
tileZoom (int) –
tileRange (QgsTileRange) –
-
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
-
writeXml
(self, elem: QDomElement, context: QgsReadWriteContext)¶ Writes renderer’s properties to given XML element
- Parameters
elem (QDomElement) –
context (QgsReadWriteContext) –
-