Class: QgsRasterRendererRegistry

Registry for raster renderers.

QgsRasterRendererRegistry is not usually directly created, but rather accessed through QgsApplication.rasterRendererRegistry().

Note

Exposed to Python bindings in QGIS 3.38

Methods

defaultRendererForDrawingStyle	Creates a default renderer for a raster drawing style (considering user options such as default contrast enhancement).
rendererCapabilities	Returns the capabilities for the renderer with the specified name.
renderersList	Returns a list of the names of registered renderers.

class qgis.core.QgsRasterRendererRegistry

Bases: object

__init__()

Constructor for QgsRasterRendererRegistry.

QgsRasterRendererRegistry is not usually directly created, but rather accessed through QgsApplication.rasterRendererRegistry().

The registry is pre-populated with standard raster renderers.

__init__(a0: QgsRasterRendererRegistry)

Parameters:

a0 (QgsRasterRendererRegistry)

defaultRendererForDrawingStyle(self, drawingStyle: Qgis.RasterDrawingStyle, provider: QgsRasterDataProvider | None) → QgsRasterRenderer | None

Creates a default renderer for a raster drawing style (considering user options such as default contrast enhancement). Caller takes ownership.

Parameters:

• drawingStyle (Qgis.RasterDrawingStyle)

• provider (Optional[QgsRasterDataProvider])

Return type:

Optional[QgsRasterRenderer]

rendererCapabilities(self, rendererName: str | None) → Qgis.RasterRendererCapabilities

Returns the capabilities for the renderer with the specified name.

Added in version 3.38.

Parameters:

rendererName (Optional[str])

Return type:

Qgis.RasterRendererCapabilities

renderersList(self) → List[str]

Returns a list of the names of registered renderers.

Return type:

List[str]