Class: QgsReport¶
-
class
qgis.core.
QgsReport
(project: QgsProject)¶ Bases:
PyQt5.QtCore.QObject
,QgsAbstractReportSection
,QgsMasterLayoutInterface
Constructor for
QgsReport
, associated with the specifiedproject
.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
()¶
-
connectNotify
()¶
-
copyCommonProperties
()¶
-
customEvent
()¶
-
description
(self) → str¶ - Return type
str
-
disconnectNotify
()¶
-
icon
(self) → QIcon¶ - Return type
QIcon
-
isSignalConnected
()¶
-
layoutProject
(self) → QgsProject¶ - Return type
-
layoutType
(self) → QgsMasterLayoutInterface.Type¶ - Return type
-
name
(self) → str¶ - Return type
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
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement
-
writePropertiesToElement
()¶