QAreaSeries Class▲
-
Header: QAreaSeries
-
Inherited By:
-
Instantiated By: qml-qtcharts-areaseries.xml
-
Inherits: QAbstractSeries
-
Inherited By:
Detailed Description▲
An area series is used to show quantitative data. It is based on a line series, in the way that the area between the boundary lines is emphasized with color. Since the area series is based on the line series, the QAreaSeries constructor needs a QLineSeries instance, which defines the upper boundary of the area. The area chart is drawn using the bottom of the plot area as the lower boundary by default. Instead of the bottom of the plot area, the lower boundary can be specified by another line. In that case, QAreaSeries should be initialized with two QLineSeries instances.
The terms upper and lower boundary can be misleading in cases where the value of the lower boundary is greater than that of the upper boundary. The main point is that the area between these two boundary lines will be filled.
See the area chart example to learn how to create a simple area chart.
Property Documentation▲
borderColor : QColor▲
This property holds the line (pen) color of the series. This is a convenience property for modifying the color of the pen.
Access functions:
-
borderColor() const
-
void setBorderColor(const &color)
Notifier signal:
-
void borderColorChanged( color)
See Also▲
See also QAreaSeries::pen()
color : QColor▲
This property holds the fill (brush) color of the series. This is a convenience property for modifying the color of the brush.
Access functions:
-
color() const
-
void setColor(const &color)
Notifier signal:
-
void colorChanged( color)
See Also▲
See also QAreaSeries::brush()
[read-only] lowerSeries : QLineSeries* const▲
This property holds the lower one of the two line series used to define area series boundaries.
If QAreaSeries was constructed without a lowerSeries, this is null.
Access functions:
-
*lowerSeries() const
pointLabelsClipping : bool▲
This property holds the clipping for data point labels. 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▲
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 for labels in the theme.
Access functions:
-
pointLabelsColor() const
-
void setPointLabelsColor(const &color)
Notifier signal:
-
void pointLabelsColorChanged(const &color)
See Also▲
See also QAreaSeries::pointLabelsFormat
pointLabelsFont : QFont▲
This property holds the font used for data point labels.
Access functions:
-
pointLabelsFont() const
-
void setPointLabelsFont(const &font)
Notifier signal:
-
void pointLabelsFontChanged(const &font)
See Also▲
See also QAreaSeries::pointLabelsFormat
pointLabelsFormat : QString▲
This property holds the format used for showing labels with series points.
QAreaSeries supports the following format tags:
|
@xPoint |
The x value of the data point |
|
@yPoint |
The y value of the data point |
For example, the following usage of the format tags would produce labels that have the data point (x, y) shown inside brackets separated by a comma:
series->setPointLabelsFormat("(@xPoint, @yPoint)");By default, the label format is set to @xPoint, @yPoint. The labels are shown on the plot area, whereas labels on the edge of the plot area are cut. If the points are close to each other, the labels may overlap.
Access functions:
-
pointLabelsFormat() const
-
void setPointLabelsFormat(const &format)
Notifier signal:
-
void pointLabelsFormatChanged(const &format)
See Also▲
pointLabelsVisible : bool▲
This property holds the visibility of data point labels. False by default.
Access functions:
-
bool pointLabelsVisible() const
-
void setPointLabelsVisible(bool visible = true)
Notifier signal:
-
void pointLabelsVisibilityChanged(bool visible)
See Also▲
[read-only] upperSeries : QLineSeries* const▲
This property holds the upper one of the two line series used to define area series boundaries.
Access functions:
-
*upperSeries() const
Member Function Documentation▲
[explicit] QAreaSeries::QAreaSeries(QObject *parent = nullptr)▲
Constructs an area series object without an upper or a lower series with the parent object.
[explicit] QAreaSeries::QAreaSeries(QLineSeries *upperSeries, QLineSeries *lowerSeries = nullptr)▲
Constructs an area series object that will be spanned between an upperSeries line and a lowerSeries line. If no lowerSeries is passed to the constructor, the x-axis is used as the lower bound instead.
The QAreaSeries does not own the upper or lower series, but the ownership stays with the caller. When the series object is added to QChartView or QChart, the instance ownership is transferred.
[virtual] QAreaSeries::~QAreaSeries()▲
Destroys the object.
void QAreaSeries::borderColorChanged(QColor color)▲
This signal is emitted when the line (pen) color changes to color.
Notifier signal for property borderColor.
QBrush QAreaSeries::brush() const▲
void QAreaSeries::clicked(const QPointF &point)▲
This signal is emitted when the user triggers a press on point by clicking it in an area chart.
See Also▲
See also pressed, released, doubleClicked
void QAreaSeries::colorChanged(QColor color)▲
This signal is emitted when the fill (brush) color changes to color.
Notifier signal for property color.
void QAreaSeries::doubleClicked(const QPointF &point)▲
This signal is emitted when the user triggers the first press in an area chart by doubleclicking point.
See Also▲
void QAreaSeries::hovered(const QPointF &point, bool state)▲
This signal is emitted when the user hovers the mouse cursor over a series or moves it away from the series. point shows the origin (coordinate) of the hover event. state is true when the cursor hovers over the series and turns false when it moves away from the series.
QPen QAreaSeries::pen() const▲
void QAreaSeries::pointLabelsClippingChanged(bool clipping)▲
This signal is emitted when the clipping of the data point labels changes to clipping.
Notifier signal for property pointLabelsClipping.
void QAreaSeries::pointLabelsColorChanged(const QColor &color)▲
This signal is emitted when the color used for data point labels changes to color.
Notifier signal for property pointLabelsColor.
void QAreaSeries::pointLabelsFontChanged(const QFont &font)▲
This signal is emitted when the font used for data point labels changes to font.
Notifier signal for property pointLabelsFont.
void QAreaSeries::pointLabelsFormatChanged(const QString &format)▲
This signal is emitted when the format of data point labels is changed.
Notifier signal for property pointLabelsFormat.
void QAreaSeries::pointLabelsVisibilityChanged(bool visible)▲
This signal is emitted when the visibility of the data point labels changes to visible.
Notifier signal for property pointLabelsVisible.
bool QAreaSeries::pointsVisible() const▲
void QAreaSeries::pressed(const QPointF &point)▲
This signal is emitted when the user presses the point specified by point in an area chart.
See Also▲
See also clicked, released, doubleClicked
void QAreaSeries::released(const QPointF &point)▲
This signal is emitted when the user releases a press that was triggered on point in an area chart.
See Also▲
See also pressed, clicked, doubleClicked
void QAreaSeries::setBrush(const QBrush &brush)▲
void QAreaSeries::setLowerSeries(QLineSeries *series)▲
void QAreaSeries::setPen(const QPen &pen)▲
void QAreaSeries::setPointsVisible(bool visible = true)▲
Determines whether data points are visible and should be drawn on the line.
See Also▲
See also pointsVisible()
void QAreaSeries::setUpperSeries(QLineSeries *series)▲
Sets the series that is to be used as the area chart upper series. If the upper series is null, the area chart is not drawn, even if it has a lower series.
See Also▲
See also upperSeries()
[override virtual] QAbstractSeries::SeriesType QAreaSeries::type() const▲
Reimplements an access function for property: QAbstractSeries::type.
Returns QAbstractSeries::SeriesTypeArea.