KPlotObject Class

Encapsulates a data set to be plotted in a KPlotWidget. More...

Header:	`#include <KPlotObject>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS Plotting)` `target_link_libraries(mytarget PRIVATE KF6::Plotting)`

List of all members, including inherited members

Public Types

enum	PlotType { UnknownType, Points, Lines, Bars }
flags	PlotTypes
enum	PointStyle { NoPoints, Circle, Letter, Triangle, Square, …, UnknownPoint }

Public Functions

	KPlotObject(const QColor &color = Qt::white, KPlotObject::PlotType otype = Points, double size = 2.0, KPlotObject::PointStyle ps = Circle)
void	addPoint(const QPointF &p, const QString &label = QString(), double barWidth = 0.0)
void	addPoint(KPlotPoint *p)
void	addPoint(double x, double y, const QString &label = QString(), double barWidth = 0.0)
const QBrush	barBrush() const
const QPen &	barPen() const
const QBrush	brush() const
void	clearPoints()
void	draw(QPainter p, KPlotWidget pw)
const QPen &	labelPen() const
const QPen &	linePen() const
const QPen &	pen() const
KPlotObject::PlotTypes	plotTypes() const
KPlotObject::PointStyle	pointStyle() const
QList<KPlotPoint *>	points() const
void	removePoint(int index)
void	setBarBrush(const QBrush &b)
void	setBarPen(const QPen &p)
void	setBrush(const QBrush &b)
void	setLabelPen(const QPen &p)
void	setLinePen(const QPen &p)
void	setPen(const QPen &p)
void	setPointStyle(KPlotObject::PointStyle p)
void	setShowBars(bool b)
void	setShowLines(bool b)
void	setShowPoints(bool b)
void	setSize(double s)
double	size() const

Detailed Description

Think of a KPlotObject as a set of data displayed as a group in the plot. Each KPlotObject consists of a list of KPlotPoints, a "type" controlling how the data points are displayed (some combination of Points, Lines, or Bars), a color, and a size. There is also a parameter which controls the shape of the points used to display the KPlotObject.

Note: KPlotObject will take care of the points added to it, so when clearing the points list (eg with clearPoints()) any previous reference to a KPlotPoint already added to a KPlotObject will be invalid.

Member Type Documentation

enum KPlotObject::PlotType
flags KPlotObject::PlotTypes

The type classification of the KPlotObject.

These are bitmask values that can be OR'd together, so that a set of points can be represented in the plot in multiple ways.

Note: points should be added in order of increasing x-coordinate when using Bars.

Constant	Value	Description
`KPlotObject::UnknownType`	`0`
`KPlotObject::Points`	`1`	Each KPlotPoint is represented with a drawn point
`KPlotObject::Lines`	`2`	Each KPlotPoint is connected with a line
`KPlotObject::Bars`	`4`	Each KPlotPoint is shown as a vertical bar

The PlotTypes type is a typedef for QFlags<PlotType>. It stores an OR combination of PlotType values.

enum KPlotObject::PointStyle

The available shape styles for plotted points.

Constant	Value
`KPlotObject::NoPoints`	`0`
`KPlotObject::Circle`	`1`
`KPlotObject::Letter`	`2`
`KPlotObject::Triangle`	`3`
`KPlotObject::Square`	`4`
`KPlotObject::Pentagon`	`5`
`KPlotObject::Hexagon`	`6`
`KPlotObject::Asterisk`	`7`
`KPlotObject::Star`	`8`
`KPlotObject::UnknownPoint`	`9`

Member Function Documentation

`[explicit]` KPlotObject::KPlotObject(const QColor &color = Qt::white, KPlotObject::PlotType otype = Points, double size = 2.0, KPlotObject::PointStyle ps = Circle)

Constructor.

color The color for plotting this object. By default this sets the color for Points, Lines and Bars, but there are functions to override any of these.

otype the PlotType for this object (Points, Lines or Bars)

size the size to use for plotted points, in pixels

ps The PointStyle describing the shape for plotted points

void KPlotObject::addPoint(const QPointF &p, const QString &label = QString(), double barWidth = 0.0)

Add a point to the object's list of points, using input data to construct a KPlotPoint.

p the QPointF to add.

label the optional text label for this point

barWidth the width of the bar, if this object is to be drawn with bars

Note: if barWidth is left at its default value of 0.0, then the width will be automatically set to the distance between this point and the one to its right.

void KPlotObject::addPoint(KPlotPoint *p)

Add a given KPlotPoint to the object's list of points.

This is an overloaded function.

p pointer to the KPlotPoint to add.

void KPlotObject::addPoint(double x, double y, const QString &label = QString(), double barWidth = 0.0)

Add a point to the object's list of points, using input data to construct a KPlotPoint.

This is an overloaded function.

x the X-coordinate of the point to add.

y the Y-coordinate of the point to add.

label the optional text label

barWidth the width of the bar, if this object is to be drawn with bars

Note: if barWidth is left at its default value of 0.0, then the width will be automatically set to the distance between this point and the one to its right.

const QBrush KPlotObject::barBrush() const

Returns the brush to use for filling bars for this Object.

See also setBarBrush().

const QPen &KPlotObject::barPen() const

Returns the pen to use for drawing bars for this Object.

See also setBarPen().

const QBrush KPlotObject::brush() const

Returns the default Brush to use for this Object.

See also setBrush().

void KPlotObject::clearPoints()

Remove and destroy the points of this object

void KPlotObject::draw(QPainter p, KPlotWidget pw)

Draw this KPlotObject on the given QPainter

p The QPainter to draw on

pw the KPlotWidget to draw on (this is needed for the KPlotWidget::mapToWidget() function)

const QPen &KPlotObject::labelPen() const

Returns the pen to use for drawing labels for this Object.

See also setLabelPen().

const QPen &KPlotObject::linePen() const

Returns the pen to use for drawing lines for this Object.

See also setLinePen().

const QPen &KPlotObject::pen() const

Returns the default pen for this Object.

If no other pens are set, this pen will be used for points, lines, bars and labels (this pen is always used for points).

See also setPen().

KPlotObject::PlotTypes KPlotObject::plotTypes() const

Returns the plot flags of the object

KPlotObject::PointStyle KPlotObject::pointStyle() const

Returns the style used for drawing the points in this object

See also setPointStyle().

QList<KPlotPoint *> KPlotObject::points() const

Returns the list of KPlotPoints that make up this object

void KPlotObject::removePoint(int index)

Remove the QPointF at position index from the list of points

index the index of the point to be removed.

void KPlotObject::setBarBrush(const QBrush &b)

Set the brush to use for drawing bars for this object

b the brush to use

See also barBrush().

void KPlotObject::setBarPen(const QPen &p)

Set the pen to use for drawing bars for this object

p the pen to use

See also barPen().

void KPlotObject::setBrush(const QBrush &b)

Set the default brush to use for this object

b the brush to use

See also brush().

void KPlotObject::setLabelPen(const QPen &p)

Set the pen to use for labels for this object

p the pen to use

See also labelPen().

void KPlotObject::setLinePen(const QPen &p)

Set the pen to use for drawing lines for this object

p the pen to use

See also linePen().

void KPlotObject::setPen(const QPen &p)

Set the default pen for this object

p the pen to use

See also pen().

void KPlotObject::setPointStyle(KPlotObject::PointStyle p)

Set a new style for drawing the points in this object

p the new style

See also pointStyle().

void KPlotObject::setShowBars(bool b)

Set whether bars will be drawn for this object

b if true, bars will be drawn

void KPlotObject::setShowLines(bool b)

Set whether lines will be drawn for this object

b if true, lines will be drawn

void KPlotObject::setShowPoints(bool b)

Set whether points will be drawn for this object

b if true, points will be drawn

void KPlotObject::setSize(double s)

Set the size for plotted points in this object, in pixels

s the new size

See also size().

double KPlotObject::size() const

Returns the size of the plotted points in this object, in pixels

See also setSize().

Contents

KPlotObject Class

Public Types

Public Functions

Detailed Description

Member Type Documentation

enum KPlotObject::PlotTypeflags KPlotObject::PlotTypes

enum KPlotObject::PointStyle

Member Function Documentation

[explicit] KPlotObject::KPlotObject(const QColor &color = Qt::white, KPlotObject::PlotType otype = Points, double size = 2.0, KPlotObject::PointStyle ps = Circle)

void KPlotObject::addPoint(const QPointF &p, const QString &label = QString(), double barWidth = 0.0)

void KPlotObject::addPoint(KPlotPoint *p)

void KPlotObject::addPoint(double x, double y, const QString &label = QString(), double barWidth = 0.0)

const QBrush KPlotObject::barBrush() const

const QPen &KPlotObject::barPen() const

const QBrush KPlotObject::brush() const

void KPlotObject::clearPoints()

void KPlotObject::draw(QPainter *p, KPlotWidget *pw)

const QPen &KPlotObject::labelPen() const

const QPen &KPlotObject::linePen() const

const QPen &KPlotObject::pen() const

KPlotObject::PlotTypes KPlotObject::plotTypes() const

KPlotObject::PointStyle KPlotObject::pointStyle() const

QList<KPlotPoint *> KPlotObject::points() const

void KPlotObject::removePoint(int index)

void KPlotObject::setBarBrush(const QBrush &b)

void KPlotObject::setBarPen(const QPen &p)

void KPlotObject::setBrush(const QBrush &b)

void KPlotObject::setLabelPen(const QPen &p)

void KPlotObject::setLinePen(const QPen &p)

void KPlotObject::setPen(const QPen &p)

void KPlotObject::setPointStyle(KPlotObject::PointStyle p)

void KPlotObject::setShowBars(bool b)

void KPlotObject::setShowLines(bool b)

void KPlotObject::setShowPoints(bool b)

void KPlotObject::setSize(double s)

double KPlotObject::size() const

enum KPlotObject::PlotType
flags KPlotObject::PlotTypes

`[explicit]` KPlotObject::KPlotObject(const QColor &color = Qt::white, KPlotObject::PlotType otype = Points, double size = 2.0, KPlotObject::PointStyle ps = Circle)

void KPlotObject::draw(QPainter p, KPlotWidget pw)