Subgroup: Report

Class: QgsReport

class qgis.core.QgsReport(project: QgsProject)

Bases: PyQt5.QtCore.QObject, qgis._core.QgsAbstractReportSection, qgis._core.QgsMasterLayoutInterface

Constructor for QgsReport, associated with the specified project.

Note that ownership is not transferred to project.

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.

childEvent()
clone(self) → QgsReport
connectNotify()
copyCommonProperties()
customEvent()
description(self) → str
disconnectNotify()
icon(self) → QIcon
isSignalConnected()
layoutProject(self) → QgsProject
layoutType(self) → QgsMasterLayoutInterface.Type
name(self) → str
nameChanged

Emitted when the report’s name is changed.

See also

setName() [signal]

readLayoutXml(self, layoutElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
readPropertiesFromElement()
receivers()
sender()
senderSignalIndex()
setName(self, name: str)
setParentSection()
timerEvent()
type(self) → str
updateSettings(self)
writeLayoutXml(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement
writePropertiesToElement()