Class: QgsRasterHistogramWidget

class qgis.gui.QgsRasterHistogramWidget(layer: QgsRasterLayer, parent: QWidget = None)

Bases: QgsMapLayerConfigWidget

Constructor for QgsRasterHistogramWidget, for the specified raster layer.

Histogram widget

actionEvent(self, QActionEvent)
changeEvent(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
computeHistogram(self, forceComputeFlag: bool) → bool

Compute the histogram on demand.


forceComputeFlag (bool) –

Return type


connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: 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)
histoAction(self, actionName: str, actionFlag: bool = True)

Apply a histoActionTriggered() event.

  • actionName (str) –

  • actionFlag (bool = True) –

histoSaveAsImage(self, filename: str, width: int = 600, height: int = 600, quality: int = - 1) → bool

Save the histogram as an image to disk

  • filename (str) –

  • width (int = 600) –

  • height (int = 600) –

  • quality (int = -1) –

Return type


initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod) → bool
keyPressEvent(self, event: QKeyEvent)

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


event – The key event

keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric) → int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL) → int

slot executed when user wishes to refresh raster histogramwidget

resizeEvent(self, QResizeEvent)
sender(self) → QObject
senderSignalIndex(self) → int
setActive(self, activeFlag: bool)

Activate the histogram widget


activeFlag (bool) –

setRendererWidget(self, name: str, rendererWidget: QgsRasterRendererWidget = None)

Sets the renderer widget (or just its name if there is no widget)

setSelectedBand(self, index: int)

Apply a histoActionTriggered() event.


index (int) –

sharedPainter(self) → QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
wheelEvent(self, QWheelEvent)