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: Enums

Methods

`actionEvent`
`changeEvent`
`childEvent`
`classify`	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`	Allows quantile classification mode for raster layers
`inputMethodEvent`
`isSignalConnected`
`keyPressEvent`
`keyReleaseEvent`
`leaveEvent`
`loadMinimumMaximumFromTree`	Loads min and max values from color ramp tree
`maximum`	Gets max value
`metric`
`minimum`	Gets min value
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEvent`
`nativeEvent`
`paintEvent`
`populateColormapTreeWidget`	Populates color ramp tree from ramp items
`receivers`
`resizeEvent`
`sender`
`senderSignalIndex`
`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
`sharedPainter`
`showEvent`
`tabletEvent`
`timerEvent`
`updateMicroFocus`
`wheelEvent`

Signals

`classificationModeChanged`	Classification mode changed [signal]
`minimumMaximumChangedFromTree`	Color ramp tree has changed [signal]
`widgetChanged`	Widget changed [signal]

Attributes

actionEvent()¶

changeEvent()¶

childEvent()¶

classificationModeChanged¶: Classification mode changed [signal]

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

metric()¶

minimum(self) → float¶: Gets min value

minimumMaximumChangedFromTree¶: Color ramp tree has changed [signal]

mouseDoubleClickEvent()¶

mouseMoveEvent()¶

mousePressEvent()¶

mouseReleaseEvent()¶

moveEvent()¶

nativeEvent()¶

paintEvent()¶

populateColormapTreeWidget(self, colorRampItems: Iterable[QgsColorRampShader.ColorRampItem])¶: Populates color ramp tree from ramp items

receivers()¶

resizeEvent()¶

sender()¶

senderSignalIndex()¶

setExtent(self, extent: QgsRectangle)¶: Sets extent, only when used for raster layer

setFromShader(self, colorRampShader: QgsColorRampShader)¶: Sets widget state from the color ramp shader

setMinimumMaximum(self, minimum: float, maximum: float)¶: Sets min max

setMinimumMaximumAndClassify(self, minimum: float, maximum: float)¶: Sets min max and classify color tree

setRasterBand(self, band: int)¶: Sets raster band, only when used for raster layer

setRasterDataProvider(self, dp: QgsRasterDataProvider)¶: Associates raster with the widget, only when used for raster layer

shader(self) → QgsColorRampShader¶: Returns shared function used in the renderer

sharedPainter()¶

showEvent()¶

tabletEvent()¶

timerEvent()¶

updateMicroFocus()¶

wheelEvent()¶

widgetChanged¶: Widget changed [signal]