guiqwt.baseplot

The baseplot module provides the guiqwt plotting widget base class: guiqwt.baseplot.BasePlot. This is an enhanced version of PythonQwt’s QwtPlot plotting widget which supports the following features:

  • add to plot, del from plot, hide/show and save/restore plot items easily

  • item selection and multiple selection

  • active item

  • plot parameters editing

Warning

guiqwt.baseplot.BasePlot is rather an internal class than a ready-to-use plotting widget. The end user should prefer using guiqwt.plot.CurvePlot or guiqwt.plot.ImagePlot.

See also

Module guiqwt.curve

Module providing curve-related plot items and plotting widgets

Module guiqwt.image

Module providing image-related plot items and plotting widgets

Module guiqwt.plot

Module providing ready-to-use curve and image plotting widgets and dialog boxes

Reference

class guiqwt.baseplot.BasePlot(parent=None, section='plot')[source]

An enhanced QwtPlot class that provides methods for handling plotitems and axes better

It distinguishes activatable items from basic QwtPlotItems.

Activatable items must support IBasePlotItem interface and should be added to the plot using add_item methods.

SIG_ITEM_MOVED

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

SIG_MARKER_CHANGED

Signal emitted by plot when a shapes.Marker position changes

SIG_AXES_CHANGED

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

SIG_ANNOTATION_CHANGED

Signal emitted by plot when an annotation.AnnotatedShape position changes

SIG_RANGE_CHANGED

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

SIG_ITEMS_CHANGED

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

SIG_ACTIVE_ITEM_CHANGED

Signal emitted by plot when selected item has changed

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_PLOT_LABELS_CHANGED

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

SIG_AXIS_DIRECTION_CHANGED

Signal emitted by plot when any plot axis direction has changed

SIG_LUT_CHANGED

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

SIG_MASK_CHANGED

Signal emitted by plot when image mask has changed

SIG_CS_CURVE_CHANGED

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

mouseDoubleClickEvent(event)[source]

Reimplement QWidget method

showEvent(event)[source]

Reimplement Qwt method

set_manager(manager, plot_id)[source]

Set the associated guiqwt.plot.PlotManager instance

sizeHint()[source]

Preferred size

get_title()[source]

Get plot title

set_title(title)[source]

Set plot title

get_axis_id(axis_name)[source]

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

read_axes_styles(section, options)[source]

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

get_axis_title(axis_id)[source]

Get axis title

set_axis_title(axis_id, text)[source]

Set axis title

get_axis_unit(axis_id)[source]

Get axis unit

set_axis_unit(axis_id, text)[source]

Set axis unit

get_axis_font(axis_id)[source]

Get axis font

set_axis_font(axis_id, font)[source]

Set axis font

get_axis_color(axis_id)[source]

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

set_axis_color(axis_id, color)[source]

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

update_axis_style(axis_id)[source]

Update axis style

update_all_axes_styles()[source]

Update all axes styles

get_axis_limits(axis_id)[source]

Return axis limits (minimum and maximum values)

set_axis_limits(axis_id, vmin, vmax, stepsize=0)[source]

Set axis limits (minimum and maximum values) and optional step size

set_axis_ticks(axis_id, nmajor=None, nminor=None)[source]

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

get_axis_scale(axis_id)[source]

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

set_axis_scale(axis_id, scale, autoscale=True)[source]

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

get_scales()[source]

Return active curve scales

set_scales(xscale, yscale)[source]

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

enable_used_axes()[source]

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

disable_unused_axes()[source]

Disable unused axes

get_items(z_sorted=False, item_type=None)[source]

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

get_public_items(z_sorted=False, item_type=None)[source]

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

get_private_items(z_sorted=False, item_type=None)[source]

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

copy_to_clipboard()[source]

Copy widget’s window to clipboard

save_widget(fname)[source]

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

get_selected_items(z_sorted=False, item_type=None)[source]

Return selected items

get_max_z()[source]

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

add_item(item, z=None)[source]

Add a plot item instance to this plot widget

item: qwt.QwtPlotItem object implementing

the IBasePlotItem interface (guiqwt.interfaces)

add_item_with_z_offset(item, zoffset)[source]

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

del_items(items)[source]

Remove item from widget

del_item(item)[source]

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

set_item_visible(item, state, notify=True, replot=True)[source]

Show/hide item and emit a SIG_ITEMS_CHANGED signal

show_items(items=None, item_type=None)[source]

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

hide_items(items=None, item_type=None)[source]

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

save_items(iofile, selected=False)[source]
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()

restore_items(iofile)[source]
Restore items from file using the pickle protocol
  • iofile: file object or filename

See also guiqwt.baseplot.BasePlot.save_items()

serialize(writer, selected=False)[source]
Save (serializable) items to HDF5 file:
  • writer: guidata.hdf5io.HDF5Writer object

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

See also guiqwt.baseplot.BasePlot.restore_items_from_hdf5()

deserialize(reader)[source]
Restore items from HDF5 file:
  • reader: guidata.hdf5io.HDF5Reader object

See also guiqwt.baseplot.BasePlot.save_items_to_hdf5()

set_items(*args)[source]

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

del_all_items()[source]

Remove (detach) all attached items

move_up(item_list)[source]

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

move_down(item_list)[source]

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

set_items_readonly(state)[source]

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

select_item(item)[source]

Select item

unselect_item(item)[source]

Unselect item

get_last_active_item(item_type)[source]

Return last active item corresponding to passed item_type

select_all()[source]

Select all selectable items

unselect_all()[source]

Unselect all selected items

select_some_items(items)[source]

Select items

set_active_item(item)[source]

Set active item, and unselect the old active item

get_active_axes()[source]

Return active axes

get_active_item(force=False)[source]

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

get_nearest_object(pos, close_dist=0)[source]

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)[source]

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

get_context_menu()[source]

Return widget context menu

get_axesparam_class(item)[source]

Return AxesParam dataset class associated to item’s type

get_plot_parameters(key, itemparams)[source]

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

set_item_parameters(itemparams)[source]

Set item (plot, here) parameters

edit_plot_parameters(key)[source]

Edit plot parameters

edit_axis_parameters(axis_id)[source]

Edit axis parameters

do_autoscale(replot=True, axis_id=None)[source]

Do autoscale on all axes

disable_autoscale()[source]

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

invalidate()[source]

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

class PaintDeviceMetric
class RenderFlag
class RenderFlags

QWidget.RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) QWidget.RenderFlags(QWidget.RenderFlags)

class Shadow
class Shape
class StyleMask
acceptDrops(self) → bool
accessibleDescription(self) → str
accessibleName(self) → str
actionEvent(self, QActionEvent)
actions(self) → List[QAction]
activateWindow(self)
addAction(self, QAction)
addActions(self, Iterable[QAction])
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

autoDelete()
Returns

true if auto deletion is enabled

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, 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, QEvent)
childAt(self, QPoint) → QWidget

childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)
children(self) → List[QObject]
childrenRect(self) → QRect
childrenRegion(self) → QRegion
clearFocus(self)
clearMask(self)
close(self) → bool
closeEvent(self, QCloseEvent)
colorCount(self) → int
connectNotify(self, QMetaMethod)
contentsMargins(self) → QMargins
contentsRect(self) → QRect
contextMenuEvent(self, QContextMenuEvent)
contextMenuPolicy(self) → Qt.ContextMenuPolicy
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(QWindow, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) → QWidget
cursor(self) → QCursor
customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)
deleteLater(self)
depth(self) → int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

destroyed(self, object: QObject = None) [signal]

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.

devType(self) → int
devicePixelRatio(self) → int
devicePixelRatioF(self) → float
devicePixelRatioFScale() → float
disconnect(QMetaObject.Connection) → bool

disconnect(self)

disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
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, QPainter)
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, QDropEvent)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) → List[QByteArray]
effectiveWinId(self) → 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)

ensurePolished(self)
enterEvent(self, QEvent)
event(self, QEvent) → bool
eventFilter(self, QObject, QEvent) → bool
exportTo(filename, size=800, 600, size_mm=None, resolution=72.0, 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 (float) – Image resolution

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

find(sip.voidptr) → QWidget
findChild(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → QObject

findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

findChildren(self, type, name: str = '', options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

flatStyle()
Returns

True if the flatStyle option is set.

See also

setFlatStyle()

focusInEvent(self, QFocusEvent)
focusNextChild(self) → bool
focusNextPrevChild(self, bool) → bool
focusOutEvent(self, QFocusEvent)
focusPolicy(self) → Qt.FocusPolicy
focusPreviousChild(self) → bool
focusProxy(self) → QWidget
focusWidget(self) → QWidget
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) → Tuple[int, int, int, int]
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) → QPixmap
grabGesture(self, Qt.GestureType, flags: Union[Qt.GestureFlags, Qt.GestureFlag] = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)

grabMouse(self, Union[QCursor, Qt.CursorShape])

grabShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) → int
graphicsEffect(self) → QGraphicsEffect
graphicsProxyWidget(self) → QGraphicsProxyWidget
hasFocus(self) → bool
hasHeightForWidth(self) → bool
hasMouseTracking(self) → bool
hasTabletTracking(self) → bool
height(self) → int
heightForWidth(self, int) → int
heightMM(self) → int
hide(self)
hideEvent(self, QHideEvent)
inherits(self, str) → bool
initAxesData()

Initialize axes

initPainter(self, QPainter)
initStyleOption(self, QStyleOptionFrame)
inputMethodEvent(self, QInputMethodEvent)
inputMethodHints(self) → Qt.InputMethodHints
inputMethodQuery(self, Qt.InputMethodQuery) → Any
BasePlot.insertAction(self, QAction, QAction)
insertActions(self, QAction, Iterable[QAction])
insertItem(item)

Insert a plot item

Parameters

item (qwt.plot.QwtPlotItem) – PlotItem

See also

removeItem()

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, QObject)
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.

isActiveWindow(self) → bool
isAncestorOf(self, QWidget) → bool
isEnabled(self) → bool
isEnabledTo(self, QWidget) → bool
isFullScreen(self) → bool
isHidden(self) → bool
isLeftToRight(self) → bool
isMaximized(self) → bool
isMinimized(self) → bool
isModal(self) → bool
isRightToLeft(self) → bool
isSignalConnected(self, QMetaMethod) → bool
isVisible(self) → bool
isVisibleTo(self, QWidget) → 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.

keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
keyboardGrabber() → QWidget
killTimer(self, int)
layout(self) → QLayout
layoutDirection(self) → Qt.LayoutDirection
leaveEvent(self, QEvent)
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, QWidget, QPoint) → QPoint
mapFromGlobal(self, QPoint) → QPoint
mapFromParent(self, QPoint) → QPoint
mapTo(self, QWidget, QPoint) → QPoint
mapToGlobal(self, QPoint) → QPoint
mapToParent(self, QPoint) → QPoint
mask(self) → QRegion
maximumHeight(self) → int
maximumSize(self) → QSize
maximumWidth(self) → int
metaObject(self) → QMetaObject
metric(self, QPaintDevice.PaintDeviceMetric) → int
midLineWidth(self) → int
minimumHeight(self) → int
minimumSize(self) → QSize
minimumSizeHint()
Returns

Return a minimum size hint

minimumWidth(self) → int
mouseGrabber() → QWidget
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
move(self, QPoint)

move(self, int, int)

moveEvent(self, QMoveEvent)
moveToThread(self, QThread)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]
nativeParentWidget(self) → QWidget
nextInFocusChain(self) → QWidget
normalGeometry(self) → QRect
objectName(self) → str
objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])
overrideWindowState(self, Union[Qt.WindowStates, Qt.WindowState])
paintEngine(self) → QPaintEngine
paintEvent(self, QPaintEvent)
paintingActive(self) → bool
palette(self) → QPalette
parent(self) → QObject
parentWidget(self) → QWidget
physicalDpiX(self) → int
physicalDpiY(self) → int
plotLayout()
Returns

the plot’s layout

See also

setPlotLayout()

pos(self) → QPoint
previousInFocusChain(self) → QWidget
print_(printer)

Print plot to printer

Parameters

printer (QPaintDevice or QPrinter or QSvgGenerator) – Printer

property(self, str) → 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, PYQT_SIGNAL) → int
rect(self) → QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, int)
removeAction(self, QAction)
removeEventFilter(self, QObject)
removeItem(item)

Remove a plot item

Parameters

item (qwt.plot.QwtPlotItem) – PlotItem

See also

insertItem()

render(self, QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))

render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground|QWidget.RenderFlag.DrawChildren))

repaint(self)

repaint(self, int, int, int, int) repaint(self, QRect) repaint(self, QRegion)

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, QSize)

resize(self, int, int)

resizeEvent(self, QResizeEvent)
restoreGeometry(self, Union[QByteArray, bytes, bytearray]) → bool
saveGeometry(self) → QByteArray
screen(self) → QScreen
BasePlot.scroll(self, int, int)

scroll(self, int, int, QRect)

sender(self) → QObject
senderSignalIndex(self) → int
setAcceptDrops(self, bool)
setAccessibleDescription(self, str)
setAccessibleName(self, str)
setAttribute(self, Qt.WidgetAttribute, on: bool = True)
setAutoDelete(autoDelete)

En/Disable Auto deletion

If Auto deletion is on all attached plot items will be deleted in the destructor of QwtPlotDict. The default value is on.

Parameters

autoDelete (bool) – enable/disable

setAutoFillBackground(self, 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, QPalette.ColorRole)
BasePlot.setBaseSize(self, int, int)

setBaseSize(self, QSize)

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

BasePlot.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)
setCursor(self, Union[QCursor, Qt.CursorShape])
setDisabled(self, bool)
setEnabled(self, bool)
setFixedHeight(self, int)
setFixedSize(self, QSize)

setFixedSize(self, int, int)

setFixedWidth(self, 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, Qt.FocusReason)

setFocusPolicy(self, Qt.FocusPolicy)
setFocusProxy(self, QWidget)
setFont(self, 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, QPalette.ColorRole)
setFrameRect(self, QRect)
setFrameShadow(self, QFrame.Shadow)
setFrameShape(self, QFrame.Shape)
setFrameStyle(self, int)
setGeometry(self, QRect)

setGeometry(self, int, int, int, int)

setGraphicsEffect(self, QGraphicsEffect)
setHidden(self, bool)
setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])
setLayout(self, QLayout)
setLayoutDirection(self, Qt.LayoutDirection)
setLineWidth(self, int)
setLocale(self, QLocale)
setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)
BasePlot.setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)
setMidLineWidth(self, int)
setMinimumHeight(self, int)
BasePlot.setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)
setMouseTracking(self, bool)
setObjectName(self, str)
setPalette(self, QPalette)
setParent(self, QWidget)

setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])

setPlotLayout(layout)

Assign a new plot layout

Parameters

layout (qwt.plot_layout.QwtPlotLayout) – Layout

See also

plotLayout()

setProperty(self, str, Any) → bool
setShortcutAutoRepeat(self, int, enabled: bool = True)
setShortcutEnabled(self, int, enabled: bool = True)
BasePlot.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize)

setSizePolicy(self, QSizePolicy)

setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)

setStatusTip(self, str)
setStyle(self, QStyle)
setStyleSheet(self, str)
BasePlot.setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setTitle(title)

Change the plot’s title

Parameters

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

See also

title()

setToolTip(self, str)
setToolTipDuration(self, int)
setUpdatesEnabled(self, bool)
setVisible(self, bool)
setWhatsThis(self, str)
setWindowFilePath(self, str)
setWindowFlag(self, Qt.WindowType, on: bool = True)
setWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])
setWindowIcon(self, QIcon)
setWindowIconText(self, str)
setWindowModality(self, Qt.WindowModality)
setWindowModified(self, bool)
setWindowOpacity(self, float)
setWindowRole(self, str)
setWindowState(self, Union[Qt.WindowStates, Qt.WindowState])
setWindowTitle(self, str)
sharedPainter(self) → QPainter
show(self)
showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
signalsBlocked(self) → bool
size(self) → QSize
sizeIncrement(self) → QSize
sizePolicy(self) → QSizePolicy
stackUnder(self, QWidget)
startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int
statusTip(self) → str
style(self) → QStyle
styleSheet(self) → str
tabletEvent(self, QTabletEvent)
testAttribute(self, Qt.WidgetAttribute) → bool
thread(self) → QThread
timerEvent(self, QTimerEvent)
title()
Returns

Title of the plot

See also

setTitle()

titleLabel()
Returns

Title label widget.

toolTip(self) → str
toolTipDuration(self) → int
tr(self, str, disambiguation: str = 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, Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)

update(self, QRect) update(self, QRegion) update(self, int, int, int, int)

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)
updatesEnabled(self) → bool
visibleRegion(self) → QRegion
whatsThis(self) → str
wheelEvent(self, QWheelEvent)
width(self) → int
widthMM(self) → int
winId(self) → sip.voidptr
window(self) → QWidget
windowFilePath(self) → str
windowFlags(self) → Qt.WindowFlags
windowHandle(self) → QWindow
windowIcon(self) → QIcon
windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str
windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality
windowOpacity(self) → float
windowRole(self) → str
windowState(self) → Qt.WindowStates
windowTitle(self) → str
windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType
x(self) → int
y(self) → int