plotpy.baseplot

The baseplot module provides the plotpy plotting widget base class: plotpy.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

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

See also

Module plotpy.curve

Module providing curve-related plot items and plotting widgets

Module plotpy.image

Module providing image-related plot items and plotting widgets

Module plotpy.plot

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

Reference

class plotpy.baseplot.BasePlot(parent=None, section='plot')

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

canvas()

Returns:the plot’s canvas

mouseDoubleClickEvent(event)

Reimplement QWidget method

showEvent(event)

Reimplement Qwt method

set_manager(manager, plot_id)

Set the associated plotpy.plot.PlotManager instance

sizeHint()

Preferred size

get_title()

Get plot title

set_title(title)

Set plot title

get_axis_id(axis_name)

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

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

get_axis_title(axis_id)

Get axis title

set_axis_title(axis_id, text)

Set axis title

get_axis_unit(axis_id)

Get axis unit

set_axis_unit(axis_id, text)

Set axis unit

get_axis_font(axis_id)

Get axis font

set_axis_font(axis_id, font)

Set axis font

get_axis_color(axis_id)

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

set_axis_color(axis_id, color)

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

update_axis_style(axis_id)

Update axis style

update_all_axes_styles()

Update all axes styles

get_axis_limits(axis_id)

Return axis limits (minimum and maximum values)

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

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

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

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

get_axis_scale(axis_id)

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

set_axis_scale(axis_id, scale, autoscale=True)

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

get_scales()

Return active curve scales

set_scales(xscale, yscale)

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

enable_used_axes()

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

disable_unused_axes()

Disable unused axes

get_items(z_sorted=False, item_type=None)

Return widget’s 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_private_items(z_sorted=False, item_type=None)

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

copy_to_clipboard()

Copy widget’s window to clipboard

save_widget(fname)

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

get_selected_items(z_sorted=False, item_type=None)

Return selected items

get_max_z()

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

add_item(item, z=None)

Add a plot item instance to this plot widget

item: qwt.QwtPlotItem object implementing

the IBasePlotItem interface (plotpy.interfaces)

add_item_with_z_offset(item, zoffset)

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

del_items(items)

Remove item from widget

del_item(item)

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

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

Show/hide item and emit a SIG_ITEMS_CHANGED signal

show_items(items=None, item_type=None)

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

hide_items(items=None, item_type=None)

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

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 plotpy.baseplot.BasePlot.restore_items()

restore_items(iofile)

Restore items from file using the pickle protocol

• iofile: file object or filename

See also plotpy.baseplot.BasePlot.save_items()

serialize(writer, selected=False)

Save (serializable) items to HDF5 file:

• writer: guidata.hdf5io.HDF5Writer object
• selected=False: if True, will save only selected items

See also plotpy.baseplot.BasePlot.restore_items_from_hdf5()

deserialize(reader)

Restore items from HDF5 file:

• reader: guidata.hdf5io.HDF5Reader object

See also plotpy.baseplot.BasePlot.save_items_to_hdf5()

set_items(*args)

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

del_all_items()

Remove (detach) all attached items

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

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

set_items_readonly(state)

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

select_item(item)

Select item

unselect_item(item)

Unselect item

get_last_active_item(item_type)

Return last active item corresponding to passed item_type

select_all()

Select all selectable items

unselect_all()

Unselect all selected items

select_some_items(items)

Select items

set_active_item(item)

Set active item, and unselect the old active item

get_active_axes()

Return active axes

get_active_item(force=False)

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

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_context_menu()

Return widget context menu

get_axesparam_class(item)

Return AxesParam dataset class associated to item’s type

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

set_item_parameters(itemparams)

Set item (plot, here) parameters

edit_plot_parameters(key)

Edit plot parameters

edit_axis_parameters(axis_id)

Edit axis parameters

do_autoscale(replot=True, axis_id=None)

Do autoscale on all axes

disable_autoscale()

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

invalidate()

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

class RenderFlags(QWidget.RenderFlags)

QWidget.RenderFlags(int) QWidget.RenderFlags()

BasePlot.acceptDrops() → bool

BasePlot.accessibleDescription() → str

BasePlot.accessibleName() → str

BasePlot.actions() → list-of-QAction

BasePlot.activateWindow()

BasePlot.addAction(QAction)

BasePlot.addActions(list-of-QAction)

BasePlot.adjustSize()

BasePlot.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

BasePlot.autoDelete()

Returns:true if auto deletion is enabled

See also

setAutoDelete(), insertItem()

BasePlot.autoFillBackground() → bool

BasePlot.autoRefresh()

Replots the plot if autoReplot() is True.

BasePlot.autoReplot()

Returns:True if the autoReplot option is set.

See also

setAutoReplot()

BasePlot.axisAutoScale(axisId)

Parameters:axisId (int) – Axis index Returns:True, if autoscaling is enabled

BasePlot.axisEnabled(axisId)

Parameters:axisId (int) – Axis index Returns:True, if a specified axis is enabled

BasePlot.axisFont(axisId)

Parameters:axisId (int) – Axis index Returns:The font of the scale labels for a specified axis

BasePlot.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()

BasePlot.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()

BasePlot.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()

BasePlot.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()

BasePlot.axisScaleDraw(axisId)

Parameters:axisId (int) – Axis index Returns:Specified scaleDraw for axis, or NULL if axis is invalid.

BasePlot.axisScaleEngine(axisId)

Parameters:axisId (int) – Axis index Returns:Scale engine for a specific axis

See also

setAxisScaleEngine()

BasePlot.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()

BasePlot.axisTitle(axisId)

Parameters:axisId (int) – Axis index Returns:Title of a specified axis

BasePlot.axisValid(axisId)

Parameters:axisId (int) – Axis Returns:True if the specified axis exists, otherwise False

BasePlot.axisWidget(axisId)

Parameters:axisId (int) – Axis index Returns:Scale widget of the specified axis, or None if axisId is invalid.

BasePlot.backgroundRole() → QPalette.ColorRole

BasePlot.baseSize() → QSize

BasePlot.blockSignals(bool) → bool

BasePlot.canvasBackground()

Returns:Background brush of the plotting area.

See also

setCanvasBackground()

BasePlot.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()

BasePlot.changeEvent(QEvent)

BasePlot.childAt(QPoint) → QWidget

QWidget.childAt(int, int) -> QWidget

BasePlot.children() → list-of-QObject

BasePlot.childrenRect() → QRect

BasePlot.childrenRegion() → QRegion

BasePlot.clearFocus()

BasePlot.clearMask()

BasePlot.close() → bool

BasePlot.colorCount() → int

BasePlot.connect(QObject, SIGNAL(), QObject, SLOT(), Qt.ConnectionType=Qt.AutoConnection) → bool

QObject.connect(QObject, SIGNAL(), callable, Qt.ConnectionType=Qt.AutoConnection) -> bool QObject.connect(QObject, SIGNAL(), SLOT(), Qt.ConnectionType=Qt.AutoConnection) -> bool

BasePlot.contentsMargins() → QMargins

BasePlot.contentsRect() → QRect

BasePlot.contextMenuPolicy() → Qt.ContextMenuPolicy

BasePlot.cursor() → QCursor

BasePlot.customContextMenuRequested

QWidget.customContextMenuRequested[QPoint] [signal]

BasePlot.deleteLater()

BasePlot.depth() → int

BasePlot.destroyed

QObject.destroyed[QObject] [signal] QObject.destroyed [signal]

BasePlot.detachItems(rtti, autoDelete)

Detach items from the dictionary

Parameters:

• rtti (int) – In case of QwtPlotItem.Rtti_PlotItem detach all items otherwise only those items of the type rtti.
• autoDelete (bool) – If true, delete all detached items

BasePlot.devType() → int

BasePlot.disconnect(QObject, SIGNAL(), QObject, SLOT()) → bool

QObject.disconnect(QObject, SIGNAL(), callable) -> bool

BasePlot.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()

BasePlot.drawFrame(QPainter)

BasePlot.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()

BasePlot.dumpObjectInfo()

BasePlot.dumpObjectTree()

BasePlot.dynamicPropertyNames() → list-of-QByteArray

BasePlot.effectiveWinId() → sip.voidptr

BasePlot.emit(SIGNAL(), ...)

BasePlot.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)

BasePlot.ensurePolished()

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

BasePlot.find(sip.voidptr) → QWidget

BasePlot.findChild(type, str name='') → QObject

QObject.findChild(tuple, str name=’‘) -> QObject

BasePlot.findChildren(type, str name='') → list-of-QObject

QObject.findChildren(tuple, str name=’‘) -> list-of-QObject QObject.findChildren(type, QRegExp) -> list-of-QObject QObject.findChildren(tuple, QRegExp) -> list-of-QObject

BasePlot.focusPolicy() → Qt.FocusPolicy

BasePlot.focusProxy() → QWidget

BasePlot.focusWidget() → QWidget

BasePlot.font() → QFont

BasePlot.fontInfo() → QFontInfo

BasePlot.fontMetrics() → QFontMetrics

BasePlot.footer()

Returns:Text of the footer

See also

setFooter()

BasePlot.footerLabel()

Returns:Footer label widget.

BasePlot.foregroundRole() → QPalette.ColorRole

BasePlot.frameGeometry() → QRect

BasePlot.frameRect() → QRect

BasePlot.frameShadow() → QFrame.Shadow

BasePlot.frameShape() → QFrame.Shape

BasePlot.frameSize() → QSize

BasePlot.frameStyle() → int

BasePlot.frameWidth() → int

BasePlot.geometry() → QRect

BasePlot.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()

BasePlot.getContentsMargins() -> (int, int, int, int)

BasePlot.grabGesture(Qt.GestureType, Qt.GestureFlags flags=Qt.GestureFlags(0))

BasePlot.grabKeyboard()

BasePlot.grabMouse()

QWidget.grabMouse(QCursor)

BasePlot.grabShortcut(QKeySequence, Qt.ShortcutContext context=Qt.WindowShortcut) → int

BasePlot.graphicsEffect() → QGraphicsEffect

BasePlot.graphicsProxyWidget() → QGraphicsProxyWidget

BasePlot.hasFocus() → bool

BasePlot.hasMouseTracking() → bool

BasePlot.height() → int

BasePlot.heightForWidth(int) → int

BasePlot.heightMM() → int

BasePlot.hide()

BasePlot.inherits(str) → bool

BasePlot.initAxesData()

Initialize axes

BasePlot.inputContext() → QInputContext

BasePlot.inputMethodHints() → Qt.InputMethodHints

BasePlot.inputMethodQuery(Qt.InputMethodQuery) → object

BasePlot.insertAction(QAction, QAction)

BasePlot.insertActions(QAction, list-of-QAction)

BasePlot.insertItem(item)

Insert a plot item

Parameters:item (qwt.plot.QwtPlotItem) – PlotItem

See also

removeItem()

BasePlot.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()

BasePlot.installEventFilter(QObject)

BasePlot.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.

BasePlot.isActiveWindow() → bool

BasePlot.isAncestorOf(QWidget) → bool

BasePlot.isEnabled() → bool

BasePlot.isEnabledTo(QWidget) → bool

BasePlot.isEnabledToTLW() → bool

BasePlot.isFullScreen() → bool

BasePlot.isHidden() → bool

BasePlot.isLeftToRight() → bool

BasePlot.isMaximized() → bool

BasePlot.isMinimized() → bool

BasePlot.isModal() → bool

BasePlot.isRightToLeft() → bool

BasePlot.isTopLevel() → bool

BasePlot.isVisible() → bool

BasePlot.isVisibleTo(QWidget) → bool

BasePlot.isWidgetType() → bool

BasePlot.isWindow() → bool

BasePlot.isWindowModified() → bool

BasePlot.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.

BasePlot.keyboardGrabber() → QWidget

BasePlot.killTimer(int)

BasePlot.layout() → QLayout

BasePlot.layoutDirection() → Qt.LayoutDirection

BasePlot.legend()

Returns:the plot’s legend

See also

insertLegend()

BasePlot.lineWidth() → int

BasePlot.locale() → QLocale

BasePlot.logicalDpiX() → int

BasePlot.logicalDpiY() → int

BasePlot.lower()

BasePlot.mapFrom(QWidget, QPoint) → QPoint

BasePlot.mapFromGlobal(QPoint) → QPoint

BasePlot.mapFromParent(QPoint) → QPoint

BasePlot.mapTo(QWidget, QPoint) → QPoint

BasePlot.mapToGlobal(QPoint) → QPoint

BasePlot.mapToParent(QPoint) → QPoint

BasePlot.mask() → QRegion

BasePlot.maximumHeight() → int

BasePlot.maximumSize() → QSize

BasePlot.maximumWidth() → int

BasePlot.metaObject() → QMetaObject

BasePlot.midLineWidth() → int

BasePlot.minimumHeight() → int

BasePlot.minimumSize() → QSize

BasePlot.minimumSizeHint()

Returns:Return a minimum size hint

BasePlot.minimumWidth() → int

BasePlot.mouseGrabber() → QWidget

BasePlot.move(QPoint)

QWidget.move(int, int)

BasePlot.moveToThread(QThread)

BasePlot.nativeParentWidget() → QWidget

BasePlot.nextInFocusChain() → QWidget

BasePlot.normalGeometry() → QRect

BasePlot.numColors() → int

BasePlot.objectName() → str

BasePlot.overrideWindowFlags(Qt.WindowFlags)

BasePlot.overrideWindowState(Qt.WindowStates)

BasePlot.paintEngine() → QPaintEngine

BasePlot.paintEvent(QPaintEvent)

BasePlot.paintingActive() → bool

BasePlot.palette() → QPalette

BasePlot.parent() → QObject

BasePlot.parentWidget() → QWidget

BasePlot.physicalDpiX() → int

BasePlot.physicalDpiY() → int

BasePlot.plotLayout()

Returns:the plot’s layout

See also

setPlotLayout()

BasePlot.pos() → QPoint

BasePlot.previousInFocusChain() → QWidget

BasePlot.print_(printer)

Print plot to printer

Parameters:printer (QPaintDevice or QPrinter or QSvgGenerator) – Printer

BasePlot.property(str) → object

BasePlot.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.

BasePlot.raise_()

BasePlot.rect() → QRect

BasePlot.releaseKeyboard()

BasePlot.releaseMouse()

BasePlot.releaseShortcut(int)

BasePlot.removeAction(QAction)

BasePlot.removeEventFilter(QObject)

BasePlot.removeItem(item)

Remove a plot item

Parameters:item (qwt.plot.QwtPlotItem) – PlotItem

See also

insertItem()

BasePlot.render(QPaintDevice, QPoint targetOffset=QPoint(), QRegion sourceRegion=QRegion(), QWidget.RenderFlags flags=QWidget.DrawWindowBackground|QWidget.DrawChildren)

QWidget.render(QPainter, QPoint targetOffset=QPoint(), QRegion sourceRegion=QRegion(), QWidget.RenderFlags flags=QWidget.DrawWindowBackground|QWidget.DrawChildren)

BasePlot.repaint()

QWidget.repaint(int, int, int, int) QWidget.repaint(QRect) QWidget.repaint(QRegion)

BasePlot.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.

See also

updateAxes(), setAutoReplot()

BasePlot.resize(QSize)

QWidget.resize(int, int)

BasePlot.restoreGeometry(QByteArray) → bool

BasePlot.saveGeometry() → QByteArray

BasePlot.scroll(int, int)

QWidget.scroll(int, int, QRect)

BasePlot.setAcceptDrops(bool)

BasePlot.setAccessibleDescription(str)

BasePlot.setAccessibleName(str)

BasePlot.setAttribute(Qt.WidgetAttribute, bool on=True)

BasePlot.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

See also

autoDelete(), insertItem()

BasePlot.setAutoFillBackground(bool)

BasePlot.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

canvas()

BasePlot.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

See also

setAxisScale(), setAxisScaleDiv(), updateAxes()

Note

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

BasePlot.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.

BasePlot.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()

BasePlot.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()

BasePlot.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()

BasePlot.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()

BasePlot.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()

BasePlot.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()

BasePlot.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

See also

setAxisScale(), setAxisAutoScale()

BasePlot.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.

BasePlot.setAxisScaleEngine(axisId, scaleEngine)

Change the scale engine for an axis

Parameters:

• axisId (int) – Axis index
• scaleEngine (qwt.scale_engine.QwtScaleEngine) – Scale engine

See also

axisScaleEngine()

BasePlot.setAxisTitle(axisId, title)

Change the title of a specified axis

Parameters:

• axisId (int) – Axis index
• title (qwt.text.QwtText or str) – axis title

BasePlot.setBackgroundRole(QPalette.ColorRole)

BasePlot.setBaseSize(int, int)

QWidget.setBaseSize(QSize)

BasePlot.setCanvas(canvas)

Set the drawing canvas of the plot widget.

The default canvas is a QwtPlotCanvas.

Parameters:canvas (QWidget) – Canvas Widget

See also

canvas()

BasePlot.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

See also

canvasBackground()

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

QWidget.setContentsMargins(QMargins)

BasePlot.setContextMenuPolicy(Qt.ContextMenuPolicy)

BasePlot.setCursor(QCursor)

BasePlot.setDisabled(bool)

BasePlot.setEnabled(bool)

BasePlot.setFixedHeight(int)

BasePlot.setFixedSize(QSize)

QWidget.setFixedSize(int, int)

BasePlot.setFixedWidth(int)

BasePlot.setFocus()

QWidget.setFocus(Qt.FocusReason)

BasePlot.setFocusPolicy(Qt.FocusPolicy)

BasePlot.setFocusProxy(QWidget)

BasePlot.setFont(QFont)

BasePlot.setFooter(text)

Change the text the footer

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

See also

footer()

BasePlot.setForegroundRole(QPalette.ColorRole)

BasePlot.setFrameRect(QRect)

BasePlot.setFrameShadow(QFrame.Shadow)

BasePlot.setFrameShape(QFrame.Shape)

BasePlot.setFrameStyle(int)

BasePlot.setGeometry(QRect)

QWidget.setGeometry(int, int, int, int)

BasePlot.setGraphicsEffect(QGraphicsEffect)

BasePlot.setHidden(bool)

BasePlot.setInputContext(QInputContext)

BasePlot.setInputMethodHints(Qt.InputMethodHints)

BasePlot.setLayout(QLayout)

BasePlot.setLayoutDirection(Qt.LayoutDirection)

BasePlot.setLineWidth(int)

BasePlot.setLocale(QLocale)

BasePlot.setMask(QBitmap)

QWidget.setMask(QRegion)

BasePlot.setMaximumHeight(int)

BasePlot.setMaximumSize(int, int)

QWidget.setMaximumSize(QSize)

BasePlot.setMaximumWidth(int)

BasePlot.setMidLineWidth(int)

BasePlot.setMinimumHeight(int)

BasePlot.setMinimumSize(int, int)

QWidget.setMinimumSize(QSize)

BasePlot.setMinimumWidth(int)

BasePlot.setMouseTracking(bool)

BasePlot.setObjectName(str)

BasePlot.setPalette(QPalette)

BasePlot.setParent(QWidget)

QWidget.setParent(QWidget, Qt.WindowFlags)

BasePlot.setPlotLayout(layout)

Assign a new plot layout

Parameters:layout (qwt.plot_layout.QwtPlotLayout) – Layout

See also

plotLayout()

BasePlot.setProperty(str, object) → bool

BasePlot.setShortcutAutoRepeat(int, bool enabled=True)

BasePlot.setShortcutEnabled(int, bool enabled=True)

BasePlot.setShown(bool)

BasePlot.setSizeIncrement(int, int)

QWidget.setSizeIncrement(QSize)

BasePlot.setSizePolicy(QSizePolicy)

QWidget.setSizePolicy(QSizePolicy.Policy, QSizePolicy.Policy)

BasePlot.setStatusTip(str)

BasePlot.setStyle(QStyle)

BasePlot.setStyleSheet(str)

BasePlot.setTabOrder(QWidget, QWidget)

BasePlot.setTitle(title)

Change the plot’s title

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

See also

title()

BasePlot.setToolTip(str)

BasePlot.setUpdatesEnabled(bool)

BasePlot.setVisible(bool)

BasePlot.setWhatsThis(str)

BasePlot.setWindowFilePath(str)

BasePlot.setWindowFlags(Qt.WindowFlags)

BasePlot.setWindowIcon(QIcon)

BasePlot.setWindowIconText(str)

BasePlot.setWindowModality(Qt.WindowModality)

BasePlot.setWindowModified(bool)

BasePlot.setWindowOpacity(float)

BasePlot.setWindowRole(str)

BasePlot.setWindowState(Qt.WindowStates)

BasePlot.setWindowTitle(str)

BasePlot.show()

BasePlot.showFullScreen()

BasePlot.showMaximized()

BasePlot.showMinimized()

BasePlot.showNormal()

BasePlot.signalsBlocked() → bool

BasePlot.size() → QSize

BasePlot.sizeIncrement() → QSize

BasePlot.sizePolicy() → QSizePolicy

BasePlot.stackUnder(QWidget)

BasePlot.startTimer(int) → int

BasePlot.statusTip() → str

BasePlot.style() → QStyle

BasePlot.styleSheet() → str

BasePlot.testAttribute(Qt.WidgetAttribute) → bool

BasePlot.thread() → QThread

BasePlot.title()

Returns:Title of the plot

See also

setTitle()

BasePlot.titleLabel()

Returns:Title label widget.

BasePlot.toolTip() → str

BasePlot.topLevelWidget() → QWidget

BasePlot.tr(str, str disambiguation=None, int n=-1) → str

BasePlot.trUtf8(str, str disambiguation=None, int n=-1) → str

BasePlot.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.

BasePlot.underMouse() → bool

BasePlot.ungrabGesture(Qt.GestureType)

BasePlot.unsetCursor()

BasePlot.unsetLayoutDirection()

BasePlot.unsetLocale()

BasePlot.update()

QWidget.update(QRect) QWidget.update(QRegion) QWidget.update(int, int, int, int)

BasePlot.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()

BasePlot.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()

BasePlot.updateGeometry()

BasePlot.updateLayout()

Adjust plot content to its current size.

See also

resizeEvent()

BasePlot.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

BasePlot.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()

BasePlot.updatesEnabled() → bool

BasePlot.visibleRegion() → QRegion

BasePlot.whatsThis() → str

BasePlot.width() → int

BasePlot.widthMM() → int

BasePlot.winId() → sip.voidptr

BasePlot.window() → QWidget

BasePlot.windowFilePath() → str

BasePlot.windowFlags() → Qt.WindowFlags

BasePlot.windowIcon() → QIcon

BasePlot.windowIconText() → str

BasePlot.windowModality() → Qt.WindowModality

BasePlot.windowOpacity() → float

BasePlot.windowRole() → str

BasePlot.windowState() → Qt.WindowStates

BasePlot.windowTitle() → str

BasePlot.windowType() → Qt.WindowType

BasePlot.x() → int

BasePlot.y() → int