Class: QgsColorRampShaderWidget¶
- class qgis.gui.QgsColorRampShaderWidget¶
Bases:
PyQt5.QtWidgets.QWidget
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.
QgsColorRampShaderWidget(parent: QWidget = None) Creates new color ramp shader widget
Methods
Executes the single band pseudo raster classification
Allows quantile classification mode for raster layers
Loads min and max values from color ramp tree
Gets max value
Gets min value
Populates color ramp tree from ramp items
Sets extent, only when used for raster layer
Sets widget state from the color ramp shader
Sets min max
Sets min max and classify color tree
Sets raster band, only when used for raster layer
Associates raster with the widget, only when used for raster layer
Returns shared function used in the renderer
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- actionEvent(self, QActionEvent)¶
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- classificationModeChanged¶
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.
- Parameters
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type
PYQT_SIGNAL
- classify(self)¶
Executes the single band pseudo raster classification
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- customEvent(self, QEvent)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- enterEvent(self, QEvent)¶
- event(self, QEvent) bool ¶
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hideEvent(self, QHideEvent)¶
- initPainter(self, QPainter)¶
- initializeForUseWithRasterLayer(self)¶
Allows quantile classification mode for raster layers
- inputMethodEvent(self, QInputMethodEvent)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- leaveEvent(self, QEvent)¶
- loadMinimumMaximumFromTree(self)¶
Loads min and max values from color ramp tree
- maximum(self) float ¶
Gets max value
- Return type
float
- metric(self, QPaintDevice.PaintDeviceMetric) int ¶
- minimum(self) float ¶
Gets min value
- Return type
float
- minimumMaximumChangedFromTree¶
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.
- Parameters
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type
PYQT_SIGNAL
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, QMouseEvent)¶
- mousePressEvent(self, QMouseEvent)¶
- mouseReleaseEvent(self, QMouseEvent)¶
- moveEvent(self, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) Tuple[bool, int] ¶
- paintEvent(self, QPaintEvent)¶
- populateColormapTreeWidget(self, colorRampItems: Iterable[QgsColorRampShader.ColorRampItem])¶
Populates color ramp tree from ramp items
- Parameters
colorRampItems (Iterable[QgsColorRampShader.ColorRampItem]) –
- receivers(self, PYQT_SIGNAL) int ¶
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- 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
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶
- 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.
- Parameters
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type
PYQT_SIGNAL