Class: QgsRasterRendererWidget

Abstract base class for widgets which configure a QgsRasterRenderer.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: renderer()

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Subclasses

QgsHillshadeRendererWidget	Renderer widget for the hill shade renderer.
QgsMultiBandColorRendererWidget	A widget for configuring a QgsMultiBandColorRenderer.
QgsPalettedRendererWidget	A widget for configuring QgsPalettedRasterRenderer.
QgsRasterContourRendererWidget	Configuration widget for QgsRasterContourRenderer.
QgsSingleBandGrayRendererWidget	A widget for configuring a QgsSingleBandGrayRenderer.
QgsSingleBandPseudoColorRendererWidget	Single band pseudo color renderer widget consists of a color ramp shader widget, a raster min max widget and a band selector.

class qgis.gui.QgsRasterRendererWidget

Bases: QWidget

__init__(layer: QgsRasterLayer | None, extent: QgsRectangle)

Constructor for QgsRasterRendererWidget.

Parameters:

• layer (Optional[QgsRasterLayer]) – associated raster layer

• extent (QgsRectangle) – current canvas extent

virtual contrastEnhancementAlgorithm(self) → QgsContrastEnhancement.ContrastEnhancementAlgorithm

Returns the contrast enhancement algorithm to be used by the raster renderer.

Added in version 3.26.

Return type:

QgsContrastEnhancement.ContrastEnhancementAlgorithm

virtual doComputations(self)

Load programmatically with current values

mapCanvas(self) → QgsMapCanvas | None

Returns the map canvas associated with the widget.

See also

setMapCanvas()

Return type:

Optional[QgsMapCanvas]

virtual max(self, index: int = 0) → str

Parameters:

index (int = 0)

Return type:

str

virtual min(self, index: int = 0) → str

Parameters:

index (int = 0)

Return type:

str

virtual minMaxWidget(self) → QgsRasterMinMaxWidget | None

Returns min/max widget when it exists.

Return type:

Optional[QgsRasterMinMaxWidget]

rasterLayer(self) → QgsRasterLayer | None

Returns the raster layer associated with the widget.

See also

setRasterLayer()

Return type:

Optional[QgsRasterLayer]

abstract renderer(self) → QgsRasterRenderer | None

Creates a new renderer, using the properties defined in the widget.

The caller takes ownership of the returned renderer.

Return type:

Optional[QgsRasterRenderer]

virtual selectedBand(self, index: int = 0) → int

Parameters:

index (int = 0)

Return type:

int

virtual setContrastEnhancementAlgorithm(self, algorithm: QgsContrastEnhancement.ContrastEnhancementAlgorithm)

Sets the contrast enhancement algorithm to be used by the raster renderer.

Added in version 3.26.

Parameters:

algorithm (QgsContrastEnhancement.ContrastEnhancementAlgorithm)

virtual setMapCanvas(self, canvas: QgsMapCanvas | None)

Sets the map canvas associated with the widget. This allows the widget to retrieve the current map extent and other properties from the canvas.

Parameters:

canvas (Optional[QgsMapCanvas]) – map canvas

See also

mapCanvas()

virtual setMax(self, value: str | None, index: int = 0)

Parameters:

• value (Optional[str])

• index (int = 0)

virtual setMin(self, value: str | None, index: int = 0)

Parameters:

• value (Optional[str])

• index (int = 0)

setRasterLayer(self, layer: QgsRasterLayer | None)

Sets the raster layer associated with the widget.

See also

rasterLayer()

Parameters:

layer (Optional[QgsRasterLayer])

virtual setStdDev(self, value: str | None)

Parameters:

value (Optional[str])

virtual stdDev(self) → str

Return type:

str

signal widgetChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.