Qt 5.9 | Qt Charts | C++ Classes | QXYSeries

Qt 5.9.9 Reference Documentation

# QXYSeries Class

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

Header: | #include <QXYSeries>
Instantiated By: | XYSeries
Inherits: | QAbstractSeries
Inherited By: | QLineSeries and QScatterSeries

- List of all members, including inherited members

## Properties

- color : QColor
- pointLabelsClipping : bool
- pointLabelsColor : QColor
- pointLabelsFont : QFont

- pointLabelsFormat : QString
- pointLabelsVisible : bool
- pointsVisible : bool

- 5 properties inherited from QAbstractSeries

## Public Functions

| ~QXYSeries()
void | append(qreal x, qreal y)
void | append(const QPointF &point)
void | append(const QList<QPointF> &points)
const QPointF & | at(int index) const
QBrush | brush() const
void | clear()
virtual QColor | color() const
int | count() const
void | insert(int index, const QPointF &point)
QPen | pen() const
bool | pointLabelsClipping() const
QColor | pointLabelsColor() const
QFont | pointLabelsFont() const
QString | pointLabelsFormat() const
bool | pointLabelsVisible() const
QList<QPointF> | points() const
QVector<QPointF> | pointsVector() const
bool | pointsVisible() const
void | remove(qreal x, qreal y)
void | remove(const QPointF &point)
void | remove(int index)
void | removePoints(int index, int count)
void | replace(qreal oldX, qreal oldY, qreal newX, qreal newY)
void | replace(const QPointF &oldPoint, const QPointF &newPoint)
void | replace(int index, qreal newX, qreal newY)
void | replace(int index, const QPointF &newPoint)
void | replace(QList<QPointF> points)
void | replace(QVector<QPointF> points)
virtual void | setBrush(const QBrush &brush)
virtual void | setColor(const QColor &color)
virtual void | setPen(const QPen &pen)
void | setPointLabelsClipping(bool enabled = true)
void | setPointLabelsColor(const QColor &color)
void | setPointLabelsFont(const QFont &font)
void | setPointLabelsFormat(const QString &format)
void | setPointLabelsVisible(bool visible = true)
void | setPointsVisible(bool visible = true)
QXYSeries & | operator<<(const QPointF &point)
QXYSeries & | operator<<(const QList<QPointF> &points)

- 15 public functions inherited from QAbstractSeries

## Signals

void | clicked(const QPointF &point)
void | colorChanged(QColor color)
void | doubleClicked(const QPointF &point)
void | hovered(const QPointF &point, bool state)
void | penChanged(const QPen &pen)
void | pointAdded(int index)
void | pointLabelsClippingChanged(bool clipping)
void | pointLabelsColorChanged(const QColor &color)
void | pointLabelsFontChanged(const QFont &font)
void | pointLabelsFormatChanged(const QString &format)
void | pointLabelsVisibilityChanged(bool visible)
void | pointRemoved(int index)
void | pointReplaced(int index)
void | pointsRemoved(int index, int count)
void | pointsReplaced()
void | pressed(const QPointF &point)
void | released(const QPointF &point)

- 4 signals inherited from QAbstractSeries

## Detailed Description

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

## Property Documentation

### color : QColor

This property holds the color of the series.

This is the line (pen) color in case of QLineSeries or QSplineSeries and the fill (brush) color in case of QScatterSeries or QAreaSeries.

Access functions:

virtual QColor | color() const
virtual void | setColor(const QColor &color)

Notifier signal:

void | colorChanged(QColor color)

See also pen() and brush().

### pointLabelsClipping : bool

This property holds the clipping for data point labels.

This property is `true` by default. The labels on the edge of the plot area are cut when clipping is enabled.

Access functions:

bool | pointLabelsClipping() const
void | setPointLabelsClipping(bool enabled = true)

Notifier signal:

void | pointLabelsClippingChanged(bool clipping)

See also pointLabelsVisible.

### pointLabelsColor : QColor

This property holds the color used for data point labels. By default, the color is the color of the brush defined in theme for labels.

Access functions:

QColor | pointLabelsColor() const
void | setPointLabelsColor(const QColor &color)

Notifier signal:

void | pointLabelsColorChanged(const QColor &color)

See also pointLabelsFormat.

### pointLabelsFont : QFont

This property holds the font used for data point labels.

Access functions:

QFont | pointLabelsFont() const
void | setPointLabelsFont(const QFont &font)

Notifier signal:

void | pointLabelsFontChanged(const QFont &font)

See also pointLabelsFormat.

### pointLabelsFormat : QString

This property holds the format used for showing labels with data points.

QXYSeries supports the following format tags:

@xPoint | The x-coordinate of the data point.
@yPoint | The y-coordinate of the data point.

For example, the following usage of the format tags would produce labels that display the data point shown inside brackets separated by a comma (x, y):

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

By default, the labels' format is set to `@xPoint, @yPoint`. The labels are shown on the plot area, and the labels on the edge of the plot area are cut. If the points are close to each other, the labels may overlap.

Access functions:

QString | pointLabelsFormat() const
void | setPointLabelsFormat(const QString &format)

Notifier signal:

void | pointLabelsFormatChanged(const QString &format)

See also pointLabelsVisible, pointLabelsFont, and pointLabelsColor.

### pointLabelsVisible : bool

This property holds the visibility of data point labels.

This property is `false` by default.

Access functions:

bool | pointLabelsVisible() const
void | setPointLabelsVisible(bool visible = true)

Notifier signal:

void | pointLabelsVisibilityChanged(bool visible)

See also pointLabelsFormat and pointLabelsClipping.

### pointsVisible : bool

This property holds whether the data points are visible and should be drawn.

Access functions:

bool | pointsVisible() const
void | setPointsVisible(bool visible = true)

## Member Function Documentation

### 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 points vector.

### 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().

### `[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.

### int QXYSeries::count() const

Returns the number of data points in a series.

### `[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`.

### 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().

### QPen QXYSeries::pen() const

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

See also setPen().

### `[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().

### QList<QPointF> QXYSeries::points() const

Returns the points in the series as a list. Use pointsVector() for better performance.

### `[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().

### QVector<QPointF> QXYSeries::pointsVector() const

Returns the points in the series as a vector. This is more efficient than calling points().

### `[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().

### 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(QList<QPointF> points)

Replaces the current points with the points specified by points.

Note: This is much faster than replacing data points one by one, or first clearing all data, and then appending the new data. Emits QXYSeries::pointsReplaced() when the points have been replaced. However, note that using the overload that takes `QVector<QPointF>` as parameter is faster than using this overload.

See also pointsReplaced().

### void QXYSeries::replace(QVector<QPointF> points)

Replaces the current points with the points specified by points.

Note: This is much faster than replacing data points one by one, or first clearing all data, and then appending the new data. Emits QXYSeries::pointsReplaced() when the points have been replaced.

See also pointsReplaced().

### `[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().

### `[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().

### 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().