KPlotWidget

#include <kplotwidget.h>

Inheritance diagram for KPlotWidget:

[legend]

Public Types
enum	Axis { LeftAxis = 0 , BottomAxis , RightAxis , TopAxis }

Public Types inherited from QFrame
enum	Shadow

enum	Shape

enum	StyleMask

Public Types inherited from QWidget
enum	RenderFlag

typedef	RenderFlags

Public Types inherited from QObject
typedef	QObjectList

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric

Properties
QColor	backgroundColor

int	bottomPadding

QColor	foregroundColor

bool	grid

QColor	gridColor

int	leftPadding

bool	objectToolTip

int	rightPadding

int	topPadding

Properties inherited from QFrame
	frameRect

	frameShadow

	frameShape

	frameWidth

	lineWidth

	midLineWidth

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Public Slots
void	setObjectToolTipShown (bool show)

void	setShowGrid (bool show)

Public Member Functions
	KPlotWidget (QWidget *parent=nullptr)

	~KPlotWidget () override

void	addPlotObject (KPlotObject *object)

void	addPlotObjects (const QList< KPlotObject * > &objects)

bool	antialiasing () const

KPlotAxis *	axis (Axis type)

const KPlotAxis *	axis (Axis type) const

QColor	backgroundColor () const

int	bottomPadding () const

void	clearSecondaryLimits ()

QRectF	dataRect () const

QColor	foregroundColor () const

QColor	gridColor () const

bool	isGridShown () const

bool	isObjectToolTipShown () const

int	leftPadding () const

QPointF	mapToWidget (const QPointF &p) const

void	maskAlongLine (const QPointF &p1, const QPointF &p2, float value=1.0f)

void	maskRect (const QRectF &r, float value=1.0f)

QSize	minimumSizeHint () const override

QRect	pixRect () const

void	placeLabel (QPainter painter, KPlotPoint pp)

QList< KPlotObject * >	plotObjects () const

void	removeAllPlotObjects ()

void	replacePlotObject (int i, KPlotObject *o)

void	resetPlot ()

void	resetPlotMask ()

int	rightPadding () const

QRectF	secondaryDataRect () const

void	setAntialiasing (bool b)

void	setAutoDeletePlotObjects (bool autoDelete)

void	setBackgroundColor (const QColor &bg)

void	setBottomPadding (int padding)

void	setDefaultPaddings ()

void	setForegroundColor (const QColor &fg)

void	setGridColor (const QColor &gc)

void	setLeftPadding (int padding)

void	setLimits (double x1, double x2, double y1, double y2)

void	setRightPadding (int padding)

void	setSecondaryLimits (double x1, double x2, double y1, double y2)

void	setTopPadding (int padding)

QSize	sizeHint () const override

int	topPadding () const

Public Member Functions inherited from QFrame
	QFrame (QWidget *parent, Qt::WindowFlags f)

QRect	frameRect () const const

Shadow	frameShadow () const const

Shape	frameShape () const const

int	frameStyle () const const

int	frameWidth () const const

int	lineWidth () const const

int	midLineWidth () const const

void	setFrameRect (const QRect &)

void	setFrameShadow (Shadow)

void	setFrameShape (Shape)

void	setFrameStyle (int style)

void	setLineWidth (int)

void	setMidLineWidth (int)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const const

QString	accessibleDescription () const const

QString	accessibleName () const const

QList< QAction * >	actions () const const

void	activateWindow ()

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text)

QAction *	addAction (const QString &text, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, Args &&... args)

QAction *	addAction (const QString &text, const QKeySequence &shortcut, const QObject receiver, const char member, Qt::ConnectionType type)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) const const

QRect	childrenRect () const const

QRegion	childrenRegion () const const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const const

QRect	contentsRect () const const

Qt::ContextMenuPolicy	contextMenuPolicy () const const

QCursor	cursor () const const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const const

void	ensurePolished () const const

Qt::FocusPolicy	focusPolicy () const const

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () const const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () const const

bool	hasEditFocus () const const

bool	hasFocus () const const

virtual bool	hasHeightForWidth () const const

bool	hasMouseTracking () const const

bool	hasTabletTracking () const const

int	height () const const

virtual int	heightForWidth (int w) const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, const QList< QAction > &actions)

bool	isActiveWindow () const const

bool	isAncestorOf (const QWidget *child) const const

bool	isEnabled () const const

bool	isEnabledTo (const QWidget *ancestor) const const

bool	isFullScreen () const const

bool	isHidden () const const

bool	isMaximized () const const

bool	isMinimized () const const

bool	isModal () const const

bool	isTopLevel () const const

bool	isVisible () const const

bool	isVisibleTo (const QWidget *ancestor) const const

bool	isWindow () const const

bool	isWindowModified () const const

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPointF	mapFrom (const QWidget *parent, const QPointF &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPointF	mapFromGlobal (const QPointF &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPointF	mapFromParent (const QPointF &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPointF	mapTo (const QWidget *parent, const QPointF &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPointF	mapToGlobal (const QPointF &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QPointF	mapToParent (const QPointF &pos) const const

QRegion	mask () const const

int	maximumHeight () const const

QSize	maximumSize () const const

int	maximumWidth () const const

int	minimumHeight () const const

QSize	minimumSize () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

void	raise ()

QRect	rect () const const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () const const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus ()

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setScreen (QScreen *screen)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setTabletTracking (bool enable)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlag (Qt::WindowType flag, bool on)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () const const

QIcon	windowIcon () const const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const const

qreal	windowOpacity () const const

QString	windowRole () const const

Qt::WindowStates	windowState () const const

QString	windowTitle () const const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const const

WId	winId () const const

int	x () const const

int	y () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

qreal	devicePixelRatio () const const

qreal	devicePixelRatioF () const const

int	height () const const

int	heightMM () const const

int	logicalDpiX () const const

int	logicalDpiY () const const

bool	paintingActive () const const

int	physicalDpiX () const const

int	physicalDpiY () const const

int	width () const const

int	widthMM () const const

Protected Member Functions
virtual void	drawAxes (QPainter *p)

bool	event (QEvent *) override

void	paintEvent (QPaintEvent *) override

QList< KPlotPoint * >	pointsUnderPoint (const QPoint &p) const

void	resizeEvent (QResizeEvent *) override

void	setPixRect ()

Protected Member Functions inherited from QFrame
virtual void	changeEvent (QEvent *ev) override

virtual void	initStyleOption (QStyleOptionFrame *option) const const

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEnterEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (PaintDeviceMetric m) const const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus (Qt::InputMethodQuery query)

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Member Functions inherited from QPaintDevice

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

void	setTabOrder (std::initializer_list< QWidget * > widgets)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QFrame
	Box

	HLine

	NoFrame

	Panel

	Plain

	Raised

	Shadow_Mask

	Shape_Mask

	StyledPanel

	Sunken

	VLine

	WinPanel

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

Detailed Description

Generic data plotting widget.

Widget for drawing plots. The basic idea behind KPlotWidget is that you don't have to worry about any transformation from your data's natural units to screen pixel coordinates; this is handled internally by the widget.

Data to be plotted are represented by one or more instances of KPlotObject. KPlotObject contains a list of QPointFs to be plotted (again, in the data's natural units), as well as information about how the data are to be rendered in the plot (i.e., as separate points or connected by lines? With what color and point style? etc). See KPlotObject for more information.

KPlotWidget automatically adds axis labels with tickmarks and tick labels. These are encapsulated in the KPlotAxis class. All you have to do is set the limits of the plotting area in data units, and KPlotWidget will figure out the optimal positions and labels for the tickmarks on the axes.

Example of usage:

KPlotWidget *kpw = new KPlotWidget( parent );
// setting our limits for the plot
kpw->setLimits( 1.0, 5.0, 1.0, 25.0 );
 
// creating a plot object whose points are connected by red lines ...
KPlotObject *kpo = new KPlotObject( Qt::red, KPlotObject::Lines );
// ... adding some points to it ...
for ( float x = 1.0; x <= 5.0; x += 0.1 )
    kpo->addPoint( x, x*x );
 
// ... and adding the object to the plot widget
kpw->addPlotObject( kpo );

Note: KPlotWidget will take ownership of the objects added to it, so when clearing the objects list (eg with removeAllPlotObjects()) any previous reference to a KPlotObject already added to a KPlotWidget will be invalid. You can disable this behavior by using setAutoDelete(false).

Author: Jason Harris

Definition at line 69 of file kplotwidget.h.

Member Enumeration Documentation

◆ Axis

enum KPlotWidget::Axis

The four types of plot axes.

Enumerator
LeftAxis	the left axis
BottomAxis	the bottom axis
RightAxis	the right axis
TopAxis	the top axis

Definition at line 96 of file kplotwidget.h.

Property Documentation

◆ backgroundColor

QColor KPlotWidget::backgroundColor

readwrite

Definition at line 76 of file kplotwidget.h.

◆ bottomPadding

int KPlotWidget::bottomPadding

read

Definition at line 75 of file kplotwidget.h.

◆ foregroundColor

QColor KPlotWidget::foregroundColor

readwrite

Definition at line 77 of file kplotwidget.h.

◆ grid

bool KPlotWidget::grid

readwrite

Definition at line 79 of file kplotwidget.h.

◆ gridColor

QColor KPlotWidget::gridColor

readwrite

Definition at line 78 of file kplotwidget.h.

◆ leftPadding

int KPlotWidget::leftPadding

read

Definition at line 72 of file kplotwidget.h.

◆ objectToolTip

bool KPlotWidget::objectToolTip

readwrite

Definition at line 80 of file kplotwidget.h.

◆ rightPadding

int KPlotWidget::rightPadding

read

Definition at line 73 of file kplotwidget.h.

◆ topPadding

int KPlotWidget::topPadding

read

Definition at line 74 of file kplotwidget.h.

Constructor & Destructor Documentation

◆ KPlotWidget()

KPlotWidget::KPlotWidget ( QWidget * parent = nullptr )

explicit

Constructor.

Parameters

parent the parent widget

Definition at line 96 of file kplotwidget.cpp.

◆ ~KPlotWidget()

KPlotWidget::~KPlotWidget ( )

overridedefault

Destructor.

Member Function Documentation

◆ addPlotObject()

void KPlotWidget::addPlotObject ( KPlotObject * object )

Add an item to the list of KPlotObjects to be plotted.

The widget takes ownership of the plot object, unless auto-delete was disabled.

Parameters

object the KPlotObject to be added

Definition at line 224 of file kplotwidget.cpp.

◆ addPlotObjects()

void KPlotWidget::addPlotObjects ( const QList< KPlotObject * > & objects )

Add more than one KPlotObject at one time.

The widget takes ownership of the plot object, unless auto-delete was disabled.

Parameters

objects the list of KPlotObjects to be added

Definition at line 234 of file kplotwidget.cpp.

◆ antialiasing()

bool KPlotWidget::antialiasing ( ) const

Returns: whether the antialiasing is active Antialiasing is not active by default.

Definition at line 359 of file kplotwidget.cpp.

◆ axis() [1/2]

KPlotAxis * KPlotWidget::axis ( Axis type )

Returns: the axis of the specified type, or 0 if no axis has been set.

See also: Axis

Definition at line 381 of file kplotwidget.cpp.

◆ axis() [2/2]

const KPlotAxis * KPlotWidget::axis ( Axis type ) const

Returns: the axis of the specified type, or 0 if no axis has been set.

See also: Axis

Definition at line 387 of file kplotwidget.cpp.

◆ backgroundColor()

QColor KPlotWidget::backgroundColor ( ) const

Returns: the background color of the plot.

The default color is black.

Definition at line 316 of file kplotwidget.cpp.

◆ bottomPadding()

int KPlotWidget::bottomPadding ( ) const

Returns: the number of pixels below the plot area. Padding values are set to -1 by default; if unchanged, this function will try to guess a good value, based on whether ticklabels and/or axis labels are to be drawn.

Definition at line 991 of file kplotwidget.cpp.

◆ clearSecondaryLimits()

void KPlotWidget::clearSecondaryLimits ( )

Unset the secondary limits, so the top and right axes show the same tickmarks as the bottom and left axes (no tickmark labels will be drawn for the top and right axes in this case)

Definition at line 205 of file kplotwidget.cpp.

◆ dataRect()

QRectF KPlotWidget::dataRect ( ) const

Returns: the rectangle representing the boundaries of the current plot, in natural data units.

See also: setLimits()

Definition at line 214 of file kplotwidget.cpp.

◆ drawAxes()

void KPlotWidget::drawAxes ( QPainter * p )

protectedvirtual

Draws the plot axes and axis labels.

Internal use only; one should simply call update() to draw the widget with axes and all objects.

Parameters

p	pointer to the painter on which we are drawing

Definition at line 744 of file kplotwidget.cpp.

◆ event()

bool KPlotWidget::event ( QEvent * e )

overrideprotectedvirtual

Generic event handler.

Reimplemented from QFrame.

Definition at line 413 of file kplotwidget.cpp.

◆ foregroundColor()

QColor KPlotWidget::foregroundColor ( ) const

Returns: the foreground color, used for axes, tickmarks and associated labels.

The default color is white.

Definition at line 321 of file kplotwidget.cpp.

◆ gridColor()

QColor KPlotWidget::gridColor ( ) const

Returns: the grid color.

The default color is gray.

Definition at line 326 of file kplotwidget.cpp.

◆ isGridShown()

bool KPlotWidget::isGridShown ( ) const

Returns: whether the grid lines are shown Grid lines are not shown by default.

Definition at line 349 of file kplotwidget.cpp.

◆ isObjectToolTipShown()

bool KPlotWidget::isObjectToolTipShown ( ) const

Returns: whether the tooltip for the point objects is shown. Tooltips are enabled by default.

Definition at line 354 of file kplotwidget.cpp.

◆ leftPadding()

int KPlotWidget::leftPadding ( ) const

Returns: the number of pixels to the left of the plot area.

Padding values are set to -1 by default; if unchanged, this function will try to guess a good value, based on whether ticklabels and/or axis labels need to be drawn.

Definition at line 955 of file kplotwidget.cpp.

◆ mapToWidget()

QPointF KPlotWidget::mapToWidget ( const QPointF & p ) const

Map a coordinate.

Parameters

p	from the data rect to the physical pixel rect. Used mainly when drawing.
p	the point to be converted, in natural data units

Returns: the coordinate in the pixel coordinate system

Definition at line 445 of file kplotwidget.cpp.

◆ maskAlongLine()

void KPlotWidget::maskAlongLine	(	const QPointF &	p1,
		const QPointF &	p2,
		float	value = 1.0f )

Indicate that object labels should try to avoid the line joining the two given points (in pixel coordinates).

Note: You should not normally call this function directly. It is called by KPlotObject when lines are drawn in the plot.

Parameters

p1	the starting point for the line
p2	the ending point for the line
value	Allows you to determine how strongly the line should be avoided. Larger values are avoided more strongly.

Definition at line 467 of file kplotwidget.cpp.

◆ maskRect()

void KPlotWidget::maskRect	(	const QRectF &	r,
		float	value = 1.0f )

Indicate that object labels should try to avoid the given rectangle in the plot.

The rectangle is in pixel coordinates.

Note: You should not normally call this function directly. It is called by KPlotObject when points, bars and labels are drawn.

Parameters

r	the rectangle defining the region in the plot that text labels should avoid (in pixel coordinates)
value	Allows you to determine how strongly the rectangle should be avoided. Larger values are avoided more strongly.

Definition at line 452 of file kplotwidget.cpp.

◆ minimumSizeHint()

QSize KPlotWidget::minimumSizeHint ( ) const

overridevirtual

Returns: suggested minimum size for the plot widget

Reimplemented from QWidget.

Definition at line 112 of file kplotwidget.cpp.

◆ paintEvent()

void KPlotWidget::paintEvent ( QPaintEvent * e )

overrideprotectedvirtual

The paint event handler, executed when update() or repaint() is called.

Reimplemented from QFrame.

Definition at line 714 of file kplotwidget.cpp.

◆ pixRect()

QRect KPlotWidget::pixRect ( ) const

Returns: the rectangle representing the boundaries of the current plot, in screen pixel units.

Definition at line 393 of file kplotwidget.cpp.

◆ placeLabel()

void KPlotWidget::placeLabel	(	QPainter *	painter,
		KPlotPoint *	pp )

Place an object label optimally in the plot.

This function will attempt to place the label as close as it can to the point to which the label belongs, while avoiding overlap with regions of the plot that have been masked.

Note: You should not normally call this function directly. It is called internally in KPlotObject::draw().

Parameters

painter	Pointer to the painter on which to draw the label
pp	pointer to the KPlotPoint whose label is to be drawn.

Definition at line 530 of file kplotwidget.cpp.

◆ plotObjects()

QList< KPlotObject * > KPlotWidget::plotObjects ( ) const

Returns: the current list of plot objects

Definition at line 250 of file kplotwidget.cpp.

◆ pointsUnderPoint()

QList< KPlotPoint * > KPlotWidget::pointsUnderPoint ( const QPoint & p ) const

protected

Returns: a list of points in the plot which are within 4 pixels of the screen position given as an argument.

Parameters

p	The screen position from which to check for plot points.

Definition at line 398 of file kplotwidget.cpp.

◆ removeAllPlotObjects()

void KPlotWidget::removeAllPlotObjects ( )

Removes all plot objects that were added to the widget.

If auto-delete was not disabled, the plot objects are deleted.

Definition at line 260 of file kplotwidget.cpp.

◆ replacePlotObject()

void KPlotWidget::replacePlotObject	(	int	i,
		KPlotObject *	o )

Replace an item in the KPlotObject list.

Parameters

i	the index of the item to be replaced
o	pointer to the replacement KPlotObject

Since: 5.12, if auto-deletion is enabled, the previous plot object is deleted. Call setAutoDeletePlotObjects(false) if you want to swap between available plot objects and therefore you want to handle deletion externally.

Definition at line 300 of file kplotwidget.cpp.

◆ resetPlot()

void KPlotWidget::resetPlot ( )

Clear the object list, reset the data limits, and remove axis labels If auto-delete was not disabled, the plot objects are deleted.

Definition at line 281 of file kplotwidget.cpp.

◆ resetPlotMask()

void KPlotWidget::resetPlotMask ( )

Reset the mask used for non-overlapping labels so that all regions of the plot area are considered empty.

Definition at line 273 of file kplotwidget.cpp.

◆ resizeEvent()

void KPlotWidget::resizeEvent ( QResizeEvent * e )

overrideprotectedvirtual

The resize event handler, called when the widget is resized.

Reimplemented from QWidget.

Definition at line 430 of file kplotwidget.cpp.

◆ rightPadding()

int KPlotWidget::rightPadding ( ) const

Returns: the number of pixels to the right of the plot area. Padding values are set to -1 by default; if unchanged, this function will try to guess a good value, based on whether ticklabels and/or axis labels are to be drawn.

Definition at line 967 of file kplotwidget.cpp.

◆ secondaryDataRect()

QRectF KPlotWidget::secondaryDataRect ( ) const

Returns: the rectangle representing the boundaries of the secondary data limits, if they have been set. Otherwise, this function behaves the same as dataRect().

See also: setSecondaryLimits()

Definition at line 219 of file kplotwidget.cpp.

◆ setAntialiasing()

void KPlotWidget::setAntialiasing ( bool b )

Toggle antialiased drawing.

Parameters

b	if true, the plot graphics will be antialiased.

Definition at line 364 of file kplotwidget.cpp.

◆ setAutoDeletePlotObjects()

void KPlotWidget::setAutoDeletePlotObjects ( bool autoDelete )

Enables auto-deletion of plot objects if autoDelete is true; otherwise auto-deletion is disabled.

Auto-deletion is enabled by default.

Since: 5.12

Definition at line 255 of file kplotwidget.cpp.

◆ setBackgroundColor()

void KPlotWidget::setBackgroundColor ( const QColor & bg )

Set the background color.

Parameters

bg	the new background color

Definition at line 331 of file kplotwidget.cpp.

◆ setBottomPadding()

void KPlotWidget::setBottomPadding ( int padding )

Set the number of pixels below the plot area.

Set this to -1 to revert to automatic determination of padding values.

Definition at line 1018 of file kplotwidget.cpp.

◆ setDefaultPaddings()

void KPlotWidget::setDefaultPaddings ( )

Revert all four padding values to -1, so that they will be automatically determined.

Definition at line 1023 of file kplotwidget.cpp.

◆ setForegroundColor()

void KPlotWidget::setForegroundColor ( const QColor & fg )

Set the foreground color.

Parameters

fg	the new foreground color

Definition at line 337 of file kplotwidget.cpp.

◆ setGridColor()

void KPlotWidget::setGridColor ( const QColor & gc )

Set the grid color.

Parameters

gc	the new grid color

Definition at line 343 of file kplotwidget.cpp.

◆ setLeftPadding()

void KPlotWidget::setLeftPadding ( int padding )

Set the number of pixels to the left of the plot area.

Set this to -1 to revert to automatic determination of padding values.

Definition at line 1003 of file kplotwidget.cpp.

◆ setLimits()

void KPlotWidget::setLimits	(	double	x1,
		double	x2,
		double	y1,
		double	y2 )

Set new data limits for the plot.

Parameters

x1	the minimum X value in data units
x2	the maximum X value in data units
y1	the minimum Y value in data units
y2	the maximum Y value in data units

Definition at line 122 of file kplotwidget.cpp.

◆ setObjectToolTipShown

void KPlotWidget::setObjectToolTipShown ( bool show )

slot

Toggle the display of a tooltip for point objects.

Parameters

show	whether show the tooltip.

See also: isObjectToolTipShown()

Definition at line 376 of file kplotwidget.cpp.

◆ setPixRect()

void KPlotWidget::setPixRect ( )

protected

Synchronize the PixRect with the current widget size and padding settings.

Definition at line 437 of file kplotwidget.cpp.

◆ setRightPadding()

void KPlotWidget::setRightPadding ( int padding )

Set the number of pixels to the right of the plot area.

Set this to -1 to revert to automatic determination of padding values.

Definition at line 1008 of file kplotwidget.cpp.

◆ setSecondaryLimits()

void KPlotWidget::setSecondaryLimits	(	double	x1,
		double	x2,
		double	y1,
		double	y2 )

Reset the secondary data limits, which control the values displayed along the top and right axes.

All data points are plotted using the coordinates defined by setLimits(), so this function is only useful for showing alternate tickmark labels along the top and right edges. For example, if you were plotting temperature on the X-axis, you could use Centigrade units for the primary (bottom) axis, using setLimits( 0.0, 100.0, 0.0, 1.0 ). If you also wanted to show Fahrenheit units along the secondary (top) axis, you would additionally use setSecondaryLimits( 32.0, 212.0, 0.0, 1.0 ). The data added to the plot would have x-coordinates in Centigrade degrees.

Parameters

x1	the minimum X value in secondary data units
x2	the maximum X value in secondary data units
y1	the minimum Y value in secondary data units
y2	the maximum Y value in secondary data units

See also: setLimits()

Definition at line 168 of file kplotwidget.cpp.

◆ setShowGrid

void KPlotWidget::setShowGrid ( bool show )

slot

Toggle whether grid lines are drawn at major tickmarks.

Parameters

show	if true, grid lines will be drawn.

See also: isGridShown()

Definition at line 370 of file kplotwidget.cpp.

◆ setTopPadding()

void KPlotWidget::setTopPadding ( int padding )

Set the number of pixels above the plot area.

Set this to -1 to revert to automatic determination of padding values.

Definition at line 1013 of file kplotwidget.cpp.

◆ sizeHint()

QSize KPlotWidget::sizeHint ( void ) const

overridevirtual

Returns: suggested size for the plot widget

Reimplemented from QFrame.

Definition at line 117 of file kplotwidget.cpp.

◆ topPadding()

int KPlotWidget::topPadding ( ) const

Returns: the number of pixels above the plot area. Padding values are set to -1 by default; if unchanged, this function will try to guess a good value, based on whether ticklabels and/or axis labels are to be drawn.

Definition at line 979 of file kplotwidget.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KPlotting

KPlotWidget

Public Types

Properties

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Axis

Property Documentation

◆ backgroundColor

◆ bottomPadding

◆ foregroundColor

◆ grid

◆ gridColor

◆ leftPadding

◆ objectToolTip

◆ rightPadding

◆ topPadding

Constructor & Destructor Documentation

◆ KPlotWidget()

◆ ~KPlotWidget()

Member Function Documentation

◆ addPlotObject()

◆ addPlotObjects()

◆ antialiasing()

◆ axis() [1/2]

◆ axis() [2/2]

◆ backgroundColor()

◆ bottomPadding()

◆ clearSecondaryLimits()

◆ dataRect()

◆ drawAxes()

◆ event()

◆ foregroundColor()

◆ gridColor()

◆ isGridShown()

◆ isObjectToolTipShown()

◆ leftPadding()

◆ mapToWidget()

◆ maskAlongLine()

◆ maskRect()

◆ minimumSizeHint()

◆ paintEvent()

◆ pixRect()

◆ placeLabel()

◆ plotObjects()

◆ pointsUnderPoint()

◆ removeAllPlotObjects()

◆ replacePlotObject()

◆ resetPlot()

◆ resetPlotMask()

◆ resizeEvent()

◆ rightPadding()

◆ secondaryDataRect()

◆ setAntialiasing()

◆ setAutoDeletePlotObjects()

◆ setBackgroundColor()

◆ setBottomPadding()

◆ setDefaultPaddings()

◆ setForegroundColor()

◆ setGridColor()

◆ setLeftPadding()

◆ setLimits()

◆ setObjectToolTipShown

◆ setPixRect()

◆ setRightPadding()

◆ setSecondaryLimits()

◆ setShowGrid

◆ setTopPadding()

◆ sizeHint()

◆ topPadding()