Class: QgsRasterRenderer

class qgis.core.QgsRasterRenderer(input: QgsRasterInterface = None, type: str = '')

Bases: QgsRasterInterface

Constructor for QgsRasterRenderer.

Raster renderer pipe that applies colors to a raster.

Parameters
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.

New 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
Return type

QgsRasterBlock

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.

New in version 2.16.

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

bandNo (int) –

Return type

Qgis.DataType

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 = QgsRasterBandStats.All, boundingBox: QgsRectangle = QgsRectangle(), binCount: int = 0)

Fill in statistics defaults if not specified

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

Gets symbology items if provided by renderer

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()

New 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
Return type

QgsRasterTransparency

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.

New in version 3.10.

Return type

int

setAlphaBand(self, band: int)
Parameters

band (int) –

setInput(self, input: QgsRasterInterface) → bool
Parameters

input (QgsRasterInterface) –

Return type

bool

setMinMaxOrigin(self, origin: QgsRasterMinMaxOrigin)

Sets origin of min/max values

Parameters

origin (QgsRasterMinMaxOrigin) –

setNodataColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])

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()

New in version 3.12.

Parameters

color (Union[QColor) –

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)
Parameters

t (QgsRasterTransparency) –

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

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

New in version 3.6.

Parameters

  • doc (QDomDocument) –

  • element (QDomElement) –

  • props (Dict[str) –

type(self) → str
Return type

str

usesBands(self) → List[int]

Returns a list of band numbers used by the renderer

Return type

List[int]

usesTransparency(self) → bool
Return type

bool