Class: QgsRendererRegistry¶

Registry of renderers.

QgsRendererRegistry is not usually directly created, but rather accessed through QgsApplication.rendererRegistry().

Methods

`addRenderer`	Adds a renderer to the registry.
`removeRenderer`	Removes a renderer from registry.
`rendererMetadata`	Returns the metadata for a specified renderer.
`renderersList`	Returns a list of available renderers.

class qgis.core.QgsRendererRegistry[source]¶

Bases: object

addRenderer(self, metadata: QgsRendererAbstractMetadata | None) → bool[source]¶

Adds a renderer to the registry. Takes ownership of the metadata object.

Parameters:: metadata (Optional[QgsRendererAbstractMetadata]) – renderer metadata
Return type:: bool
Returns:: True if renderer was added successfully, or False if renderer could not be added (e.g., a renderer with a duplicate name already exists)

removeRenderer(self, rendererName: str | None) → bool[source]¶

Removes a renderer from registry.

Parameters:: rendererName (Optional[str]) – name of renderer to remove from registry
Return type:: bool
Returns:: True if renderer was successfully removed, or False if matching renderer could not be found

rendererMetadata(self, rendererName: str | None) → QgsRendererAbstractMetadata | None[source]¶

Returns the metadata for a specified renderer. Returns None if a matching renderer was not found in the registry.

renderersList(self, layerTypes: QgsRendererAbstractMetadata.LayerTypes | QgsRendererAbstractMetadata.LayerType = QgsRendererAbstractMetadata.All) → List[str][source]¶

Returns a list of available renderers.

Parameters:: layerTypes (Union[QgsRendererAbstractMetadata.LayerTypes, QgsRendererAbstractMetadata.LayerType] = QgsRendererAbstractMetadata.All) – flags to filter the renderers by compatible layer types
Return type:: List[str]

renderersList(self, layer: QgsVectorLayer | None) → List[str][source]

Returns a list of available renderers which are compatible with a specified layer.