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

Inheritance diagram of qgis.core.QgsReport

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.

class qgis.core.QgsReport[source]

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[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.