Class: QgsReport

class qgis.core.QgsReport(project: QgsProject)

Bases: PyQt5.QtCore.QObject, QgsAbstractReportSection, 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.

New in version 3.0.

Parameters

project

childEvent()
clone(self) → QgsReport
Return type

QgsReport

connectNotify()
copyCommonProperties()
customEvent()
description(self) → str
Return type

str

disconnectNotify()
icon(self) → QIcon
Return type

QIcon

isSignalConnected()
layoutAccept(self, visitor: QgsStyleEntityVisitorInterface) → bool
Parameters

visitor (QgsStyleEntityVisitorInterface) –

Return type

bool

layoutProject(self) → QgsProject
Return type

QgsProject

layoutType(self) → QgsMasterLayoutInterface.Type
Return type

QgsMasterLayoutInterface.Type

name(self) → str
Return type

str

nameChanged

Emitted when the report’s name is changed.

See also

setName() [signal]

Parameters

name (str) –

readLayoutXml(self, layoutElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
Parameters
  • layoutElement (QDomElement) –

  • document (QDomDocument) –

  • context (QgsReadWriteContext) –

Return type

bool

readPropertiesFromElement()
receivers()
sender()
senderSignalIndex()
setName(self, name: str)
Parameters

name (str) –

setParentSection()
timerEvent()
type(self) → str
Return type

str

updateSettings(self)
writeLayoutXml(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement
Parameters
Return type

QDomElement

writePropertiesToElement()