Class: QgsRasterRenderer¶

class qgis.core.QgsRasterRenderer¶

Bases: QgsRasterInterface

Raster renderer pipe that applies colors to a raster.

QgsRasterRenderer(input: QgsRasterInterface = None, type: str = ‘’) Constructor for QgsRasterRenderer.

Methods

accept

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

alphaBand

rtype:

int

bandCount

rtype:

int

block

param bandNo:

canCreateRasterAttributeTable

Returns True if the renderer is suitable for attribute table creation.

clone

QgsRasterRenderer cannot be copied.

copyCommonProperties

Copies common properties like opacity / transparency data from other renderer.

createLegendNodes

Creates a set of legend nodes representing the renderer.

dataType

param bandNo:

flags

Returns flags which dictate renderer behavior.

initHistogram

Fill in histogram defaults if not specified

initStatistics

Fill in statistics defaults if not specified

inputBand

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

legendSymbologyItems

Returns symbology items if provided by 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

rtype:

QgsRasterTransparency

readXml

Sets base class members from xml.

renderColorForNodataPixel

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

setAlphaBand

param band:

setInput

param input:

setInputBand

Attempts to set the input band for the renderer.

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

param t:

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.

usesTransparency

rtype:

bool

Attributes

NODATA_COLOR

NODATA_COLOR = 0¶

accept(self, visitor: QgsStyleEntityVisitorInterface) → 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 (QgsStyleEntityVisitorInterface)
Return type:: bool

alphaBand(self) → int¶

Return type:: int

bandCount(self) → int¶

Return type:: int

block(self, bandNo: int, extent: QgsRectangle, width: int, height: int, feedback: QgsRasterBlockFeedback = None) → QgsRasterBlock¶

Parameters:

bandNo (int)
extent (QgsRectangle)
width (int)
height (int)
feedback (QgsRasterBlockFeedback = None)

Return type:

QgsRasterBlock

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

clone(self) → QgsRasterRenderer¶

QgsRasterRenderer cannot be copied. Use clone() instead.

Return type:: QgsRasterRenderer

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

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

Parameters:

other (QgsRasterRenderer)
copyMinMaxOrigin (bool = True)

createLegendNodes(self, nodeLayer: QgsLayerTreeLayer) → 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 (QgsLayerTreeLayer)
Return type:: List[QgsLayerTreeModelLegendNode]

dataType(self, bandNo: int) → Qgis.DataType¶

Parameters:: bandNo (int)
Return type:: Qgis.DataType

flags(self) → Qgis.RasterRendererFlags¶

Returns flags which dictate renderer behavior.

Added in version 3.28.

Return type:: Qgis.RasterRendererFlags

initHistogram(self, histogram: QgsRasterHistogram, bandNo: int, binCount: int, minimum: object = Py_None, maximum: object = Py_None, boundingBox: QgsRectangle = QgsRectangle(), sampleSize: int = 0, includeOutOfRange: bool = False)¶: Fill in histogram defaults if not specified

Note

the parameters are the same as in histogram()

initStatistics(self, statistics: QgsRasterBandStats, bandNo: int, stats: int, boundingBox: QgsRectangle = QgsRectangle(), binCount: int = 0)¶

Fill in statistics defaults if not specified

Deprecated since version Use: Qgis.RasterBandStatistic instead of int for stats argument

initStatistics(self, statistics: QgsRasterBandStats, bandNo: int, stats: Union[Qgis.RasterBandStatistics, Qgis.RasterBandStatistic] = Qgis.RasterBandStatistic.All, boundingBox: QgsRectangle = QgsRectangle(), binCount: int = 0) Fill in statistics defaults if not specified

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.