Class: QgsColorRampShaderWidget

class qgis.gui.QgsColorRampShaderWidget(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

Creates new color ramp shader widget

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)

New in version 3.4.

Parameters

parent

actionEvent()
changeEvent()
childEvent()
classificationModeChanged

Classification mode changed [signal]

Parameters

mode (QgsColorRampShader.ClassificationMode) –

classify(self)

Executes the single band pseudo raster classification

closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
initializeForUseWithRasterLayer(self)

Allows quantile classification mode for raster layers

inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
loadMinimumMaximumFromTree(self)

Loads min and max values from color ramp tree

maximum(self) → float

Gets max value

Return type

float

metric()
minimum(self) → float

Gets min value

Return type

float

minimumMaximumChangedFromTree

Color ramp tree has changed [signal]

Parameters
  • minimum (float) –

  • maximum (float) –

mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
populateColormapTreeWidget(self, colorRampItems: Iterable[QgsColorRampShader.ColorRampItem])

Populates color ramp tree from ramp items

Parameters

colorRampItems (Iterable[QgsColorRampShader.ColorRampItem]) –

receivers()
resizeEvent()
sender()
senderSignalIndex()
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)

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

Parameters

dp (QgsRasterDataProvider) –

shader(self) → QgsColorRampShader

Returns shared function used in the renderer

Return type

QgsColorRampShader

sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()
widgetChanged

Widget changed [signal]