class QAreaSeries

The QAreaSeries class presents data in area charts. More…

Synopsis

Properties

• borderColorᅟ - Line (pen) color of the series. This is a convenience property for modifying the color of the pen

• colorᅟ - Fill (brush) color of the series. This is a convenience property for modifying the color of the brush

• pointLabelsClippingᅟ - Clipping for data point labels. True by default. The labels on the edge of the plot area are cut when clipping is enabled

• pointLabelsColorᅟ - Color used for data point labels. By default, the color is the color of the brush defined for labels in the theme

• pointLabelsFontᅟ - Font used for data point labels

• pointLabelsFormatᅟ - Format used for showing labels with series points

• pointLabelsVisibleᅟ - Visibility of data point labels. False by default

Methods

• def __init__()

• def borderColor()

• def brush()

• def color()

• def pen()

• def pointLabelsClipping()

• def pointLabelsColor()

• def pointLabelsFont()

• def pointLabelsFormat()

• def pointLabelsVisible()

• def pointsVisible()

• def setBorderColor()

• def setBrush()

• def setColor()

• def setPen()

• def setPointLabelsClipping()

• def setPointLabelsColor()

• def setPointLabelsFont()

• def setPointLabelsFormat()

• def setPointLabelsVisible()

• def setPointsVisible()

Signals

• def borderColorChanged()

• def clicked()

• def colorChanged()

• def doubleClicked()

• def hovered()

• def pointLabelsClippingChanged()

• def pointLabelsColorChanged()

• def pointLabelsFontChanged()

• def pointLabelsFormatChanged()

• def pointLabelsVisibilityChanged()

• def pressed()

• def released()

• def selected()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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.

Note

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 Charts with Widgets Gallery to learn how to create a simple area chart.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property borderColorᅟ: QColor

This property holds The line (pen) color of the series. This is a convenience property for modifying the color of the pen..

See also

pen()

Access functions:

• borderColor()

• setBorderColor()

• Signal borderColorChanged()

property colorᅟ: QColor

This property holds The fill (brush) color of the series. This is a convenience property for modifying the color of the brush..

See also

brush()

Access functions:

• color()

• setColor()

• Signal colorChanged()

property 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..

See also

pointLabelsVisible

Access functions:

• pointLabelsClipping()

• setPointLabelsClipping()

• Signal pointLabelsClippingChanged()

property 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..

See also

pointLabelsFormat

Access functions:

• pointLabelsColor()

• setPointLabelsColor()

• Signal pointLabelsColorChanged()

property pointLabelsFontᅟ: QFont

This property holds The font used for data point labels..

See also

pointLabelsFormat

Access functions:

• pointLabelsFont()

• setPointLabelsFont()

• Signal pointLabelsFontChanged()

property pointLabelsFormatᅟ: str

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.

See also

pointLabelsVisible pointLabelsFont pointLabelsColor

Access functions:

• pointLabelsFormat()

• setPointLabelsFormat()

• Signal pointLabelsFormatChanged()

property pointLabelsVisibleᅟ: bool

This property holds The visibility of data point labels. False by default..

See also

pointLabelsFormat pointLabelsClipping

Access functions:

• pointLabelsVisible()

• setPointLabelsVisible()

• Signal pointLabelsVisibilityChanged()

__init__([parent=None])

Parameters:

parent – QObject

Constructs an area series object without an upper or a lower series with the parent object.

borderColor()

Return type:

QColor

See also

setBorderColor()

Getter of property borderColorᅟ .

borderColorChanged(color)

Parameters:

color – QColor

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

Notification signal of property borderColorᅟ .

brush()

Return type:

QBrush

Returns the brush used to draw the line for this series.

See also

setBrush()

clicked(point)

Parameters:

point – QPointF

This signal is emitted when the user triggers a press on point by clicking it in an area chart.

See also

pressed released doubleClicked

color()

Return type:

QColor

See also

setColor()

Getter of property colorᅟ .

colorChanged(color)

Parameters:

color – QColor

This signal is emitted when the fill (brush) color changes to color.

Notification signal of property colorᅟ .

doubleClicked(point)

Parameters:

point – QPointF

This signal is emitted when the user triggers the first press in an area chart by doubleclicking point.

See also

pressed released clicked

hovered(point, state)

Parameters:

• point – QPointF

• state – bool

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.

pen()

Return type:

QPen

Returns the pen used to draw the line for this series.

See also

setPen()

pointLabelsClipping()

Return type:

bool

See also

setPointLabelsClipping()

Getter of property pointLabelsClippingᅟ .

pointLabelsClippingChanged(clipping)

Parameters:

clipping – bool

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

Notification signal of property pointLabelsClippingᅟ .

pointLabelsColor()

Return type:

QColor

See also

setPointLabelsColor()

Getter of property pointLabelsColorᅟ .

pointLabelsColorChanged(color)

Parameters:

color – QColor

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

Notification signal of property pointLabelsColorᅟ .

pointLabelsFont()

Return type:

QFont

See also

setPointLabelsFont()

Getter of property pointLabelsFontᅟ .

pointLabelsFontChanged(font)

Parameters:

font – QFont

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

Notification signal of property pointLabelsFontᅟ .

pointLabelsFormat()

Return type:

str

See also

setPointLabelsFormat()

Getter of property pointLabelsFormatᅟ .

pointLabelsFormatChanged(format)

Parameters:

format – str

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

Notification signal of property pointLabelsFormatᅟ .

pointLabelsVisibilityChanged(visible)

Parameters:

visible – bool

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

Notification signal of property pointLabelsVisibleᅟ .

pointLabelsVisible()

Return type:

bool

See also

setPointLabelsVisible()

Getter of property pointLabelsVisibleᅟ .

pointsVisible()

Return type:

bool

Returns whether the points are drawn for this series.

See also

setPointsVisible()

pressed(point)

Parameters:

point – QPointF

This signal is emitted when the user presses the point specified by point in an area chart.

See also

clicked released doubleClicked

released(point)

Parameters:

point – QPointF

This signal is emitted when the user releases a press that was triggered on point in an area chart.

See also

pressed clicked doubleClicked

selected()

setBorderColor(color)

Parameters:

color – QColor

See also

borderColor()

Setter of property borderColorᅟ .

setBrush(brush)

Parameters:

brush – QBrush

Sets the brush used for filling the area.

See also

brush()

setColor(color)

Parameters:

color – QColor

See also

color()

Setter of property colorᅟ .

setPen(pen)

Parameters:

pen – QPen

Sets the pen used for drawing the area outline.

See also

pen()

setPointLabelsClipping([enabled=true])

Parameters:

enabled – bool

See also

pointLabelsClipping()

Setter of property pointLabelsClippingᅟ .

setPointLabelsColor(color)

Parameters:

color – QColor

See also

pointLabelsColor()

Setter of property pointLabelsColorᅟ .

setPointLabelsFont(font)

Parameters:

font – QFont

See also

pointLabelsFont()

Setter of property pointLabelsFontᅟ .

setPointLabelsFormat(format)

Parameters:

format – str

See also

pointLabelsFormat()

Setter of property pointLabelsFormatᅟ .

setPointLabelsVisible([visible=true])

Parameters:

visible – bool

See also

pointLabelsVisible()

Setter of property pointLabelsVisibleᅟ .

setPointsVisible([visible=true])

Parameters:

visible – bool

Determines whether data points are visible and should be drawn on the line.

See also

pointsVisible()