Class: QgsRasterRenderer

Raster renderer pipe that applies colors to a raster.

Class Hierarchy

Base classes

QgsRasterInterface

Base class for processing filters like renderers, reprojector, resampler etc.

Subclasses

QgsHillshadeRenderer	A renderer for generating live hillshade models.
QgsMultiBandColorRenderer	Renderer for multiband images with the color components.
QgsPalettedRasterRenderer	Renderer for paletted raster images.
QgsRasterContourRenderer	Raster renderer that generates contours on the fly for a source raster band.
QgsRasterSingleColorRenderer	Raster renderer which renders all data pixels using a single color.
QgsSingleBandColorDataRenderer	Raster renderer pipe for single band color.
QgsSingleBandGrayRenderer	Raster renderer pipe for single band gray.
QgsSingleBandPseudoColorRenderer	Raster renderer pipe for single band pseudocolor.

Methods

alphaBand
copyCommonProperties	Copies common properties like opacity / transparency data from other renderer.
minMaxOrigin	Returns const reference to origin of min/max values
nodataColor	Returns the color to use for shading nodata pixels.
opacity	Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
rasterTransparency
renderColorForNodataPixel	Returns the color for the renderer to use to represent nodata pixels.
setAlphaBand
setMinMaxOrigin	Sets origin of min/max values
setNodataColor	Sets the color to use for shading nodata pixels.
setOpacity	Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).
setRasterTransparency
usesTransparency

Virtual Methods

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

accept	Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer.
canCreateRasterAttributeTable	Returns True if the renderer is suitable for attribute table creation.
createLegendNodes	Creates a set of legend nodes representing the renderer.
flags	Returns flags which dictate renderer behavior.
inputBand	Returns the input band for the renderer, or -1 if no input band is available.
legendSymbologyItems	Returns symbology items if provided by renderer.
readXml	Sets base class members from xml.
setInputBand	Attempts to set the input band for the renderer.
toSld	Used from subclasses to create SLD Rule elements following SLD v1.0 specs
type	Returns a unique string representation of the renderer type.
usesBands	Returns a list of band numbers used by the renderer.

Attributes

NODATA_COLOR

class qgis.core.QgsRasterRenderer

Bases: QgsRasterInterface

__init__(input: QgsRasterInterface | None = None, type: str | None = '')

Constructor for QgsRasterRenderer.

Parameters:

• input (Optional[QgsRasterInterface] = None)

• type (Optional[str] = '')

NODATA_COLOR = 0

virtual accept(self, visitor: QgsStyleEntityVisitorInterface | None) → bool

Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer.

Returns True if the visitor should continue visiting other objects, or False if visiting should be canceled.

Added in version 3.10.

Parameters:

visitor (Optional[QgsStyleEntityVisitorInterface])

Return type:

bool

alphaBand(self) → int

Return type:

int

virtual canCreateRasterAttributeTable(self) → bool

Returns True if the renderer is suitable for attribute table creation. The default implementation returns False.

Added in version 3.30.

Return type:

bool

copyCommonProperties(self, other: QgsRasterRenderer | None, copyMinMaxOrigin: bool = True)

Copies common properties like opacity / transparency data from other renderer. Useful when cloning renderers.

Parameters:

• other (Optional[QgsRasterRenderer])

• copyMinMaxOrigin (bool = True)

virtual createLegendNodes(self, nodeLayer: QgsLayerTreeLayer | None) → List[QgsLayerTreeModelLegendNode]

Creates a set of legend nodes representing the renderer.

The default implementation calls legendSymbologyItems() and creates corresponding legend nodes for each returned symbology item.

Subclasses can override this to return more legend nodes which better represent the renderer.

Added in version 3.18.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])

Return type:

List[QgsLayerTreeModelLegendNode]

virtual flags(self) → Qgis.RasterRendererFlags

Returns flags which dictate renderer behavior.

Added in version 3.28.

Return type:

Qgis.RasterRendererFlags

virtual inputBand(self) → int

Returns the input band for the renderer, or -1 if no input band is available.

For renderers which utilize multiple input bands -1 will be returned. In these cases usesBands() will return a list of all utilized bands (including alpha bands).

See also

setInputBand()

See also

usesBands()

Added in version 3.38.

Return type:

int

virtual legendSymbologyItems(self) → List[Tuple[str, QColor]]

Returns symbology items if provided by renderer.

See also

createLegendNodes()

Return type:

List[Tuple[str, QColor]]

minMaxOrigin(self) → QgsRasterMinMaxOrigin

Returns const reference to origin of min/max values

Return type:

QgsRasterMinMaxOrigin

nodataColor(self) → QColor

Returns the color to use for shading nodata pixels.

If the returned value is an invalid color then the default transparent rendering of nodata values will be used.

See also

renderColorForNodataPixel()

See also

setNodataColor()

Added in version 3.12.

Return type:

QColor

opacity(self) → float

Returns the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

See also

setOpacity()

Return type:

float

rasterTransparency(self) → QgsRasterTransparency | None

Return type:

Optional[QgsRasterTransparency]

virtual readXml(self, rendererElem: QDomElement)

Sets base class members from xml. Usually called from create() methods of subclasses

Parameters:

rendererElem (QDomElement)

renderColorForNodataPixel(self) → int

Returns the color for the renderer to use to represent nodata pixels.

Subclasses should use this rather then nodataColor() to determine the color to use for nodata pixels during an actual rendering operation.

Added in version 3.10.

Return type:

int

setAlphaBand(self, band: int)

Parameters:

band (int)

virtual setInputBand(self, band: int) → bool

Attempts to set the input band for the renderer.

Returns True if the band was successfully set, or False if the band could not be set.

Note

Not all renderers support setting the input band.

See also

inputBand()

See also

usesBands()

Added in version 3.38.

Parameters:

band (int)

Return type:

bool

setMinMaxOrigin(self, origin: QgsRasterMinMaxOrigin)

Sets origin of min/max values

Parameters:

origin (QgsRasterMinMaxOrigin)

setNodataColor(self, color: QColor | Qt.GlobalColor)

Sets the color to use for shading nodata pixels.

If color is an invalid color then the default transparent rendering of nodata values will be used.

See also

nodataColor()

Added in version 3.12.

Parameters:

color (Union[QColor, Qt.GlobalColor])

setOpacity(self, opacity: float)

Sets the opacity for the renderer, where opacity is a value between 0 (totally transparent) and 1.0 (fully opaque).

See also

opacity()

Parameters:

opacity (float)

setRasterTransparency(self, t: QgsRasterTransparency | None)

Parameters:

t (Optional[QgsRasterTransparency])

virtual toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, Any] = {})

Used from subclasses to create SLD Rule elements following SLD v1.0 specs

Deprecated since version 3.44: Use the version with QgsSldExportContext instead.

Parameters:

• doc (QDomDocument)

• element (QDomElement)

• props (Dict[str, Any] = {})

virtual toSld(self, doc: QDomDocument, element: QDomElement, context: QgsSldExportContext) → bool

Used from subclasses to create SLD Rule elements following SLD v1.0 specs

Added in version 3.44.

Parameters:

• doc (QDomDocument)

• element (QDomElement)

• context (QgsSldExportContext)

Return type:

bool

virtual type(self) → str

Returns a unique string representation of the renderer type.

Return type:

str

virtual usesBands(self) → List[int]

Returns a list of band numbers used by the renderer.

See also

setInputBand()

Return type:

List[int]

usesTransparency(self) → bool

Return type:

bool