Class: QgsColorRampShaderWidget

A widget for configuring numeric ranges associated with a color ramp.

It has 2 ways how to use it. For raster layers, raster data provider and band is assigned and the Quantile classification mode can be used and the LoadFromBandButton is visible.

The other mode is used to style mesh layer contours (scalar datasets)

Added in version 3.4.

QgsColorRampShaderWidget

Class Hierarchy

Base classes

QWidget
QObject
QPaintDevice

Methods

classify	Executes the single band pseudo raster classification
initializeForUseWithRasterLayer	Allows quantile classification mode for raster layers
loadMinimumMaximumFromTree	Loads min and max values from color ramp tree
maximum	Gets max value
minimum	Gets min value
populateColormapTreeWidget	Populates color ramp tree from ramp items
setExtent	Sets extent, only when used for raster layer
setFromShader	Sets widget state from the color ramp shader
setMinimumMaximum	Sets min max
setMinimumMaximumAndClassify	Sets min max and classify color tree
setRasterBand	Sets raster band, only when used for raster layer
setRasterDataProvider	Associates raster with the widget, only when used for raster layer
shader	Returns shared function used in the renderer

Signals

classificationModeChanged	Classification mode changed
minimumMaximumChangedFromTree	Color ramp tree has changed
widgetChanged	Widget changed

class qgis.gui.QgsColorRampShaderWidget

Bases: QWidget

__init__(parent: QWidget | None = None)

Creates new color ramp shader widget

Parameters:

parent (Optional[QWidget] = None)

signal classificationModeChanged(mode: Qgis.ShaderClassificationMethod)

Classification mode changed

Parameters:

mode (Qgis.ShaderClassificationMethod)

classify(self)

Executes the single band pseudo raster classification

initializeForUseWithRasterLayer(self)

Allows quantile classification mode for raster layers

loadMinimumMaximumFromTree(self)

Loads min and max values from color ramp tree

maximum(self) → float

Gets max value

Return type:

float

minimum(self) → float

Gets min value

Return type:

float

signal minimumMaximumChangedFromTree(minimum: float, maximum: float)

Color ramp tree has changed

Parameters:

• minimum (float)

• maximum (float)

populateColormapTreeWidget(self, colorRampItems: Iterable[QgsColorRampShader.ColorRampItem])

Populates color ramp tree from ramp items

Parameters:

colorRampItems (Iterable[QgsColorRampShader.ColorRampItem])

setExtent(self, extent: QgsRectangle)

Sets extent, only when used for raster layer

Parameters:

extent (QgsRectangle)

setFromShader(self, colorRampShader: QgsColorRampShader)

Sets widget state from the color ramp shader

Parameters:

colorRampShader (QgsColorRampShader)

setMinimumMaximum(self, minimum: float, maximum: float)

Sets min max

Parameters:

• minimum (float)

• maximum (float)

setMinimumMaximumAndClassify(self, minimum: float, maximum: float)

Sets min max and classify color tree

Parameters:

• minimum (float)

• maximum (float)

setRasterBand(self, band: int)

Sets raster band, only when used for raster layer

Parameters:

band (int)

setRasterDataProvider(self, dp: QgsRasterDataProvider | None)

Associates raster with the widget, only when used for raster layer

Parameters:

dp (Optional[QgsRasterDataProvider])

shader(self) → QgsColorRampShader

Returns shared function used in the renderer

Return type:

QgsColorRampShader

signal widgetChanged

Widget changed