Subgroup: Report

Class: QgsReport¶

class qgis.core.QgsReport¶

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

New in version 3.0: Methods

`appendChild`	Adds a child `section`, transferring ownership of the section to this section.
`beginRender`
`blockSignals`
`childCount`	Return the number of child sections for this report section.
`childEvent`
`childSection`	Returns the child section at the specified `index`.
`childSections`	Return all child sections for this report section.
`children`
`clone`
`connectNotify`
`context`	Returns the current context for this section.
`copyCommonProperties`
`count`
`customEvent`
`deleteLater`
`description`
`disconnect`
`disconnectNotify`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`endRender`
`event`
`eventFilter`
`filePath`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`footer`	Returns the footer for the section.
`footerEnabled`	Returns true if the footer for the section is enabled.
`header`	Returns the header for the section.
`headerEnabled`	Returns true if the header for the section is enabled.
`icon`
`inherits`
`insertChild`	Inserts a child `section` at the specified `index`, transferring ownership of the section to this section.
`installEventFilter`
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`layout`
`layoutProject`
`layoutType`
`metaObject`
`moveToThread`
`name`
`next`
`nextBody`	Returns the next body layout to export, or a None if no body layout is required this iteration.
`objectName`
`parent`
`parentSection`	Returns the parent report section.
`prepareFooter`	Called just before rendering the section’s footer.
`prepareHeader`	Called just before rendering the section’s header.
`project`	Returns the associated project.
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`readLayoutXml`
`readPropertiesFromElement`
`readXml`	Sets the item state from a DOM element.
`receivers`
`removeChild`	Removes a child `section`, deleting it.
`removeChildAt`	Removes the child section at the specified `index`, deleting it.
`removeEventFilter`
`reset`	Resets the section, ready for a new iteration.
`row`	Returns the row number of the section within it’s parent section.
`sender`
`senderSignalIndex`
`setContext`	Sets the current `context` for this section.
`setFooter`	Sets the `footer` for the section.
`setFooterEnabled`	Sets whether the footer for the section is `enabled`.
`setHeader`	Sets the `header` for the section.
`setHeaderEnabled`	Sets whether the header for the section is `enabled`.
`setName`
`setObjectName`
`setParent`
`setParentSection`
`setProperty`
`signalsBlocked`
`startTimer`
`thread`
`timerEvent`
`tr`
`type`
`writeLayoutXml`
`writePropertiesToElement`
`writeXml`	Stores the section state in a DOM element.

Attributes

`Body`
`Children`
`End`
`Footer`
`Header`
`PrintLayout`
`Report`
`destroyed`	destroyed(self, QObject = None) [signal]
`nameChanged`	Emitted when the report’s name is changed.
`objectNameChanged`	objectNameChanged(self, str) [signal]
`staticMetaObject`

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¶

writeLayoutXml(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement¶

writePropertiesToElement()¶