QgsLayoutItemChart::SeriesDetails Class Reference

Chart series details covering all supported series types. More...

#include <qgslayoutitemchart.h>

Public Member Functions
	SeriesDetails (const QString &name=QString())
	Constructor for SeriesDetails with an optional name parameter to provide a name string to the series.
QString	filterExpression () const
	Returns the filter expression used to generate a series against a subset of the source layer.
QString	name () const
	Returns the series name.
bool	operator== (const SeriesDetails &other) const
void	setFilterExpression (const QString &filterExpression)
	Sets the filter expression used to generate a series against a subset of the source layer.
void	setName (const QString &name)
	Sets the series name.
void	setXExpression (const QString &xExpression)
	Sets the expression used to generate X-axis values.
void	setYExpression (const QString &yExpression)
	Sets the expression used to generate Y-axis values.
QString	xExpression () const
	Returns the expression used to generate X-axis values.
QString	yExpression () const
	Returns the expression used to generate Y-axis values.

Detailed Description

Chart series details covering all supported series types.

Note

this class is experimental and therefore is not considered as stable API, it may change in the future as more chart plot types are implemented.

Since

QGIS 4.0

Definition at line 48 of file qgslayoutitemchart.h.

Constructor & Destructor Documentation

SeriesDetails()

QgsLayoutItemChart::SeriesDetails::SeriesDetails ( const QString & name = QString() )

inlineexplicit

Constructor for SeriesDetails with an optional name parameter to provide a name string to the series.

Definition at line 56 of file qgslayoutitemchart.h.

Member Function Documentation

filterExpression()

QString QgsLayoutItemChart::SeriesDetails::filterExpression ( ) const

inline

Returns the filter expression used to generate a series against a subset of the source layer.

Definition at line 110 of file qgslayoutitemchart.h.

name()

QString QgsLayoutItemChart::SeriesDetails::name ( ) const

inline

Returns the series name.

Definition at line 71 of file qgslayoutitemchart.h.

operator==()

bool QgsLayoutItemChart::SeriesDetails::operator== ( const SeriesDetails & other ) const

inline

Definition at line 60 of file qgslayoutitemchart.h.

setFilterExpression()

void QgsLayoutItemChart::SeriesDetails::setFilterExpression ( const QString & filterExpression )

inline

Sets the filter expression used to generate a series against a subset of the source layer.

Definition at line 116 of file qgslayoutitemchart.h.

setName()

void QgsLayoutItemChart::SeriesDetails::setName ( const QString & name )

inline

Sets the series name.

Definition at line 76 of file qgslayoutitemchart.h.

setXExpression()

void QgsLayoutItemChart::SeriesDetails::setXExpression ( const QString & xExpression )

inline

Sets the expression used to generate X-axis values.

If the associated chart X axis type is set to Qgis.PlotAxisType.Categorical, the generated values will be converted to strings. For Qgis.PlotAxisType.Interval, the generated values will be converted to double.

Definition at line 92 of file qgslayoutitemchart.h.

setYExpression()

void QgsLayoutItemChart::SeriesDetails::setYExpression ( const QString & yExpression )

inline

Sets the expression used to generate Y-axis values.

The generated values will be converted to double.

Definition at line 104 of file qgslayoutitemchart.h.

xExpression()

QString QgsLayoutItemChart::SeriesDetails::xExpression ( ) const

inline

Returns the expression used to generate X-axis values.

If the associated chart X axis type is set to Qgis.PlotAxisType.Categorical, the generated values will be converted to strings. For Qgis.PlotAxisType.Interval, the generated values will be converted to double.

Definition at line 84 of file qgslayoutitemchart.h.

yExpression()

QString QgsLayoutItemChart::SeriesDetails::yExpression ( ) const

inline

Returns the expression used to generate Y-axis values.

The generated values will be converted to double.

Definition at line 98 of file qgslayoutitemchart.h.

---

The documentation for this class was generated from the following file:

• /build/qgis-3.99.0+git20251205+26c88405ac0+99sid/src/core/layout/qgslayoutitemchart.h