QValue3DAxis Class

The QValue3DAxis class manipulates an axis of a graph. More...

Header: #include <QValue3DAxis>
CMake: find_package(Qt6 REQUIRED COMPONENTS Graphs)
target_link_libraries(mytarget PRIVATE Qt6::Graphs)
qmake: QT += graphs
In QML: Value3DAxis
Inherits: QAbstract3DAxis

Properties

Public Functions

QValue3DAxis(QObject *parent = nullptr)
virtual ~QValue3DAxis() override
QValue3DAxisFormatter *formatter() const
QString labelFormat() const
bool reversed() const
qsizetype segmentCount() const
void setFormatter(QValue3DAxisFormatter *formatter)
void setLabelFormat(const QString &format)
void setReversed(bool enable)
void setSegmentCount(qsizetype count)
void setSubSegmentCount(qsizetype count)
qsizetype subSegmentCount() const

Signals

void formatterChanged(QValue3DAxisFormatter *formatter)
void labelFormatChanged(const QString &format)
void reversedChanged(bool enable)
void segmentCountChanged(qsizetype count)
void subSegmentCountChanged(qsizetype count)

Detailed Description

A value axis can be given a range of values and segment and subsegment counts to divide the range into.

Labels are drawn between each segment, and grid lines are drawn between each segment and each subsegment.

Note: If visible, there will always be at least two grid lines and labels indicating the minimum and maximum values of the range, as there is always at least one segment.

Property Documentation

formatter : QValue3DAxisFormatter*

This property holds the axis formatter to be used.

Any existing formatter is deleted when a new formatter is set.

Access functions:

QValue3DAxisFormatter *formatter() const
void setFormatter(QValue3DAxisFormatter *formatter)

Notifier signal:

void formatterChanged(QValue3DAxisFormatter *formatter)

labelFormat : QString

This property holds the label format to be used for the labels on this axis.

The format string supports the following conversion specifiers, length modifiers, and flags provided by printf() in the standard C++ library: d, i, o, x, X, f, F, e, E, g, G, c.

If Q3DGraphsWidgetItem::locale is anything else than "C", the supported specifiers are limited to: d, e, E, f, g, G, and i. Also, only the precision modifier is supported. The rest of the formatting comes from the default QLocale of the application.

Usage example:

axis->setLabelFormat("%.2f mm");

Access functions:

QString labelFormat() const
void setLabelFormat(const QString &format)

Notifier signal:

void labelFormatChanged(const QString &format)

See also formatter and Q3DGraphsWidgetItem::locale.

reversed : bool

This property holds whether the axis is rendered in reverse.

If true, the axis will be rendered in reverse, which means the positions of minimum and maximum values are swapped when the graph is rendered. This property doesn't affect the actual minimum and maximum values of the axis.

Access functions:

bool reversed() const
void setReversed(bool enable)

Notifier signal:

void reversedChanged(bool enable)

segmentCount : qsizetype

This property holds the number of segments on the axis.

This indicates how many labels are drawn. The number of grid lines to be drawn is calculated with formula: segments * subsegments + 1. The preset default is 5. The value cannot be below 1.

Access functions:

qsizetype segmentCount() const
void setSegmentCount(qsizetype count)

Notifier signal:

void segmentCountChanged(qsizetype count)

See also setSubSegmentCount().

subSegmentCount : qsizetype

This property holds the number of subsegments inside each segment on the axis.

Grid lines are drawn between each subsegment, in addition to each segment. The preset default is 1. The value cannot be below 1.

Access functions:

qsizetype subSegmentCount() const
void setSubSegmentCount(qsizetype count)

Notifier signal:

void subSegmentCountChanged(qsizetype count)

See also setSegmentCount().

Member Function Documentation

[explicit] QValue3DAxis::QValue3DAxis(QObject *parent = nullptr)

Constructs QValue3DAxis with the given parent.

[override virtual noexcept] QValue3DAxis::~QValue3DAxis()

Destroys QValue3DAxis.