Class: QgsSingleBandGrayRenderer

Raster renderer pipe for single band gray.

Class Hierarchy

Base classes

QgsRasterRenderer	Raster renderer pipe that applies colors to a raster.
QgsRasterInterface	Base class for processing filters like renderers, reprojector, resampler etc.

Methods

contrastEnhancement
gradient
grayBand
legendSettings	Returns the color ramp shader legend settings.
setContrastEnhancement	Takes ownership
setGradient
setGrayBand
setLegendSettings	Sets the color ramp shader legend settings.

Static Methods

create

Attributes

BlackToWhite
WhiteToBlack

class qgis.core.QgsSingleBandGrayRenderer

Bases: QgsRasterRenderer

BlackToWhite = 0

class Gradient

Bases: int

WhiteToBlack = 1

contrastEnhancement(self) → QgsContrastEnhancement | None

Return type:

Optional[QgsContrastEnhancement]

static create(elem: QDomElement, input: QgsRasterInterface | None) → QgsRasterRenderer | None

Parameters:

• elem (QDomElement)

• input (Optional[QgsRasterInterface])

Return type:

Optional[QgsRasterRenderer]

gradient(self) → QgsSingleBandGrayRenderer.Gradient

Return type:

QgsSingleBandGrayRenderer.Gradient

grayBand(self) → int

Deprecated since version 3.38.

Use inputBand() instead.

Return type:

int

legendSettings(self) → QgsColorRampLegendNodeSettings | None

Returns the color ramp shader legend settings.

See also

setLegendSettings()

Added in version 3.18.

Return type:

Optional[QgsColorRampLegendNodeSettings]

setContrastEnhancement(self, ce: QgsContrastEnhancement | None)

Takes ownership

Parameters:

ce (Optional[QgsContrastEnhancement])

setGradient(self, gradient: QgsSingleBandGrayRenderer.Gradient)

Parameters:

gradient (QgsSingleBandGrayRenderer.Gradient)

setGrayBand(self, band: int)

Deprecated since version 3.38.

Use setInputBand() instead.

Parameters:

band (int)

setLegendSettings(self, settings: QgsColorRampLegendNodeSettings | None)

Sets the color ramp shader legend settings.

Ownership of settings is transferred.

See also

legendSettings()

Added in version 3.18.

Parameters:

settings (Optional[QgsColorRampLegendNodeSettings])