Class: QgsReport

Represents a report for use with the QgsLayout engine.

Reports consist of multiple sections, represented by QgsAbstractReportSection subclasses.

Warning

This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings for unit testing purposes only.

Class Hierarchy

Base classes

QObject
QgsAbstractReportSection	An abstract base class for QgsReport subsections.
QgsAbstractLayoutIterator	An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter.
QgsMasterLayoutInterface	Interface for master layout type objects, such as print layouts and reports.

Signals

nameChanged

Emitted when the report's name is changed.

class qgis.core.QgsReport

Bases: QObject, QgsAbstractReportSection, QgsMasterLayoutInterface

__init__(project: QgsProject | None)

Constructor for QgsReport, associated with the specified project.

Note that ownership is not transferred to project.

Parameters:

project (Optional[QgsProject])

signal nameChanged(name: str)

Emitted when the report’s name is changed.

See also

setName()

Parameters:

name (str)