Class: QgsReport

class qgis.core.QgsReport

Bases: PyQt5.QtCore.QObject, QgsAbstractReportSection, QgsMasterLayoutInterface

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.

QgsReport(project: Optional[QgsProject]) Constructor for QgsReport, associated with the specified project.

Note that ownership is not transferred to project.

Methods

childEvent

clone

rtype:

Optional[QgsReport]

connectNotify

copyCommonProperties

Copies the common properties of a report section to a destination section.

customEvent

description

rtype:

str

disconnectNotify

icon

rtype:

QIcon

isSignalConnected

layoutAccept

param visitor:

layoutProject

rtype:

Optional[QgsProject]

layoutType

rtype:

QgsMasterLayoutInterface.Type

name

rtype:

str

readLayoutXml

param layoutElement:

readPropertiesFromElement

Sets section state from a DOM element.

receivers

sender

senderSignalIndex

setName

param name:

setParentSection

Sets the parent report section.

timerEvent

type

rtype:

str

updateSettings

writeLayoutXml

param document:

writePropertiesToElement

Stores section state within an XML DOM element.

Signals

nameChanged

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

childEvent(self, a0: QChildEvent | None)
clone(self) QgsReport | None
Return type:

Optional[QgsReport]

connectNotify(self, signal: QMetaMethod)
copyCommonProperties(self, destination: QgsAbstractReportSection | None)

Copies the common properties of a report section to a destination section. This method should be called from clone() implementations.

customEvent(self, a0: QEvent | None)
description(self) str
Return type:

str

disconnectNotify(self, signal: QMetaMethod)
icon(self) QIcon
Return type:

QIcon

isSignalConnected(self, signal: QMetaMethod) bool
layoutAccept(self, visitor: QgsStyleEntityVisitorInterface | None) bool
Parameters:

visitor (Optional[QgsStyleEntityVisitorInterface])

Return type:

bool

layoutProject(self) QgsProject | None
Return type:

Optional[QgsProject]

layoutType(self) QgsMasterLayoutInterface.Type
Return type:

QgsMasterLayoutInterface.Type

name(self) str
Return type:

str

nameChanged

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.

Parameters:
  • name (str = ...)

  • revision (int = ...)

  • arguments (Sequence = ...)

Return type:

PYQT_SIGNAL

readLayoutXml(self, layoutElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool
Parameters:
Return type:

bool

readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool

Sets section state from a DOM element.

See also

readXml()

receivers(self, signal: PYQT_SIGNAL) int
sender(self) QObject | None
senderSignalIndex(self) int
setName(self, name: str | None)
Parameters:

name (Optional[str])

setParentSection(self, parent: QgsAbstractReportSection | None)

Sets the parent report section.

timerEvent(self, a0: QTimerEvent | None)
type(self) str
Return type:

str

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

QDomElement

writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) bool

Stores section state within an XML DOM element.

See also

writeXml()