Class: QgsRendererRasterPropertiesWidget¶

class qgis.gui.QgsRendererRasterPropertiesWidget(layer: QgsMapLayer | None, canvas: QgsMapCanvas | None, parent: QWidget | None = None)¶

Bases: QgsMapLayerConfigWidget

A widget to hold the renderer properties for a raster layer.

Parameters:

layer – The raster layer to style
canvas – The canvas object used to calculate the max and min values from the extent.

parent –

Parent object

Methods

`actionEvent`
`apply`	Apply the changes from the dialog to the layer.
`changeEvent`
`childEvent`
`closeEvent`
`connectNotify`
`contextMenuEvent`
`create`
`currentRenderWidget`	Returns the active render widget.
`customEvent`
`destroy`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`enterEvent`
`event`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`hideEvent`
`initPainter`
`inputMethodEvent`
`isSignalConnected`
`keyPressEvent`	Overridden key press event to handle the esc event on the widget.
`keyReleaseEvent`
`leaveEvent`
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`moveEvent`
`nativeEvent`
`paintEvent`
`receivers`
`rendererChanged`	called when user changes renderer type
`resizeEvent`
`sender`
`senderSignalIndex`
`setMapCanvas`	Sets the map canvas associated with the dialog.
`sharedPainter`
`showEvent`
`syncToLayer`	Sync the widget to the given layer.
`tabletEvent`
`timerEvent`
`updateMicroFocus`
`wheelEvent`

actionEvent(self, a0: QActionEvent | None)¶

apply(self)¶: Apply the changes from the dialog to the layer.

changeEvent(self, a0: QEvent | None)¶

childEvent(self, a0: QChildEvent | None)¶

closeEvent(self, a0: QCloseEvent | None)¶

connectNotify(self, signal: QMetaMethod)¶

contextMenuEvent(self, a0: QContextMenuEvent | None)¶

create(self, window: PyQt5.sip.voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)¶

currentRenderWidget(self) → QgsRasterRendererWidget | None¶

Returns the active render widget. Can be None.

Return type:: Optional[QgsRasterRendererWidget]

customEvent(self, a0: QEvent | None)¶

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶

disconnectNotify(self, signal: QMetaMethod)¶

dragEnterEvent(self, a0: QDragEnterEvent | None)¶

dragLeaveEvent(self, a0: QDragLeaveEvent | None)¶

dragMoveEvent(self, a0: QDragMoveEvent | None)¶

dropEvent(self, a0: QDropEvent | None)¶

enterEvent(self, a0: QEvent | None)¶

event(self, a0: QEvent | None) → bool¶

focusInEvent(self, a0: QFocusEvent | None)¶

focusNextChild(self) → bool¶

focusNextPrevChild(self, next: bool) → bool¶

focusOutEvent(self, a0: QFocusEvent | None)¶

focusPreviousChild(self) → bool¶

hideEvent(self, a0: QHideEvent | None)¶

initPainter(self, painter: QPainter | None)¶

inputMethodEvent(self, a0: QInputMethodEvent | None)¶

isSignalConnected(self, signal: QMetaMethod) → bool¶

keyPressEvent(self, event: QKeyEvent | None)¶

Overridden key press event to handle the esc event on the widget.

Parameters:: event – The key event

keyReleaseEvent(self, a0: QKeyEvent | None)¶

leaveEvent(self, a0: QEvent | None)¶

metric(self, a0: QPaintDevice.PaintDeviceMetric) → int¶

mouseDoubleClickEvent(self, a0: QMouseEvent | None)¶

mouseMoveEvent(self, a0: QMouseEvent | None)¶

mousePressEvent(self, a0: QMouseEvent | None)¶

mouseReleaseEvent(self, a0: QMouseEvent | None)¶

moveEvent(self, a0: QMoveEvent | None)¶

nativeEvent(self, eventType: QByteArray | bytes | bytearray, message: PyQt5.sip.voidptr | None)¶

paintEvent(self, a0: QPaintEvent | None)¶

receivers(self, signal: PYQT_SIGNAL) → int¶

rendererChanged(self)¶: called when user changes renderer type

resizeEvent(self, a0: QResizeEvent | None)¶

sender(self) → QObject | None¶

senderSignalIndex(self) → int¶

setMapCanvas(self, canvas: QgsMapCanvas | None)¶

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

Parameters:: canvas (Optional[QgsMapCanvas]) – map canvas

sharedPainter(self) → QPainter | None¶

showEvent(self, a0: QShowEvent | None)¶

syncToLayer(self, layer: QgsRasterLayer | None)¶

Sync the widget to the given layer.

Parameters:: layer (Optional[QgsRasterLayer]) – The layer to use for the widget

tabletEvent(self, a0: QTabletEvent | None)¶

timerEvent(self, a0: QTimerEvent | None)¶

updateMicroFocus(self)¶

wheelEvent(self, a0: QWheelEvent | None)¶