QXYSeries Class

The QXYSeries class is a base class for line, spline, and scatter series. More...

• List of all members, including inherited members
• Deprecated members

Public Types

Properties

Public Functions

Signals

Detailed Description

QXYSeries supports displaying best fit line on a chart. Best fit line is a line through a chart that expresses the relationship between points.

Member Type Documentation

enum class QXYSeries::PointConfiguration

This enum value describes the particular configuration of a point.

See also setPointConfiguration().

series->setPointLabelsFormat("(@xPoint, @yPoint)");

Member Function Documentation

[signal] void QXYSeries::bestFitLineColorChanged(const QColor &color)

This signal is emitted when the color used for the best fit line changes to color.

Note: Notifier signal for property bestFitLineColor.

[signal] void QXYSeries::bestFitLineVisibilityChanged(bool visible)

This signal is emitted when the visibility of the best fit line changes to visible.

Note: Notifier signal for property bestFitLineVisible.

[signal] void QXYSeries::clicked(const QPointF &point)

This signal is emitted when the user triggers a mouse event by clicking the point point in the chart.

See also pressed(), released(), and doubleClicked().

[signal] void QXYSeries::colorChanged(QColor color)

This signal is emitted when the line (pen) color changes to color.

Note: Notifier signal for property color.

[signal] void QXYSeries::doubleClicked(const QPointF &point)

This signal is emitted when the user double-clicks the data point point in the chart. The point is the point where the first press was triggered.

See also pressed(), released(), and clicked().

[signal] void QXYSeries::hovered(const QPointF &point, bool state)

This signal is emitted when a mouse is hovered over the point point in the chart. When the mouse moves over the point, state turns true, and when the mouse moves away again, it turns false.

[signal, since 6.2] void QXYSeries::lightMarkerChanged(const QImage &lightMarker)

This signal is emitted when the light marker image changes to lightMarker.

This function was introduced in Qt 6.2.

See also QXYSeries::setLightMarker() and ;.

[signal] void QXYSeries::markerSizeChanged(qreal size)

This signal is emitted when the marker size changes to size.

[signal] void QXYSeries::penChanged(const QPen &pen)

This signal is emitted when the pen changes to pen.

[signal] void QXYSeries::pointAdded(int index)

This signal is emitted when a point is added at the position specified by index.

See also append() and insert().

[signal] void QXYSeries::pointLabelsClippingChanged(bool clipping)

This signal is emitted when the clipping of the data point labels changes to clipping.

Note: Notifier signal for property pointLabelsClipping.

[signal] void QXYSeries::pointLabelsColorChanged(const QColor &color)

This signal is emitted when the color used for data point labels changes to color.

Note: Notifier signal for property pointLabelsColor.

[signal] void QXYSeries::pointLabelsFontChanged(const QFont &font)

This signal is emitted when the font used for data point labels changes to font.

Note: Notifier signal for property pointLabelsFont.

[signal] void QXYSeries::pointLabelsFormatChanged(const QString &format)

This signal is emitted when the format of data point labels changes to format.

Note: Notifier signal for property pointLabelsFormat.

[signal] void QXYSeries::pointLabelsVisibilityChanged(bool visible)

This signal is emitted when the visibility of the data point labels changes to visible.

Note: Notifier signal for property pointLabelsVisible.

[signal] void QXYSeries::pointRemoved(int index)

This signal is emitted when a point is removed from the position specified by index.

See also remove().

[signal] void QXYSeries::pointReplaced(int index)

This signal is emitted when a point is replaced at the position specified by index.

See also replace().

[signal] void QXYSeries::pointsRemoved(int index, int count)

This signal is emitted when the number of points specified by count is removed starting at the position specified by index.

See also removePoints() and clear().

[signal] void QXYSeries::pointsReplaced()

This signal is emitted when all points are replaced with other points.

See also replace().

[signal] void QXYSeries::pressed(const QPointF &point)

This signal is emitted when the user presses the data point point in the chart and holds down the mouse button.

See also clicked(), released(), and doubleClicked().

[signal] void QXYSeries::released(const QPointF &point)

This signal is emitted when the user releases the mouse press on the data point specified by point.

See also pressed(), clicked(), and doubleClicked().

[virtual] QXYSeries::~QXYSeries()

Deletes the series. Series added to QChart instances are owned by them, and are deleted when the QChart instances are deleted.

void QXYSeries::append(qreal x, qreal y)

Adds the data point with the coordinates x and y to the series.

void QXYSeries::append(const QPointF &point)

This is an overloaded function.

Adds the data point point to the series.

void QXYSeries::append(const QList<QPointF> &points)

This is an overloaded function.

Adds the list of data points specified by points to the series.

const QPointF &QXYSeries::at(int index) const

Returns the data point at the position specified by index in the internal series of points.

[since 6.2] QPair<qreal, qreal> QXYSeries::bestFitLineEquation(bool &ok) const

Returns a pair of numbers where the first number is a slope factor and the second number is intercept of a linear function for a best fit line.

Those factors are calculated using Least Squares Method based on points passed to the series.

Parameter ok is used to report a failure by setting its value to false and to report a success by setting its value to true.

This function was introduced in Qt 6.2.

See also QXYSeries::bestFitLineVisible().

QBrush QXYSeries::brush() const

Returns the brush used to fill the data points for the series.

See also setBrush().

void QXYSeries::clear()

Removes all points from the series.

See also pointsRemoved().

[since 6.2] void QXYSeries::clearPointConfiguration(const int index)

Removes the configuration of a point located at index and restores the default look derived from the series' settings.

This function was introduced in Qt 6.2.

See also clearPointsConfiguration() and setPointConfiguration().

[since 6.2] void QXYSeries::clearPointConfiguration(const int index, const QXYSeries::PointConfiguration key)

Removes the configuration property identified by key from the point at index and restores the default look derived from the series' settings.

Removes the configuration type, such as color or size, specified by key from the point at index with configuration customizations, allowing that configuration property to be rendered as the default specified in the series' properties.

This function was introduced in Qt 6.2.

See also clearPointsConfiguration() and setPointConfiguration().

[since 6.2] void QXYSeries::clearPointsConfiguration()

Removes the configuration of all points in the series and restores the default look derived from the series' settings.

This function was introduced in Qt 6.2.

See also setPointConfiguration().

[since 6.2] void QXYSeries::clearPointsConfiguration(const QXYSeries::PointConfiguration key)

Removes the configuration property identified by key from all points and restores the default look derived from the series' settings.

Removes the configuration type, such as color or size, specified by key from all points with configuration customizations, allowing that configuration property to be rendered as the default specified in the series properties.

This function was introduced in Qt 6.2.

See also clearPointsConfiguration() and setPointConfiguration().

[since 6.2] void QXYSeries::colorBy(const QList<qreal> &sourceData, const QLinearGradient &gradient = QLinearGradient())

Sets the points' color according to a passed list of values. Values from sourceData are sorted and mapped to the gradient.

If the series has a QColorAxis attached, then a gradient from the axis is going to be used.

This function was introduced in Qt 6.2.

See also setPointConfiguration(), pointConfiguration(), and QColorAxis.

int QXYSeries::count() const

Returns the number of data points in a series.

[since 6.2] void QXYSeries::deselectAllPoints()

Deselects all points in the series.

This function was introduced in Qt 6.2.

See also setPointSelected().

[since 6.2] void QXYSeries::deselectPoint(int index)

Deselects point at given index.

This function was introduced in Qt 6.2.

See also setPointSelected().

[since 6.2] void QXYSeries::deselectPoints(const QList<int> &indexes)

Marks multiple points passed in a indexes list as deselected.

This function was introduced in Qt 6.2.

See also setPointSelected().

void QXYSeries::insert(int index, const QPointF &point)

Inserts the data point point in the series at the position specified by index.

See also pointAdded().

[since 6.2] bool QXYSeries::isPointSelected(int index)

Returns true if point at given index is among selected points and false otherwise.

This function was introduced in Qt 6.2.

See also selectedPoints(), setPointSelected(), and setSelectedColor().

[since 6.2] const QImage &QXYSeries::lightMarker() const

Gets the image used for drawing markers on each point of the series.

The default value is QImage(), meaning no light marker will be painted.

The light markers visualize the data points of this series and as such are an alternative to setPointsVisible(true). Both features can be enabled independently from each other.

Unlike the elements of QScatterSeries the light markers are not represented by QGraphicsItem, but are just painted (no objects created). However, the mouse-event-signals of QXYSeries behave the same way, meaning that you'll get the exact domain value of the point if you click/press/hover the light marker. You'll still get the in between domain value if you click on the line. The light markers are above the line in terms of painting as well as events.

This function was introduced in Qt 6.2.

See also QXYSeries::setLightMarker().

[since 6.2] qreal QXYSeries::markerSize() const

Gets the size of the marker used to render points in the series.

The default size depends on the specific QXYSeries type. QScatterSeries has a default of 15.0 QLineSeries has a default of the series pen size * 1.5

This function was introduced in Qt 6.2.

See also setMarkerSize() and QScatterSeries::markerSize.

QPen QXYSeries::pen() const

Returns the pen used to draw the outline of the data points for the series.

See also setPen().

[since 6.2] QHash<QXYSeries::PointConfiguration, QVariant> QXYSeries::pointConfiguration(const int index) const

Returns a map representing the configuration of a point at index.

With points configuration you can change various aspects of each point's look.

This function was introduced in Qt 6.2.

See also setPointConfiguration().

QList<QPointF> QXYSeries::points() const

Returns the points in the series.

[since 6.2] QHash<int, QHash<QXYSeries::PointConfiguration, QVariant> > QXYSeries::pointsConfiguration() const

Returns a map with points' indexes as keys and points' configuration as values.

This function was introduced in Qt 6.2.

See also setPointsConfiguration(), setPointConfiguration(), and pointConfiguration().

void QXYSeries::remove(qreal x, qreal y)

Removes the point that has the coordinates x and y from the series.

See also pointRemoved().

void QXYSeries::remove(const QPointF &point)

Removes the data point point from the series.

See also pointRemoved().

void QXYSeries::remove(int index)

Removes the point at the position specified by index from the series.

See also pointRemoved().

void QXYSeries::removePoints(int index, int count)

Removes the number of points specified by count from the series starting at the position specified by index.

See also pointsRemoved().

void QXYSeries::replace(qreal oldX, qreal oldY, qreal newX, qreal newY)

Replaces the point with the coordinates oldX and oldY with the point with the coordinates newX and newY. Does nothing if the old point does not exist.

See also pointReplaced().

void QXYSeries::replace(const QPointF &oldPoint, const QPointF &newPoint)

Replaces the point specified by oldPoint with the one specified by newPoint.

See also pointReplaced().

void QXYSeries::replace(int index, qreal newX, qreal newY)

Replaces the point at the position specified by index with the point that has the coordinates newX and newY.

See also pointReplaced().

void QXYSeries::replace(int index, const QPointF &newPoint)

Replaces the point at the position specified by index with the point specified by newPoint.

See also pointReplaced().

void QXYSeries::replace(const QList<QPointF> &points)

Replaces the current points with the points specified by points.

See also pointsReplaced().

[since 6.2] void QXYSeries::selectAllPoints()

Marks all points in the series as selected,

This function was introduced in Qt 6.2.

See also setPointSelected().

[since 6.2] void QXYSeries::selectPoint(int index)

Marks point at index as selected.

This function was introduced in Qt 6.2.

See also setPointSelected().

[since 6.2] void QXYSeries::selectPoints(const QList<int> &indexes)

Marks multiple points passed in a indexes list as selected.

This function was introduced in Qt 6.2.

See also setPointSelected().

[since 6.2] const QImage &QXYSeries::selectedLightMarker() const

Returns the image used for drawing markers on selected series' points.

The default value is QImage(), meaning usual lightMarker() will be painted.

This is equivalent to selectedColor if you prefer light markers over normal points, but still want to distinguish selected points.

This function was introduced in Qt 6.2.

See also setSelectedLightMarker(), lightMarker(), selectedColor, and setPointSelected().

[since 6.2] QList<int> QXYSeries::selectedPoints() const

Returns a list of points indexes marked as selected. Selected points are visible regardless of points visibility.

This function was introduced in Qt 6.2.

See also setPointSelected() and pointsVisible().

[virtual] void QXYSeries::setBrush(const QBrush &brush)

Sets the brush used for drawing points on the chart to brush. If the brush is not defined, the brush from the chart theme setting is used.

See also brush() and QChart::setTheme().

[since 6.2] void QXYSeries::setLightMarker(const QImage &lightMarker)

Sets the image used for drawing markers on each point of the series as the value of lightMarker.

The default value is a default-QImage() (QImage::isNull() == true), meaning no light marker will be painted. You can reset back to default (disabled) by calling this function with a null QImage (QImage()).

The light markers visualize the data points of this series and as such are an alternative to setPointsVisible(true). If a light marker is set with this method, visible points as set with setPointsVisible(true) are not displayed.

Unlike the elements of QScatterSeries the light markers are not represented by QGraphicsItem, but are just painted (no objects created). However, the mouse-event-signals of QXYSeries behave the same way, meaning that you'll get the exact domain value of the point if you click/press/hover the light marker. You'll still get the in between domain value if you click on the line. The light markers are above the line in terms of painting as well as events.

This function was introduced in Qt 6.2.

See also QXYSeries::lightMarker().

[since 6.2] void QXYSeries::setMarkerSize(qreal size)

Sets the size of the marker used to render points in the series.

The default size is 15.0.

This function was introduced in Qt 6.2.

See also QScatterSeries::markerSize.

[virtual] void QXYSeries::setPen(const QPen &pen)

Sets the pen used for drawing points on the chart to pen. If the pen is not defined, the pen from the chart theme is used.

See also pen() and QChart::setTheme().

[since 6.2] void QXYSeries::setPointConfiguration(const int index, const QHash<QXYSeries::PointConfiguration, QVariant> &configuration)

Enables customizing the appearance of a point located at index with desired configuration.

With points configuration you can change various aspects of every point's appearance.

A point's configuration is represented as a hash map with QXYSeries::pointConfiguration keys and QVariant values. For example:

QLineSeries *series = new QLineSeries();
series->setName("Customized serie");
series->setPointsVisible(true);

*series << QPointF(0, 6) << QPointF(2, 4) << QPointF(3, 6) << QPointF(7, 4) << QPointF(10, 5)
        << QPointF(11, 1) << QPointF(13, 3) << QPointF(17, 6) << QPointF(18, 3)
        << QPointF(20, 2);

QChart *chart = new QChart();
chart->addSeries(series);
chart->createDefaultAxes();

QHash<QXYSeries::PointConfiguration, QVariant> conf;
conf[QXYSeries::PointConfiguration::Color] = QColor(Qt::red);
conf[QXYSeries::PointConfiguration::Size] = 8;
conf[QXYSeries::PointConfiguration::LabelVisibility] = true;

series->setPointConfiguration(4, conf);

conf.remove(QXYSeries::PointConfiguration::LabelVisibility);
series->setPointConfiguration(6, conf);

In this example, you can see a default QLineSeries with 10 points and with changed configuration of two points. Both changed points are red and visibly bigger than the others with a look derived from series. By default, points don't have labels, but the point at index 4 has the label thanks to the QXYSeries::PointConfiguration::LabelVisibility configuration value. Below is an example of a chart created in this way:

This function was introduced in Qt 6.2.

See also pointConfiguration(), pointsConfiguration(), and clearPointsConfiguration().

[since 6.2] void QXYSeries::setPointConfiguration(const int index, const QXYSeries::PointConfiguration key, const QVariant &value)

Enables customizing a particular aspect of a point's configuration.

This function was introduced in Qt 6.2.

See also pointsConfiguration().

[since 6.2] void QXYSeries::setPointSelected(int index, bool selected)

Marks point at given index as either selected or deselected as specified by selected.

This function was introduced in Qt 6.2.

See also isPointSelected(), setPointSelected(), and setSelectedColor().

[since 6.2] void QXYSeries::setPointsConfiguration(const QHash<int, QHash<QXYSeries::PointConfiguration, QVariant> > &pointsConfiguration)

Enables customizing the configuration of multiple points as specified by pointsConfiguration.

This function was introduced in Qt 6.2.

See also pointsConfiguration().

[since 6.2] void QXYSeries::setSelectedLightMarker(const QImage &selectedLightMarker)

Sets the image used for drawing markers on selected series's points to selectedLightMarker.

The default value is QImage(), meaning usual lightMarker() will be painted.

This is an equivalent for selectedColor if you prefer light markers over normal points, but still want to distinguish selected points.

This function was introduced in Qt 6.2.

See also selectedLightMarker(), lightMarker(), selectedColor, and setPointSelected().

[since 6.2] void QXYSeries::sizeBy(const QList<qreal> &sourceData, const qreal minSize, const qreal maxSize)

Sets the points' sizes according to a passed list of values. Values from sourceData are sorted and mapped to a point size which is between minSize and maxSize.

This function was introduced in Qt 6.2.

See also setPointConfiguration() and pointConfiguration().

[since 6.2] void QXYSeries::toggleSelection(const QList<int> &indexes)

Changes selection state of points at given indexes to the opposite one. Makes

This function was introduced in Qt 6.2.

See also setPointSelected().

QXYSeries &QXYSeries::operator<<(const QPointF &point)

Stream operator for adding the data point point to the series.

See also append().

QXYSeries &QXYSeries::operator<<(const QList<QPointF> &points)

Stream operator for adding the list of data points specified by points to the series.

See also append().