W3cubDocs

/Qt 6.9

QAbstractSeries Class

The QAbstractSeries class is a base class for all Qt Graphs for 2D series. More...

Header: #include <QAbstractSeries>
CMake: find_package(Qt6 REQUIRED COMPONENTS Graphs)
target_link_libraries(mytarget PRIVATE Qt6::Graphs)
qmake: QT += graphs
In QML: AbstractSeries
Inherits: QObject and QQmlParserStatus
Inherited By:

QAreaSeries, QBarSeries, QPieSeries, and QXYSeries

Public Types

enum class SeriesType { Line, Bar, Scatter, Pie, Spline, Area }

Properties

Public Functions

virtual ~QAbstractSeries() override
void hide()
bool isHoverable() const
bool isSelectable() const
bool isVisible() const
const QList<QLegendData> legendData() const
QString name() const
qreal opacity() const
QQmlListProperty<QObject> seriesChildren()
void setHoverable(bool newHoverable)
void setName(const QString &name)
void setOpacity(qreal opacity)
void setSelectable(bool selectable)
void setValuesMultiplier(qreal valuesMultiplier)
void setVisible(bool visible = true)
void show()
virtual QAbstractSeries::SeriesType type() const = 0
qreal valuesMultiplier() const

Signals

void hover(const QString &seriesName, QPointF position, QPointF value)
void hoverEnter(const QString &seriesName, QPointF position, QPointF value)
void hoverExit(const QString &seriesName, QPointF position)
void hoverableChanged()
void legendDataChanged()
void nameChanged()
void opacityChanged()
void selectableChanged()
void valuesMultiplierChanged()
void visibleChanged()

Detailed Description

Usually, the series type specific inherited classes are used instead of the base class.

See also QLineSeries, QSplineSeries, QScatterSeries, QBarSeries, and QXYSeries.

Member Type Documentation

enum class QAbstractSeries::SeriesType

This enum describes the type of the series.

Constant Value Description
QAbstractSeries::SeriesType::Line 0 A line graph.
QAbstractSeries::SeriesType::Bar 2 A bar graph.
QAbstractSeries::SeriesType::Scatter 4 A scatter graph.
QAbstractSeries::SeriesType::Pie 3 A pie graph.
QAbstractSeries::SeriesType::Spline 5 A spline graph.
QAbstractSeries::SeriesType::Area 1 An area graph.

Property Documentation

hoverable : bool

Controls if the series is hoverable.

Controls if the series can be hovered with mouse/touch. By default, hoverable is set to false.

Access functions:

bool isHoverable() const
void setHoverable(bool newHoverable)

Notifier signal:

void hoverableChanged()

[read-only] legendData : const QList<QLegendData>

Contains information needed to create a legend marker for a data set in a graph.

Access functions:

const QList<QLegendData> legendData() const

Notifier signal:

void legendDataChanged()

See also QLegendData.

name : QString

This property holds the name of the series.

The name is displayed in the legend for the series and it supports HTML formatting.

Access functions:

QString name() const
void setName(const QString &name)

Notifier signal:

void nameChanged()

opacity : qreal

This property holds the opacity of the series.

By default, the opacity is 1.0. The valid values range from 0.0 (transparent) to 1.0 (opaque).

Access functions:

qreal opacity() const
void setOpacity(qreal opacity)

Notifier signal:

void opacityChanged()

selectable : bool

Controls if the series is selectable.

Controls if the series can be selected with mouse/touch. By default, selectable is set to false.

Access functions:

bool isSelectable() const
void setSelectable(bool selectable)

Notifier signal:

void selectableChanged()

[read-only] type : const SeriesType

This property holds the type of the series.

Access functions:

virtual QAbstractSeries::SeriesType type() const = 0

valuesMultiplier : qreal

Controls the series values effective visible value.

This variable can be used for animating the series values so they scale from 0 to actual value size. By default, the valuesMultiplier is 1.0. The valid values range from 0.0 (height 0) to 1.0 (full value).

Access functions:

qreal valuesMultiplier() const
void setValuesMultiplier(qreal valuesMultiplier)

Notifier signal:

void valuesMultiplierChanged()

visible : bool

Visibility of the series.

The visibility used for this series. By default, visible is set to true.

Access functions:

bool isVisible() const
void setVisible(bool visible = true)

Notifier signal:

void visibleChanged()

Member Function Documentation

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

Virtual destructor for the graph series.

void QAbstractSeries::hide()

Sets the visibility of the series to false.

See also setVisible() and isVisible().

[signal] void QAbstractSeries::hover(const QString &seriesName, QPointF position, QPointF value)

This signal is emitted when the series hovering changes. The name of the series is in seriesName, the mouse/touch position in position, and the series value in value.

Note: This signal is only emitted when hoverable is set to true.

Note: For Pie graph, the value represents (angle of position, start angle of hovering slice)

[signal] void QAbstractSeries::hoverEnter(const QString &seriesName, QPointF position, QPointF value)

This signal is emitted when the series hovering starts. The name of the series is in seriesName, the mouse/touch position in position, and the series value in value.

Note: This signal is only emitted when hoverable is set to true.

Note: For Pie graph, the value represents (angle of position, start angle of hovering slice)

[signal] void QAbstractSeries::hoverExit(const QString &seriesName, QPointF position)

This signal is emitted when the series hovering ends. The name of the series is in seriesName, and the mouse/touch position in position.

Note: This signal is only emitted when hoverable is set to true.

void QAbstractSeries::show()

Sets the visibility of the series to true.

See also setVisible() and isVisible().

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.9/qabstractseries.html