guiqwt.histogram

The histogram module provides histogram related objects:

HistogramItem objects are plot items (derived from QwtPlotItem) that may be displayed on a 2D plotting widget like guiqwt.curve.CurvePlot or guiqwt.image.ImagePlot.

Example

Simple histogram plotting example:

# -*- coding: utf-8 -*-
#
# Copyright © 2009-2010 CEA
# Pierre Raybaut
# Licensed under the terms of the CECILL License
# (see guiqwt/__init__.py for details)

"""Histogram test"""

# guitest: show

from guiqwt.plot import CurveDialog
from guiqwt.builder import make


def test():
    """Test"""
    from numpy.random import normal

    data = normal(0, 1, (2000,))
    win = CurveDialog(edit=False, toolbar=True, wintitle="Histogram test")
    plot = win.get_plot()
    plot.add_item(make.histogram(data))
    win.show()
    win.exec_()


if __name__ == "__main__":
    # Create QApplication
    import guidata

    _app = guidata.qapplication()

    test()

Reference

class guiqwt.histogram.HistogramItem(curveparam=None, histparam=None, keep_weakref=False)[source]

A Qwt item representing histogram data

set_hist_source(src)[source]

Set histogram source

source:

Object with method get_histogram, e.g. objects derived from guiqwt.image.ImageItem

get_hist_source()[source]

Return histogram source

source:

Object with method get_histogram, e.g. objects derived from guiqwt.image.ImageItem

set_hist_data(data)[source]

Set histogram data

set_logscale(state)[source]

Sets whether we use a logarithm or linear scale for the histogram counts

get_logscale()[source]

Returns the status of the scale

attach(plot)

Attach the item to a plot.

This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a None argument is passed, it will detach from any QwtPlot it was attached to.

Parameters:

plot (qwt.plot.QwtPlot) – Plot widget

See also

detach()

baseline()
Returns:

Value of the baseline

See also

setBaseline()

boundingRect()

Return the bounding rectangle of the data

brush()
Returns:

Brush used to fill the area between lines and the baseline

closePolyline(painter, xMap, yMap, polygon)

Complete a polygon to be a closed polygon including the area between the original polygon and the baseline.

Parameters:
  • painter (QPainter) – Painter

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • polygon (QPolygonF) – Polygon to be completed

closestPoint(pos)

Find the closest curve point for a specific position

Parameters:

pos (QPoint) – Position, where to look for the closest curve point

Returns:

tuple (index, dist)

dist is the distance between the position and the closest curve point. index is the index of the closest curve point, or -1 if none can be found ( f.e when the curve has no points ).

Note

closestPoint() implements a dumb algorithm, that iterates over all points

data()
Returns:

the series data

dataRect()
Returns:

Bounding rectangle of the series or an invalid rectangle, when no series is stored

See also

qwt.plot_series.QwtSeriesData.boundingRect()

dataSize()
Returns:

Number of samples of the series

See also

setData(), qwt.plot_series.QwtSeriesData.size()

deserialize(reader)

Deserialize object from HDF5 reader

detach()

Detach the item from a plot.

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

See also

attach()

directPaint(from_, to)

When observing a measurement while it is running, new points have to be added to an existing seriesItem. This method can be used to display them avoiding a complete redraw of the canvas.

Setting plot().canvas().setAttribute(Qt.WA_PaintOutsidePaintEvent, True) will result in faster painting, if the paint engine of the canvas widget supports this feature.

Parameters:
  • from (int) – Index of the first point to be painted

  • to (int) – Index of the last point to be painted

See also

drawSeries()

draw(painter, xMap, yMap, canvasRect)

Draw the complete series

Parameters:
  • painter (QPainter) – Painter

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas

drawCurve(painter, style, xMap, yMap, canvasRect, from_, to)

Draw the line part (without symbols) of a curve interval.

Parameters:
  • painter (QPainter) – Painter

  • style (int) – curve style, see QwtPlotCurve.CurveStyle

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas

  • from (int) – Index of the first point to be painted

  • to (int) – Index of the last point to be painted. If to < 0 the curve will be painted to its last point.

drawDots(painter, xMap, yMap, canvasRect, from_, to)

Draw dots

Parameters:
  • painter (QPainter) – Painter

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas

  • from (int) – Index of the first point to be painted

  • to (int) – Index of the last point to be painted. If to < 0 the curve will be painted to its last point.

drawLines(painter, xMap, yMap, canvasRect, from_, to)

Draw lines

Parameters:
  • painter (QPainter) – Painter

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas

  • from (int) – Index of the first point to be painted

  • to (int) – Index of the last point to be painted. If to < 0 the curve will be painted to its last point.

drawSeries(painter, xMap, yMap, canvasRect, from_, to)

Draw an interval of the curve

Parameters:
  • painter (QPainter) – Painter

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas

  • from (int) – Index of the first point to be painted

  • to (int) – Index of the last point to be painted. If to < 0 the curve will be painted to its last point.

drawSteps(painter, xMap, yMap, canvasRect, from_, to)

Draw steps

Parameters:
  • painter (QPainter) – Painter

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas

  • from (int) – Index of the first point to be painted

  • to (int) – Index of the last point to be painted. If to < 0 the curve will be painted to its last point.

drawSticks(painter, xMap, yMap, canvasRect, from_, to)

Draw sticks

Parameters:
  • painter (QPainter) – Painter

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas

  • from (int) – Index of the first point to be painted

  • to (int) – Index of the last point to be painted. If to < 0 the curve will be painted to its last point.

drawSymbols(painter, symbol, xMap, yMap, canvasRect, from_, to)

Draw symbols

Parameters:
  • painter (QPainter) – Painter

  • symbol (qwt.symbol.QwtSymbol) – Curve symbol

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas

  • from (int) – Index of the first point to be painted

  • to (int) – Index of the last point to be painted. If to < 0 the curve will be painted to its last point.

fillCurve(painter, xMap, yMap, canvasRect, polygon)

Fill the area between the curve and the baseline with the curve brush

Parameters:
  • painter (QPainter) – Painter

  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas

  • polygon (QPolygonF) – Polygon - will be modified !

getCanvasMarginHint(xMap, yMap, canvasRect)

Calculate a hint for the canvas margin

When the QwtPlotItem::Margins flag is enabled the plot item indicates, that it needs some margins at the borders of the canvas. This is f.e. used by bar charts to reserve space for displaying the bars.

The margins are in target device coordinates ( pixels on screen )

Parameters:
  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

  • canvasRect (QRectF) – Contents rectangle of the canvas in painter coordinates

See also

QwtPlot.getCanvasMarginsHint(), QwtPlot.updateCanvasMargins(),

get_closest_coordinates(x, y)

Renvoie les coordonnées (x’,y’) du point le plus proche de (x,y) Méthode surchargée pour ErrorBarSignalCurve pour renvoyer les coordonnées des pointes des barres d’erreur

get_data()

Return curve data x, y (NumPy arrays)

hide()

Hide the item

hit_test(pos)

Calcul de la distance d’un point à une courbe renvoie (dist, handle, inside)

icon()
Returns:

Icon of the item

See also

setIcon()

init()

Initialize internal members

isVisible()
Returns:

True if visible

is_empty()

Return True if item data is empty

is_private()

Return True if object is private

is_readonly()

Return object readonly state

itemChanged()

Update the legend and call QwtPlot.autoRefresh() for the parent plot.

See also

QwtPlot.legendChanged(), QwtPlot.autoRefresh()

legendChanged()

Update the legend of the parent plot.

See also

QwtPlot.updateLegend(), itemChanged()

legendData()

Return all information, that is needed to represent the item on the legend

QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.

The default implementation returns one entry with the title() of the item and the legendIcon().

Returns:

Data, that is needed to represent the item on the legend

See also

title(), legendIcon(), qwt.legend.QwtLegend

legendIcon(index, size)
Parameters:
  • index (int) – Index of the legend entry (ignored as there is only one)

  • size (QSizeF) – Icon size

Returns:

Icon representing the curve on the legend

See also

qwt.plot.QwtPlotItem.setLegendIconSize(), qwt.plot.QwtPlotItem.legendData()

legendIconSize()
Returns:

Legend icon size

classmethod make(xdata=None, ydata=None, title=None, plot=None, z=None, x_axis=None, y_axis=None, style=None, symbol=None, linecolor=None, linewidth=None, linestyle=None, antialiased=False, size=None, finite=None)

Create and setup a new QwtPlotCurve object (convenience function).

Parameters:
  • xdata – List/array of x values

  • ydata – List/array of y values

  • title (qwt.text.QwtText or str or None) – Curve title

  • plot (qwt.plot.QwtPlot or None) – Plot to attach the curve to

  • z (float or None) – Z-value

  • x_axis (int or None) – curve X-axis (default: QwtPlot.yLeft)

  • y_axis (int or None) – curve Y-axis (default: QwtPlot.xBottom)

  • style (int or None) – curve style (QwtPlotCurve.NoCurve, QwtPlotCurve.Lines, QwtPlotCurve.Sticks, QwtPlotCurve.Steps, QwtPlotCurve.Dots, QwtPlotCurve.UserCurve)

  • symbol (qwt.symbol.QwtSymbol or None) – curve symbol

  • linecolor (QColor or str or None) – curve line color

  • linewidth (float or None) – curve line width

  • linestyle (Qt.PenStyle or None) – curve pen style

  • antialiased (bool) – if True, enable antialiasing rendering

  • size (int or None) – size of xData and yData

  • finite (bool) – if True, keep only finite array elements (remove all infinity and not a number values), otherwise do not filter array elements

move_local_shape(old_pos, new_pos)

Translate the shape such that old_pos becomes new_pos in canvas coordinates

move_with_selection(delta_x, delta_y)

Translate the shape together with other selected items delta_x, delta_y: translation in plot coordinates

orientation()
Returns:

Orientation of the plot item

See also

:py:meth`setOrientation()`

paintRect(xMap, yMap)

Calculate the bounding paint rectangle of 2 maps

Parameters:
  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns:

Bounding paint rectangle of the scale maps, not normalized

pen()
Returns:

Pen used to draw the lines

See also

setPen(), brush()

plot()
Returns:

attached plot

rtti()
Returns:

QwtPlotItem.Rtti_PlotCurve

sample(index)
Parameters:

index (int) – Index

Returns:

Sample at position index

scaleRect(xMap, yMap)

Calculate the bounding scale rectangle of 2 maps

Parameters:
  • xMap (qwt.scale_map.QwtScaleMap) – Maps x-values into pixel coordinates.

  • yMap (qwt.scale_map.QwtScaleMap) – Maps y-values into pixel coordinates.

Returns:

Bounding scale rect of the scale maps, not normalized

select()

Select item

serialize(writer)

Serialize object to HDF5 writer

setAxes(xAxis, yAxis)

Set X and Y axis

The item will painted according to the coordinates of its Axes.

Parameters:
  • xAxis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

  • yAxis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

setAxis(xAxis, yAxis)

Set X and Y axis

Warning

setAxis has been removed in Qwt6: please use setAxes() instead

setBaseline(value)

Set the value of the baseline

The baseline is needed for filling the curve with a brush or the Sticks drawing style.

The interpretation of the baseline depends on the orientation(). With Qt.Horizontal, the baseline is interpreted as a horizontal line at y = baseline(), with Qt.Vertical, it is interpreted as a vertical line at x = baseline().

The default value is 0.0.

Parameters:

value (float) – Value of the baseline

setBrush(brush)

Assign a brush.

In case of brush.style() != QBrush.NoBrush and style() != QwtPlotCurve.Sticks the area between the curve and the baseline will be filled.

In case not brush.color().isValid() the area will be filled by pen.color(). The fill algorithm simply connects the first and the last curve point to the baseline. So the curve data has to be sorted (ascending or descending).

Parameters:

brush (QBrush or QColor) – New brush

setCurveAttribute(attribute, on=True)

Specify an attribute for drawing the curve

Supported curve attributes:

  • QwtPlotCurve.Inverted

Parameters:
  • attribute (int) – Curve attribute

  • on (bool) – On/Off

setData(*args, **kwargs)

Initialize data with a series data object or an array of points.

setData(data):
Parameters:

data (.plot_series.QwtSeriesData) – Series data (e.g. QwtPointArrayData instance)

setData(xData, yData, [size=None], [finite=True]):

Initialize data with x and y arrays.

This signature was removed in Qwt6 and is temporarily maintained here to ensure compatibility with Qwt5.

Same as setSamples(x, y, [size=None], [finite=True])

Parameters:
  • x – List/array of x values

  • y – List/array of y values

  • size (int or None) – size of xData and yData

  • finite (bool) – if True, keep only finite array elements (remove all infinity and not a number values), otherwise do not filter array elements

See also

setSamples()

setIcon(icon)

Set item icon

Parameters:

icon (QIcon) – Icon

See also

icon()

setItemAttribute(attribute, on=True)

Toggle an item attribute

Parameters:
  • attribute (int) – Attribute type

  • on (bool) – True/False

setItemInterest(interest, on=True)

Toggle an item interest

Parameters:
  • attribute (int) – Interest type

  • on (bool) – True/False

setLegendAttribute(attribute, on=True)

Specify an attribute how to draw the legend icon

Legend attributes:

  • QwtPlotCurve.LegendNoAttribute

  • QwtPlotCurve.LegendShowLine

  • QwtPlotCurve.LegendShowSymbol

  • QwtPlotCurve.LegendShowBrush

Parameters:
  • attribute (int) – Legend attribute

  • on (bool) – On/Off

setLegendIconSize(size)

Set the size of the legend icon

The default setting is 8x8 pixels

Parameters:

size (QSize) – Size

setOrientation(orientation)

Set the orientation of the item. Default is Qt.Horizontal.

The orientation() might be used in specific way by a plot item. F.e. a QwtPlotCurve uses it to identify how to display the curve int QwtPlotCurve.Steps or QwtPlotCurve.Sticks style.

See also

:py:meth`orientation()`

setPen(*args)

Build and/or assign a pen, depending on the arguments.

setPen(color, width, style)

Build and assign a pen

In Qt5 the default pen width is 1.0 ( 0.0 in Qt4 ) what makes it non cosmetic (see QPen.isCosmetic()). This method signature has been introduced to hide this incompatibility.

Parameters:
  • color (QColor) – Pen color

  • width (float) – Pen width

  • style (Qt.PenStyle) – Pen style

setPen(pen)

Assign a pen

Parameters:

pen (QPen) – New pen

See also

pen(), brush()

setRectOfInterest(rect)

Set a the “rect of interest” for the series

Parameters:

rect (QRectF) – Rectangle of interest

See also

qwt.plot_series.QwtSeriesData.setRectOfInterest()

setRenderHint(hint, on=True)

Toggle a render hint

Parameters:
  • hint (int) – Render hint

  • on (bool) – True/False

See also

testRenderHint()

setSamples(*args, **kwargs)

Initialize data with an array of points.

setSamples(data):
Parameters:

data (.plot_series.QwtSeriesData) – Series data (e.g. QwtPointArrayData instance)

setSamples(samples):

Same as setData(QwtPointArrayData(samples))

Parameters:

samples – List/array of points

setSamples(xData, yData, [size=None], [finite=True]):

Same as setData(QwtPointArrayData(xData, yData, [size=None]))

Parameters:
  • xData – List/array of x values

  • yData – List/array of y values

  • size (int or None) – size of xData and yData

  • finite (bool) – if True, keep only finite array elements (remove all infinity and not a number values), otherwise do not filter array elements

See also

plot_series.QwtPointArrayData

setStyle(style)

Set the curve’s drawing style

Valid curve styles:

  • QwtPlotCurve.NoCurve

  • QwtPlotCurve.Lines

  • QwtPlotCurve.Sticks

  • QwtPlotCurve.Steps

  • QwtPlotCurve.Dots

  • QwtPlotCurve.UserCurve

Parameters:

style (int) – Curve style

See also

style()

setSymbol(symbol)

Assign a symbol

The curve will take the ownership of the symbol, hence the previously set symbol will be delete by setting a new one. If symbol is None no symbol will be drawn.

Parameters:

symbol (qwt.symbol.QwtSymbol) – Symbol

See also

symbol()

setTitle(title)

Set a new title

Parameters:

title (qwt.text.QwtText or str) – Title

See also

title()

setVisible(on)

Show/Hide the item

Parameters:

on (bool) – Show if True, otherwise hide

setXAxis(axis)

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters:

axis (int) – X Axis (QwtPlot.xBottom or QwtPlot.xTop)

setYAxis(axis)

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters:

axis (int) – Y Axis (QwtPlot.yLeft or QwtPlot.yRight)

setZ(z)

Set the z value

Plot items are painted in increasing z-order.

Parameters:

z (float) – Z-value

See also

z(), QwtPlotDict.itemList()

set_data(x, y)
Set curve data:
  • x: NumPy array

  • y: NumPy array

set_movable(state)

Set item movable state

set_private(state)

Set object as private

set_readonly(state)

Set object readonly state

set_resizable(state)

Set item resizable state (or any action triggered when moving an handle, e.g. rotation)

set_rotatable(state)

Set item rotatable state

set_selectable(state)

Set item selectable state

show()

Show the item

style()
Returns:

Style of the curve

See also

setStyle()

swapData(series)

Replace a series without deleting the previous one

Parameters:

series (qwt.plot_series.QwtSeriesData) – New series

Returns:

Previously assigned series

symbol()
Returns:

Current symbol or None, when no symbol has been assigned

See also

setSymbol()

testCurveAttribute(attribute)
Returns:

True, if attribute is enabled

testItemAttribute(attribute)

Test an item attribute

Parameters:

attribute (int) – Attribute type

Returns:

True/False

testItemInterest(interest)

Test an item interest

Parameters:

attribute (int) – Interest type

Returns:

True/False

testLegendAttribute(attribute)
Parameters:

attribute (int) – Legend attribute

Returns:

True, when attribute is enabled

testRenderHint(hint)

Test a render hint

Parameters:

attribute (int) – Render hint

Returns:

True/False

See also

setRenderHint()

title()
Returns:

Title of the item

See also

setTitle()

unselect()

Unselect item

updateLegend(item, data)

Update the item to changes of the legend info

Plot items that want to display a legend ( not those, that want to be displayed on a legend ! ) will have to implement updateLegend().

updateLegend() is only called when the LegendInterest interest is enabled. The default implementation does nothing.

Parameters:
  • item (qwt.plot.QwtPlotItem) – Plot item to be displayed on a legend

  • data (list) – Attributes how to display item on the legend

Note

Plot items, that want to be displayed on a legend need to enable the QwtPlotItem.Legend flag and to implement legendData() and legendIcon()

xAxis()
Returns:

xAxis

yAxis()
Returns:

yAxis

z()

Plot items are painted in increasing z-order.

Returns:

item z order

See also

setZ(), QwtPlotDict.itemList()

class guiqwt.histogram.ContrastAdjustment(parent=None)[source]

Contrast adjustment tool

register_panel(manager)[source]

Register panel to plot manager

configure_panel()[source]

Configure panel

closeEvent(self, a0: QCloseEvent | None)[source]
class PaintDeviceMetric
class RenderFlag
class RenderFlags
class RenderFlags(f: QWidget.RenderFlags | QWidget.RenderFlag)
class RenderFlags(a0: QWidget.RenderFlags)
SIG_VISIBILITY_CHANGED

Signal emitted by PanelWidget when its visibility has changed (arg: bool)

acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent | None)
actions(self) List[QAction]
activateWindow(self)
addAction(self, action: QAction | None)
addActions(self, actions: Iterable[QAction])
adjustSize(self)
autoFillBackground(self) bool
backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
changeEvent(self, a0: QEvent | None)
childAt(self, p: QPoint) QWidget | None
childAt(self, ax: int, ay: int) QWidget | None
childEvent(self, a0: QChildEvent | None)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
close(self) bool
colorCount(self) int
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent | None)
contextMenuPolicy(self) Qt.ContextMenuPolicy
create(self, window: PyQt5.sip.voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow | None, parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = 0) QWidget
create_dockwidget(title: str) tuple[QDockWidget, DockWidgetArea]

Add to parent QMainWindow as a dock widget

Args:

title (str): Dockwidget title

Returns:

tuple[QDockWidget, Qt.DockWidgetArea]: Dockwidget and location

cursor(self) QCursor
customEvent(self, a0: QEvent | None)
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
devType(self) int
devicePixelRatio(self) int
devicePixelRatioF(self) float
devicePixelRatioFScale() float
disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
dragEnterEvent(self, a0: QDragEnterEvent | None)
dragLeaveEvent(self, a0: QDragLeaveEvent | None)
dragMoveEvent(self, a0: QDragMoveEvent | None)
dropEvent(self, a0: QDropEvent | None)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
effectiveWinId(self) PyQt5.sip.voidptr
ensurePolished(self)
enterEvent(self, a0: QEvent | None)
event(self, a0: QEvent | None) bool
eventFilter(self, a0: QObject | None, a1: QEvent | None) bool
find(a0: PyQt5.sip.voidptr) QWidget | None
findChild(self, type: Type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) QObjectT
findChild(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) QObjectT
findChildren(self, type: Type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, type: Type[QObjectT], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, types: Tuple[Type[QObjectT], ...], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, type: Type[QObjectT], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, types: Tuple[Type[QObjectT], ...], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
focusInEvent(self, a0: QFocusEvent | None)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, a0: QFocusEvent | None)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget | None
focusWidget(self) QWidget | None
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameSize(self) QSize
geometry(self) QRect
getContentsMargins(self)
get_focus_widget() QWidget | None

Return widget to focus when dockwidget is visible

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(-1, -1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlags | Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: QCursor | Qt.CursorShape) None
grabShortcut(self, key: QKeySequence | QKeySequence.StandardKey | str | None | int, context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect | None
graphicsProxyWidget(self) QGraphicsProxyWidget | None
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hide(self)
hideEvent(self, a0: QHideEvent | None)
inherits(self, classname: str | None) bool
initPainter(self, painter: QPainter | None)
inputMethodEvent(self, a0: QInputMethodEvent | None)
inputMethodHints(self) Qt.InputMethodHints
inputMethodQuery(self, a0: Qt.InputMethodQuery) Any
insertAction(self, before: QAction | None, action: QAction | None)
insertActions(self, before: QAction | None, actions: Iterable[QAction])
installEventFilter(self, a0: QObject | None)
isActiveWindow(self) bool
isAncestorOf(self, child: QWidget | None) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget | None) bool
isFullScreen(self) bool
isHidden(self) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isRightToLeft(self) bool
isSignalConnected(self, signal: QMetaMethod) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget | None) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
is_visible() bool

Return dockwidget visibility state

keyPressEvent(self, a0: QKeyEvent | None)
keyReleaseEvent(self, a0: QKeyEvent | None)
keyboardGrabber() QWidget | None
killTimer(self, id: int)
layout(self) QLayout | None
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent | None)
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self)
mapFrom(self, a0: QWidget | None, a1: QPoint) QPoint
mapFromGlobal(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPoint) QPoint
mapTo(self, a0: QWidget | None, a1: QPoint) QPoint
mapToGlobal(self, a0: QPoint) QPoint
mapToParent(self, a0: QPoint) QPoint
mask(self) QRegion
maximumHeight(self) int
maximumSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject | None
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
minimumHeight(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
mouseDoubleClickEvent(self, a0: QMouseEvent | None)
mouseGrabber() QWidget | None
mouseMoveEvent(self, a0: QMouseEvent | None)
mousePressEvent(self, a0: QMouseEvent | None)
mouseReleaseEvent(self, a0: QMouseEvent | None)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveEvent(self, a0: QMoveEvent | None)
moveToThread(self, thread: QThread | None)
nativeEvent(self, eventType: QByteArray | bytes | bytearray, message: PyQt5.sip.voidptr | None)
nativeParentWidget(self) QWidget | None
nextInFocusChain(self) QWidget | None
normalGeometry(self) QRect
objectName(self) str
overrideWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)
overrideWindowState(self, state: Qt.WindowStates | Qt.WindowState)
paintEngine(self) QPaintEngine | None
paintEvent(self, a0: QPaintEvent | None)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject | None
parentWidget(self) QWidget | None
property parent_widget: QWidget | None

Return associated QWidget parent

physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
previousInFocusChain(self) QWidget | None
property(self, name: str | None) Any
pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)
receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction | None)
removeEventFilter(self, a0: QObject | None)
render(self, target: QPaintDevice | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))
render(self, painter: QPainter | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeEvent(self, a0: QResizeEvent | None)
restoreGeometry(self, geometry: QByteArray | bytes | bytearray) bool
saveGeometry(self) QByteArray
screen(self) QScreen | None
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
sender(self) QObject | None
senderSignalIndex(self) int
setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str | None)
setAccessibleName(self, name: str | None)
setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCursor(self, a0: QCursor | Qt.CursorShape)
setDisabled(self, a0: bool)
setEnabled(self, a0: bool)
setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int)
setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget | None)
setFont(self, a0: QFont)
setForegroundRole(self, a0: QPalette.ColorRole)
setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect | None)
setHidden(self, hidden: bool)
setInputMethodHints(self, hints: Qt.InputMethodHints | Qt.InputMethodHint)
setLayout(self, a0: QLayout | None)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximumHeight(self, maxh: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMinimumHeight(self, minh: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str | None)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget | None)
setParent(self, parent: QWidget | None, f: Qt.WindowFlags | Qt.WindowType) None
setProperty(self, name: str | None, value: Any) bool
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setStatusTip(self, a0: str | None)
setStyle(self, a0: QStyle | None)
setStyleSheet(self, styleSheet: str | None)
setTabOrder(a0: QWidget | None, a1: QWidget | None)
setTabletTracking(self, enable: bool)
setToolTip(self, a0: str | None)
setToolTipDuration(self, msec: int)
setUpdatesEnabled(self, enable: bool)
setVisible(self, visible: bool)
setWhatsThis(self, a0: str | None)
setWindowFilePath(self, filePath: str | None)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str | None)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str | None)
setWindowState(self, state: Qt.WindowStates | Qt.WindowState)
setWindowTitle(self, a0: str | None)
setup_dockwidget(location: DockWidgetArea | None = None, features: DockWidgetFeatures | None = None, allowed_areas: DockWidgetAreas | None = None) None

Setup dockwidget parameters

Args:

location (Qt.DockWidgetArea): Dockwidget location features (QDockWidget.DockWidgetFeatures): Dockwidget features allowed_areas (Qt.DockWidgetAreas): Dockwidget allowed areas

sharedPainter(self) QPainter | None
show(self)
showEvent(self, a0: QShowEvent | None)
showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
signalsBlocked(self) bool
size(self) QSize
sizeHint(self) QSize
sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
stackUnder(self, a0: QWidget | None)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
statusTip(self) str
style(self) QStyle | None
styleSheet(self) str
tabletEvent(self, a0: QTabletEvent | None)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
thread(self) QThread | None
timerEvent(self, a0: QTimerEvent | None)
toolTip(self) str
toolTipDuration(self) int
tr(self, sourceText: str | None, disambiguation: str | None = None, n: int = -1) str
underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, a0: QRect) None
update(self, a0: QRegion) None
update(self, ax: int, ay: int, aw: int, ah: int) None
updateGeometry(self)
updateMicroFocus(self)
updatesEnabled(self) bool
visibility_changed(enable)

DockWidget visibility has changed

visibleRegion(self) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent | None)
width(self) int
widthMM(self) int
winId(self) PyQt5.sip.voidptr
window(self) QWidget | None
windowFilePath(self) str
windowFlags(self) Qt.WindowFlags
windowHandle(self) QWindow | None
windowIcon(self) QIcon
windowIconText(self) str
windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowStates
windowTitle(self) str
windowType(self) Qt.WindowType
x(self) int
y(self) int
set_range(_min, _max)[source]

Set contrast panel’s histogram range

class guiqwt.histogram.LevelsHistogram(parent=None)[source]

Image levels histogram widget

SIG_VOI_CHANGED

Signal emitted by LevelsHistogram when LUT range was changed

set_full_range()[source]

Set range bounds to image min/max levels

eliminate_outliers(percent)[source]

Eliminate outliers: eliminate percent/2*N counts on each side of the histogram (where N is the total count number)

DEFAULT_ITEM_TYPE

alias of ICurveItemType

class PaintDeviceMetric
class RenderFlag
class RenderFlags
class RenderFlags(f: QWidget.RenderFlags | QWidget.RenderFlag)
class RenderFlags(a0: QWidget.RenderFlags)
SIG_ACTIVE_ITEM_CHANGED

Signal emitted by plot when selected item has changed

SIG_ANNOTATION_CHANGED

Signal emitted by plot when an annotation.AnnotatedShape position changes

SIG_AXES_CHANGED

Signal emitted by plot when a shapes.Axes position (or the angle) changes

SIG_AXIS_DIRECTION_CHANGED

Signal emitted by plot when any plot axis direction has changed

SIG_CS_CURVE_CHANGED

Signal emitted by cross section plot when cross section curve data has changed

SIG_ITEMS_CHANGED

Signal emitted by plot when item list has changed (item removed, added, …)

SIG_ITEM_HANDLE_MOVED

Signal emitted by plot when an IBasePlotItem handle was moved

SIG_ITEM_MOVED

Signal emitted by plot when an IBasePlotItem object was moved (args: x0, y0, x1, y1)

SIG_ITEM_REMOVED

Signal emitted by plot when an item was deleted from the item list or using the delete item tool

SIG_ITEM_SELECTION_CHANGED

Signal emitted by plot when an item is selected

SIG_LUT_CHANGED

Signal emitted by plot when LUT has been changed by the user

SIG_MARKER_CHANGED

Signal emitted by plot when a shapes.Marker position changes

SIG_MASK_CHANGED

Signal emitted by plot when image mask has changed

SIG_PLOT_AXIS_CHANGED

Signal emitted by plot when plot axis has changed, e.g. when panning/zooming (arg: plot))

SIG_PLOT_LABELS_CHANGED

Signal emitted by plot when plot’s title or any axis label has changed

SIG_RANGE_CHANGED

Signal emitted by plot when the a shapes.XRangeSelection range changes

class Shadow
class Shape
class StyleMask
acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent | None)
actions(self) List[QAction]
activateWindow(self)
addAction(self, action: QAction | None)
addActions(self, actions: Iterable[QAction])
add_item(item, z=None)

Add a plot item instance to this plot widget

  • item: qwt.QwtPlotItem object implementing the guiqwt.interfaces.IBasePlotItem interface

  • z: item’s z order (None -> z = max(self.get_items())+1)

add_item_with_z_offset(item, zoffset)

Add a plot item instance within a specified z range, over zmin

adjustSize(self)
attachItem(plotItem, on)

Attach/Detach a plot item

Parameters:
  • plotItem (qwt.plot.QwtPlotItem) – Plot item

  • on (bool) – When true attach the item, otherwise detach it

autoFillBackground(self) bool
autoRefresh()

Replots the plot if autoReplot() is True.

autoReplot()
Returns:

True if the autoReplot option is set.

See also

setAutoReplot()

axisAutoScale(axisId)
Parameters:

axisId (int) – Axis index

Returns:

True, if autoscaling is enabled

axisEnabled(axisId)
Parameters:

axisId (int) – Axis index

Returns:

True, if a specified axis is enabled

axisFont(axisId)
Parameters:

axisId (int) – Axis index

Returns:

The font of the scale labels for a specified axis

axisInterval(axisId)
Parameters:

axisId (int) – Axis index

Returns:

The current interval of the specified axis

This is only a convenience function for axisScaleDiv(axisId).interval()

See also

qwt.scale_div.QwtScaleDiv, axisScaleDiv()

axisMaxMajor(axisId)
Parameters:

axisId (int) – Axis index

Returns:

The maximum number of major ticks for a specified axis

See also

setAxisMaxMajor(), qwt.scale_engine.QwtScaleEngine.divideScale()

axisMaxMinor(axisId)
Parameters:

axisId (int) – Axis index

Returns:

The maximum number of minor ticks for a specified axis

See also

setAxisMaxMinor(), qwt.scale_engine.QwtScaleEngine.divideScale()

axisScaleDiv(axisId)
Parameters:

axisId (int) – Axis index

Returns:

The scale division of a specified axis

axisScaleDiv(axisId).lowerBound(), axisScaleDiv(axisId).upperBound() are the current limits of the axis scale.

See also

qwt.scale_div.QwtScaleDiv, setAxisScaleDiv(), qwt.scale_engine.QwtScaleEngine.divideScale()

axisScaleDraw(axisId)
Parameters:

axisId (int) – Axis index

Returns:

Specified scaleDraw for axis, or NULL if axis is invalid.

axisScaleEngine(axisId)
Parameters:

axisId (int) – Axis index

Returns:

Scale engine for a specific axis

axisStepSize(axisId)
Parameters:

axisId (int) – Axis index

Returns:

step size parameter value

This doesn’t need to be the step size of the current scale.

See also

setAxisScale(), qwt.scale_engine.QwtScaleEngine.divideScale()

axisTitle(axisId)
Parameters:

axisId (int) – Axis index

Returns:

Title of a specified axis

axisValid(axis_id)
Parameters:

axis_id (int) – Axis

Returns:

True if the specified axis exists, otherwise False

axisWidget(axisId)
Parameters:

axisId (int) – Axis index

Returns:

Scale widget of the specified axis, or None if axisId is invalid.

backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
canvas()
Returns:

the plot’s canvas

canvasBackground()
Returns:

Background brush of the plotting area.

canvasMap(axisId)
Parameters:

axisId (int) – Axis

Returns:

Map for the axis on the canvas. With this map pixel coordinates can translated to plot coordinates and vice versa.

See also

qwt.scale_map.QwtScaleMap, transform(), invTransform()

changeEvent(self, a0: QEvent | None)
childAt(self, p: QPoint) QWidget | None
childAt(self, ax: int, ay: int) QWidget | None
childEvent(self, a0: QChildEvent | None)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
close(self) bool
closeEvent(self, a0: QCloseEvent | None)
colorCount(self) int
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent | None)
contextMenuPolicy(self) Qt.ContextMenuPolicy
copy_to_clipboard()

Copy widget’s window to clipboard

create(self, window: PyQt5.sip.voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow | None, parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = 0) QWidget
cursor(self) QCursor
customEvent(self, a0: QEvent | None)
del_all_items(except_grid=True)

Del all items, eventually (default) except grid

del_item(item)

Remove item from widget Convenience function (see ‘del_items’)

del_items(items)

Remove item from widget

deleteLater(self)
depth(self) int
deserialize(reader)
Restore items from HDF5 file:
  • reader: guidata.dataset.io.HDF5Reader object

See also guiqwt.baseplot.BasePlot.save_items_to_hdf5()

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
detachItems(rtti=None)

Detach items from the dictionary

Parameters:

rtti (int or None) – In case of QwtPlotItem.Rtti_PlotItem or None (default) detach all items otherwise only those items of the type rtti.

Note

This was a member of QwtPlotDict in older versions.

devType(self) int
devicePixelRatio(self) int
devicePixelRatioF(self) float
devicePixelRatioFScale() float
disable_autoscale()

Re-apply the axis scales so as to disable autoscaling without changing the view

disable_unused_axes()

Disable unused axes

disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
do_autoscale(replot=True, axis_id=None)

Do autoscale on all axes

do_pan_view(dx, dy)

Translate the active axes by dx, dy dx, dy are tuples composed of (initial pos, dest pos)

do_zoom_view(dx, dy, lock_aspect_ratio=False)

Change the scale of the active axes (zoom/dezoom) according to dx, dy dx, dy are tuples composed of (initial pos, dest pos) We try to keep initial pos fixed on the canvas as the scale changes

dragEnterEvent(self, a0: QDragEnterEvent | None)
dragLeaveEvent(self, a0: QDragLeaveEvent | None)
dragMoveEvent(self, a0: QDragMoveEvent | None)
drawCanvas(painter)

Redraw the canvas.

Parameters:

painter (QPainter) – Painter used for drawing

Warning

drawCanvas calls drawItems what is also used for printing. Applications that like to add individual plot items better overload drawItems()

See also

getCanvasMarginsHint(), QwtPlotItem.getCanvasMarginHint()

drawFrame(self, a0: QPainter | None)
drawItems(painter, canvasRect, maps)

Redraw the canvas.

Parameters:
  • painter (QPainter) – Painter used for drawing

  • canvasRect (QRectF) – Bounding rectangle where to paint

  • maps (list) – QwtPlot.axisCnt maps, mapping between plot and paint device coordinates

Note

Usually canvasRect is contentsRect() of the plot canvas. Due to a bug in Qt this rectangle might be wrong for certain frame styles ( f.e QFrame.Box ) and it might be necessary to fix the margins manually using QWidget.setContentsMargins()

dropEvent(self, a0: QDropEvent | None)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
edit_axis_parameters(axis_id)

Edit axis parameters

edit_plot_parameters(key)

Edit plot parameters

effectiveWinId(self) PyQt5.sip.voidptr
enableAxis(axisId, tf=True)

Enable or disable a specified axis

When an axis is disabled, this only means that it is not visible on the screen. Curves, markers and can be attached to disabled axes, and transformation of screen coordinates into values works as normal.

Only xBottom and yLeft are enabled by default.

Parameters:
  • axisId (int) – Axis index

  • tf (bool) – True (enabled) or False (disabled)

enable_used_axes()

Enable only used axes For now, this is needed only by the pyplot interface

ensurePolished(self)
enterEvent(self, a0: QEvent | None)
event(self, e: QEvent | None) bool
eventFilter(self, a0: QObject | None, a1: QEvent | None) bool
exportTo(filename, size=(800, 600), size_mm=None, resolution=85, format_=None)

Export plot to PDF or image file (SVG, PNG, …)

Parameters:
  • filename (str) – Filename

  • size (tuple) – (width, height) size in pixels

  • size_mm (tuple) – (width, height) size in millimeters

  • resolution (int) – Resolution in dots per Inch (dpi)

  • format (str) – File format (PDF, SVG, PNG, …)

find(a0: PyQt5.sip.voidptr) QWidget | None
findChild(self, type: Type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) QObjectT
findChild(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) QObjectT
findChildren(self, type: Type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, types: Tuple[Type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, type: Type[QObjectT], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, types: Tuple[Type[QObjectT], ...], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, type: Type[QObjectT], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
findChildren(self, types: Tuple[Type[QObjectT], ...], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObjectT]
flatStyle()
Returns:

True if the flatStyle option is set.

See also

setFlatStyle()

focusInEvent(self, a0: QFocusEvent | None)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, a0: QFocusEvent | None)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget | None
focusWidget(self) QWidget | None
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
footer()
Returns:

Text of the footer

See also

setFooter()

footerLabel()
Returns:

Footer label widget.

foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameRect(self) QRect
frameShadow(self) QFrame.Shadow
frameShape(self) QFrame.Shape
frameSize(self) QSize
frameStyle(self) int
frameWidth(self) int
geometry(self) QRect
getCanvasMarginsHint(maps, canvasRect)

Calculate the canvas margins

Parameters:
  • maps (list) – QwtPlot.axisCnt maps, mapping between plot and paint device coordinates

  • canvasRect (QRectF) – Bounding rectangle where to paint

Plot items might indicate, that they need some extra space at the borders of the canvas by the QwtPlotItem.Margins flag.

See also

updateCanvasMargins(), getCanvasMarginHint()

getContentsMargins(self)
get_active_axes()

Return active axes

get_active_item(force=False)

Return active item Force item activation if there is no active item

get_axesparam_class(item)

Return AxesParam dataset class associated to item’s type

get_axis_color(axis_id)

Get axis color (color name, i.e. string)

get_axis_direction(axis_id)

Return axis direction of increasing values

  • axis_id: axis id (BasePlot.Y_LEFT, BasePlot.X_BOTTOM, …) or string: ‘bottom’, ‘left’, ‘top’ or ‘right’

get_axis_font(axis_id)

Get axis font

get_axis_id(axis_name)

Return axis ID from axis name If axis ID is passed directly, check the ID

get_axis_limits(axis_id)

Return axis limits (minimum and maximum values)

get_axis_scale(axis_id)

Return the name (‘lin’ or ‘log’) of the scale used by axis

get_axis_title(axis_id)

Get axis title

get_axis_unit(axis_id)

Get axis unit

get_context_menu()

Return widget context menu

get_default_item()

Return default item, depending on plot’s default item type (e.g. for a curve plot, this is a curve item type).

Return nothing if there is more than one item matching the default item type.

get_items(z_sorted=False, item_type=None)

Return widget’s item list (items are based on IBasePlotItem’s interface)

get_last_active_item(item_type)

Return last active item corresponding to passed item_type

get_max_z()

Return maximum z-order for all items registered in plot If there is no item, return 0

get_nearest_object(pos, close_dist=0)

Return nearest item from position ‘pos’

If close_dist > 0:

Return the first found item (higher z) which distance to ‘pos’ is less than close_dist

else:

Return the closest item

get_nearest_object_in_z(pos)

Return nearest item for which position ‘pos’ is inside of it (iterate over items with respect to their ‘z’ coordinate)

get_plot_limits(xaxis='bottom', yaxis='left')

Return plot scale limits

get_plot_parameters(key, itemparams)

Return a list of DataSets for a given parameter key the datasets will be edited and passed back to set_plot_parameters

this is a generic interface to help building context menus using the BasePlotMenuTool

get_private_items(z_sorted=False, item_type=None)

Return widget’s private item list (items are based on IBasePlotItem’s interface)

get_public_items(z_sorted=False, item_type=None)

Return widget’s public item list (items are based on IBasePlotItem’s interface)

get_scales()

Return active curve scales

get_selected_items(z_sorted=False, item_type=None)

Return selected items

get_title()

Get plot title

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(-1, -1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlags | Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: QCursor | Qt.CursorShape) None
grabShortcut(self, key: QKeySequence | QKeySequence.StandardKey | str | None | int, context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect | None
graphicsProxyWidget(self) QGraphicsProxyWidget | None
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hide(self)
hideEvent(self, a0: QHideEvent | None)
hide_items(items=None, item_type=None)

Hide items (if items is None, hide all items)

inherits(self, classname: str | None) bool
initAxesData()

Initialize axes

initPainter(self, painter: QPainter | None)
initStyleOption(self, option: QStyleOptionFrame | None)
inputMethodEvent(self, a0: QInputMethodEvent | None)
inputMethodHints(self) Qt.InputMethodHints
inputMethodQuery(self, a0: Qt.InputMethodQuery) Any
insertAction(self, before: QAction | None, action: QAction | None)
insertActions(self, before: QAction | None, actions: Iterable[QAction])
insertItem(item)

Insert a plot item

Parameters:

item (qwt.plot.QwtPlotItem) – PlotItem

See also

removeItem()

Note

This was a member of QwtPlotDict in older versions.

insertLegend(legend, pos=None, ratio=-1)

Insert a legend

If the position legend is QwtPlot.LeftLegend or QwtPlot.RightLegend the legend will be organized in one column from top to down. Otherwise the legend items will be placed in a table with a best fit number of columns from left to right.

insertLegend() will set the plot widget as parent for the legend. The legend will be deleted in the destructor of the plot or when another legend is inserted.

Legends, that are not inserted into the layout of the plot widget need to connect to the legendDataChanged() signal. Calling updateLegend() initiates this signal for an initial update. When the application code wants to implement its own layout this also needs to be done for rendering plots to a document ( see QwtPlotRenderer ).

Parameters:
  • legend (qwt.legend.QwtAbstractLegend) – Legend

  • pos (QwtPlot.LegendPosition) – The legend’s position.

  • ratio (float) – Ratio between legend and the bounding rectangle of title, canvas and axes

Note

For top/left position the number of columns will be limited to 1, otherwise it will be set to unlimited.

Note

The legend will be shrunk if it would need more space than the given ratio. The ratio is limited to ]0.0 .. 1.0]. In case of <= 0.0 it will be reset to the default ratio. The default vertical/horizontal ratio is 0.33/0.5.

See also

legend(), qwt.plot_layout.QwtPlotLayout.legendPosition(), qwt.plot_layout.QwtPlotLayout.setLegendPosition()

installEventFilter(self, a0: QObject | None)
invTransform(axisId, pos)

Transform the x or y coordinate of a position in the drawing region into a value.

Parameters:
  • axisId (int) – Axis index

  • pos (int) – position

Warning

The position can be an x or a y coordinate, depending on the specified axis.

invalidate()

Invalidate paint cache and schedule redraw use instead of replot when only the content of the canvas needs redrawing (axes, shouldn’t change)

isActiveWindow(self) bool
isAncestorOf(self, child: QWidget | None) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget | None) bool
isFullScreen(self) bool
isHidden(self) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isRightToLeft(self) bool
isSignalConnected(self, signal: QMetaMethod) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget | None) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
itemList(rtti=None)

A list of attached plot items.

Use caution when iterating these lists, as removing/detaching an item will invalidate the iterator. Instead you can place pointers to objects to be removed in a removal list, and traverse that list later.

Parameters:

rtti (int) – In case of QwtPlotItem.Rtti_PlotItem detach all items otherwise only those items of the type rtti.

Returns:

List of all attached plot items of a specific type. If rtti is None, return a list of all attached plot items.

Note

This was a member of QwtPlotDict in older versions.

keyPressEvent(self, a0: QKeyEvent | None)
keyReleaseEvent(self, a0: QKeyEvent | None)
keyboardGrabber() QWidget | None
killTimer(self, id: int)
layout(self) QLayout | None
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent | None)
legend()
Returns:

the plot’s legend

See also

insertLegend()

lineWidth(self) int
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self)
mapFrom(self, a0: QWidget | None, a1: QPoint) QPoint
mapFromGlobal(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPoint) QPoint
mapTo(self, a0: QWidget | None, a1: QPoint) QPoint
mapToGlobal(self, a0: QPoint) QPoint
mapToParent(self, a0: QPoint) QPoint
mask(self) QRegion
maximumHeight(self) int
maximumSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject | None
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
midLineWidth(self) int
minimumHeight(self) int
minimumSize(self) QSize
minimumSizeHint()
Returns:

Return a minimum size hint

minimumWidth(self) int
mouseDoubleClickEvent(event)

Reimplement QWidget method

mouseGrabber() QWidget | None
mouseMoveEvent(self, a0: QMouseEvent | None)
mousePressEvent(self, a0: QMouseEvent | None)
mouseReleaseEvent(self, a0: QMouseEvent | None)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveEvent(self, a0: QMoveEvent | None)
moveToThread(self, thread: QThread | None)
move_down(item_list)

Move item(s) down, i.e. to the background (swap item with the previous item in z-order)

item: plot item or list of plot items

Return True if items have been moved effectively

move_up(item_list)

Move item(s) up, i.e. to the foreground (swap item with the next item in z-order)

item: plot item or list of plot items

Return True if items have been moved effectively

nativeEvent(self, eventType: QByteArray | bytes | bytearray, message: PyQt5.sip.voidptr | None)
nativeParentWidget(self) QWidget | None
nextInFocusChain(self) QWidget | None
normalGeometry(self) QRect
objectName(self) str
overrideWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)
overrideWindowState(self, state: Qt.WindowStates | Qt.WindowState)
paintEngine(self) QPaintEngine | None
paintEvent(self, a0: QPaintEvent | None)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject | None
parentWidget(self) QWidget | None
physicalDpiX(self) int
physicalDpiY(self) int
plotLayout()
Returns:

the plot’s layout

See also

setPlotLayout()

pos(self) QPoint
previousInFocusChain(self) QWidget | None
print_(printer)

Print plot to printer

Parameters:

printer (QPaintDevice or QPrinter or QSvgGenerator) – Printer

property(self, name: str | None) Any
pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)
read_axes_styles(section, options)

Read axes styles from section and options (one option for each axis in the order left, right, bottom, top)

Skip axis if option is None

receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction | None)
removeEventFilter(self, a0: QObject | None)
removeItem(item)

Remove a plot item

Parameters:

item (qwt.plot.QwtPlotItem) – PlotItem

See also

insertItem()

Note

This was a member of QwtPlotDict in older versions.

render(self, target: QPaintDevice | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))
render(self, painter: QPainter | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
replot()

Redraw the plot

If the autoReplot option is not set (which is the default) or if any curves are attached to raw data, the plot has to be refreshed explicitly in order to make changes visible.

resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeEvent(self, a0: QResizeEvent | None)
restoreGeometry(self, geometry: QByteArray | bytes | bytearray) bool
restore_items(iofile)
Restore items from file using the pickle protocol
  • iofile: file object or filename

See also guiqwt.baseplot.BasePlot.save_items()

saveGeometry(self) QByteArray
save_items(iofile, selected=False)
Save (serializable) items to file using the pickle protocol
  • iofile: file object or filename

  • selected=False: if True, will save only selected items

See also guiqwt.baseplot.BasePlot.restore_items()

save_widget(fname)

Grab widget’s window and save it to filename (*.png, *.pdf)

screen(self) QScreen | None
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
select_all()

Select all selectable items

select_item(item)

Select item

select_some_items(items)

Select items

sender(self) QObject | None
senderSignalIndex(self) int
serialize(writer, selected=False)
Save (serializable) items to HDF5 file:
  • writer: guidata.dataset.io.HDF5Writer object

  • selected=False: if True, will save only selected items

See also guiqwt.baseplot.BasePlot.restore_items_from_hdf5()

setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str | None)
setAccessibleName(self, name: str | None)
setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setAutoReplot(tf=True)

Set or reset the autoReplot option

If the autoReplot option is set, the plot will be updated implicitly by manipulating member functions. Since this may be time-consuming, it is recommended to leave this option switched off and call replot() explicitly if necessary.

The autoReplot option is set to false by default, which means that the user has to call replot() in order to make changes visible.

Parameters:

tf (bool) – True or False. Defaults to True.

See also

autoReplot()

setAxisAutoScale(axisId, on=True)

Enable autoscaling for a specified axis

This member function is used to switch back to autoscaling mode after a fixed scale has been set. Autoscaling is enabled by default.

Parameters:
  • axisId (int) – Axis index

  • on (bool) – On/Off

Note

The autoscaling flag has no effect until updateAxes() is executed ( called by replot() ).

setAxisFont(axisId, font)

Change the font of an axis

Parameters:
  • axisId (int) – Axis index

  • font (QFont) – Font

Warning

This function changes the font of the tick labels, not of the axis title.

setAxisLabelAlignment(axisId, alignment)

Change the alignment of the tick labels

Parameters:
  • axisId (int) – Axis index

  • alignment (Qt.Alignment) – Or’d Qt.AlignmentFlags

See also

qwt.scale_draw.QwtScaleDraw.setLabelAlignment()

setAxisLabelAutoSize(axisId, state)

Set tick labels automatic size option (default: on)

Parameters:
  • axisId (int) – Axis index

  • state (bool) – On/off

See also

qwt.scale_draw.QwtScaleDraw.setLabelAutoSize()

setAxisLabelRotation(axisId, rotation)

Rotate all tick labels

Parameters:
  • axisId (int) – Axis index

  • rotation (float) – Angle in degrees. When changing the label rotation, the label alignment might be adjusted too.

See also

setLabelRotation(), setAxisLabelAlignment()

setAxisMaxMajor(axisId, maxMajor)

Set the maximum number of major scale intervals for a specified axis

Parameters:
  • axisId (int) – Axis index

  • maxMajor (int) – Maximum number of major steps

See also

axisMaxMajor()

setAxisMaxMinor(axisId, maxMinor)

Set the maximum number of minor scale intervals for a specified axis

Parameters:
  • axisId (int) – Axis index

  • maxMinor (int) – Maximum number of minor steps

See also

axisMaxMinor()

setAxisScale(axisId, min_, max_, stepSize=0)

Disable autoscaling and specify a fixed scale for a selected axis.

In updateAxes() the scale engine calculates a scale division from the specified parameters, that will be assigned to the scale widget. So updates of the scale widget usually happen delayed with the next replot.

Parameters:
  • axisId (int) – Axis index

  • min (float) – Minimum of the scale

  • max (float) – Maximum of the scale

  • stepSize (float) – Major step size. If <code>step == 0</code>, the step size is calculated automatically using the maxMajor setting.

See also

setAxisMaxMajor(), setAxisAutoScale(), axisStepSize(), qwt.scale_engine.QwtScaleEngine.divideScale()

setAxisScaleDiv(axisId, scaleDiv)

Disable autoscaling and specify a fixed scale for a selected axis.

The scale division will be stored locally only until the next call of updateAxes(). So updates of the scale widget usually happen delayed with the next replot.

Parameters:
  • axisId (int) – Axis index

  • scaleDiv (qwt.scale_div.QwtScaleDiv) – Scale division

setAxisScaleDraw(axisId, scaleDraw)

Set a scale draw

Parameters:
  • axisId (int) – Axis index

  • scaleDraw (qwt.scale_draw.QwtScaleDraw) – Object responsible for drawing scales.

By passing scaleDraw it is possible to extend QwtScaleDraw functionality and let it take place in QwtPlot. Please note that scaleDraw has to be created with new and will be deleted by the corresponding QwtScale member ( like a child object ).

See also

qwt.scale_draw.QwtScaleDraw, qwt.scale_widget.QwtScaleWigdet

Warning

The attributes of scaleDraw will be overwritten by those of the previous QwtScaleDraw.

setAxisScaleEngine(axisId, scaleEngine)

Change the scale engine for an axis

Parameters:
  • axisId (int) – Axis index

  • scaleEngine (qwt.scale_engine.QwtScaleEngine) – Scale engine

setAxisTitle(axisId, title)

Change the title of a specified axis

Parameters:
  • axisId (int) – Axis index

  • title (qwt.text.QwtText or str) – axis title

setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setCanvas(canvas)

Set the drawing canvas of the plot widget.

The default canvas is a QwtPlotCanvas.

Parameters:

canvas (QWidget) – Canvas Widget

See also

canvas()

setCanvasBackground(brush)

Change the background of the plotting area

Sets brush to QPalette.Window of all color groups of the palette of the canvas. Using canvas().setPalette() is a more powerful way to set these colors.

Parameters:

brush (QBrush) – New background brush

setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCursor(self, a0: QCursor | Qt.CursorShape)
setDisabled(self, a0: bool)
setEnabled(self, a0: bool)
setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int)
setFlatStyle(state)

Set or reset the flatStyle option

If the flatStyle option is set, the plot will be rendered without any margin (scales, canvas, layout).

Enabling this option makes the plot look flat and compact.

The flatStyle option is set to True by default.

Parameters:

state (bool) – True or False.

See also

flatStyle()

setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget | None)
setFont(self, a0: QFont)
setFooter(text)

Change the text the footer

Parameters:

text (str or qwt.text.QwtText) – New text of the footer

See also

footer()

setForegroundRole(self, a0: QPalette.ColorRole)
setFrameRect(self, a0: QRect)
setFrameShadow(self, a0: QFrame.Shadow)
setFrameShape(self, a0: QFrame.Shape)
setFrameStyle(self, a0: int)
setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect | None)
setHidden(self, hidden: bool)
setInputMethodHints(self, hints: Qt.InputMethodHints | Qt.InputMethodHint)
setLayout(self, a0: QLayout | None)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLineWidth(self, a0: int)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximumHeight(self, maxh: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMidLineWidth(self, a0: int)
setMinimumHeight(self, minh: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str | None)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget | None)
setParent(self, parent: QWidget | None, f: Qt.WindowFlags | Qt.WindowType) None
setPlotLayout(layout)

Assign a new plot layout

Parameters:

layout (qwt.plot_layout.QwtPlotLayout) – Layout

See also

plotLayout()

setProperty(self, name: str | None, value: Any) bool
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setStatusTip(self, a0: str | None)
setStyle(self, a0: QStyle | None)
setStyleSheet(self, styleSheet: str | None)
setTabOrder(a0: QWidget | None, a1: QWidget | None)
setTabletTracking(self, enable: bool)
setTitle(title)

Change the plot’s title

Parameters:

title (str or qwt.text.QwtText) – New title

See also

title()

setToolTip(self, a0: str | None)
setToolTipDuration(self, msec: int)
setUpdatesEnabled(self, enable: bool)
setVisible(self, visible: bool)
setWhatsThis(self, a0: str | None)
setWindowFilePath(self, filePath: str | None)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str | None)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str | None)
setWindowState(self, state: Qt.WindowStates | Qt.WindowState)
setWindowTitle(self, a0: str | None)
set_active_item(item)

Override base set_active_item to change the grid’s axes according to the selected item

set_antialiasing(checked)

Toggle curve antialiasing

set_axis_color(axis_id, color)

Set axis color color: color name (string) or QColor instance

set_axis_direction(axis_id, reverse=False)

Set axis direction of increasing values

  • axis_id: axis id (BasePlot.Y_LEFT, BasePlot.X_BOTTOM, …) or string: ‘bottom’, ‘left’, ‘top’ or ‘right’

  • reverse: False (default)
    • x-axis values increase from left to right

    • y-axis values increase from bottom to top

  • reverse: True
    • x-axis values increase from right to left

    • y-axis values increase from top to bottom

set_axis_font(axis_id, font)

Set axis font

set_axis_limits(axis_id, vmin, vmax, stepsize=0)

Set axis limits (minimum and maximum values)

set_axis_scale(axis_id, scale, autoscale=True)

Set axis scale Example: self.set_axis_scale(curve.yAxis(), ‘lin’)

set_axis_ticks(axis_id, nmajor=None, nminor=None)

Set axis maximum number of major ticks and maximum of minor ticks

set_axis_title(axis_id, text)

Set axis title

set_axis_unit(axis_id, text)

Set axis unit

set_item_parameters(itemparams)

Set item (plot, here) parameters

set_item_visible(item, state, notify=True, replot=True)

Show/hide item and emit a SIG_ITEMS_CHANGED signal

set_items(*args)

Utility function used to quickly setup a plot with a set of items

set_items_readonly(state)

Set all items readonly state to state Default item’s readonly state: False (items may be deleted)

set_manager(manager, plot_id)

Set the associated guiqwt.plot.PlotManager instance

set_plot_limits(x0, x1, y0, y1, xaxis='bottom', yaxis='left')

Set plot scale limits

set_pointer(pointer_type)

Set pointer.

Valid values of pointer_type:

  • None: disable pointer

  • “canvas”: enable canvas pointer

  • “curve”: enable on-curve pointer

set_scales(xscale, yscale)

Set active curve scales Example: self.set_scales(‘lin’, ‘lin’)

set_title(title)

Set plot title

set_titles(title=None, xlabel=None, ylabel=None, xunit=None, yunit=None)

Set plot and axes titles at once

  • title: plot title

  • xlabel: (bottom axis title, top axis title) or bottom axis title only

  • ylabel: (left axis title, right axis title) or left axis title only

  • xunit: (bottom axis unit, top axis unit) or bottom axis unit only

  • yunit: (left axis unit, right axis unit) or left axis unit only

sharedPainter(self) QPainter | None
show(self)
showEvent(event)

Reimplement Qwt method

showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
show_items(items=None, item_type=None)

Show items (if items is None, show all items)

signalsBlocked(self) bool
size(self) QSize
sizeHint()

Preferred size

sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
stackUnder(self, a0: QWidget | None)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
statusTip(self) str
style(self) QStyle | None
styleSheet(self) str
tabletEvent(self, a0: QTabletEvent | None)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
thread(self) QThread | None
timerEvent(self, a0: QTimerEvent | None)
title()
Returns:

Title of the plot

See also

setTitle()

titleLabel()
Returns:

Title label widget.

toolTip(self) str
toolTipDuration(self) int
tr(self, sourceText: str | None, disambiguation: str | None = None, n: int = -1) str
transform(axisId, value)

Transform a value into a coordinate in the plotting region

Parameters:
  • axisId (int) – Axis index

  • value (fload) – Value

Returns:

X or Y coordinate in the plotting region corresponding to the value.

underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unselect_all()

Unselect all selected items

unselect_item(item)

Unselect item

unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, a0: QRect) None
update(self, a0: QRegion) None
update(self, ax: int, ay: int, aw: int, ah: int) None
updateAxes()

Rebuild the axes scales

In case of autoscaling the boundaries of a scale are calculated from the bounding rectangles of all plot items, having the QwtPlotItem.AutoScale flag enabled (QwtScaleEngine.autoScale()). Then a scale division is calculated (QwtScaleEngine.didvideScale()) and assigned to scale widget.

When the scale boundaries have been assigned with setAxisScale() a scale division is calculated (QwtScaleEngine.didvideScale()) for this interval and assigned to the scale widget.

When the scale has been set explicitly by setAxisScaleDiv() the locally stored scale division gets assigned to the scale widget.

The scale widget indicates modifications by emitting a QwtScaleWidget.scaleDivChanged() signal.

updateAxes() is usually called by replot().

See also

setAxisAutoScale(), setAxisScale(), setAxisScaleDiv(), replot(), QwtPlotItem.boundingRect()

updateCanvasMargins()

Update the canvas margins

Plot items might indicate, that they need some extra space at the borders of the canvas by the QwtPlotItem.Margins flag.

See also

getCanvasMarginsHint(), QwtPlotItem.getCanvasMarginHint()

updateGeometry(self)
updateLayout()

Adjust plot content to its current size.

See also

resizeEvent()

updateLegend(plotItem=None)

If plotItem is None, emit QwtPlot.legendDataChanged for all plot item. Otherwise, emit the signal for passed plot item.

Parameters:

plotItem (qwt.plot.QwtPlotItem) – Plot item

See also

QwtPlotItem.legendData(), QwtPlot.legendDataChanged

updateLegendItems(plotItem, legendData)

Update all plot items interested in legend attributes

Call QwtPlotItem.updateLegend(), when the QwtPlotItem.LegendInterest flag is set.

Parameters:
  • plotItem (qwt.plot.QwtPlotItem) – Plot item

  • legendData (list) – Entries to be displayed for the plot item ( usually 1 )

See also

QwtPlotItem.LegendInterest(), QwtPlotItem.updateLegend()

updateMicroFocus(self)
update_all_axes_styles()

Update all axes styles

update_axis_style(axis_id)

Update axis style

updatesEnabled(self) bool
visibleRegion(self) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent | None)
width(self) int
widthMM(self) int
winId(self) PyQt5.sip.voidptr
window(self) QWidget | None
windowFilePath(self) str
windowFlags(self) Qt.WindowFlags
windowHandle(self) QWindow | None
windowIcon(self) QIcon
windowIconText(self) str
windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowStates
windowTitle(self) str
windowType(self) Qt.WindowType
x(self) int
y(self) int