Subgroup: Abstract
Class: QgsAbstractReportSection¶
-
class
qgis.core.
QgsAbstractReportSection
(parentSection: QgsAbstractReportSection = None)¶ Bases:
qgis._core.QgsAbstractLayoutIterator
Constructor for QgsAbstractReportSection, attached to the specified
parent
section. Note that ownership is not transferred toparent
.An abstract base class for QgsReport subsections.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
childCount
Return the number of child sections for this report section. childSection
Returns the child section at the specified index
.childSections
Return all child sections for this report section. clone
Clones the report section. context
Returns the current context for this section. copyCommonProperties
Copies the common properties of a report section to a destination
section.count
description
Returns a user-visible, translated description of the section. endRender
filePath
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
Returns an icon representing the section. insertChild
Inserts a child section
at the specifiedindex
, transferring ownership of the section to this section.layout
next
nextBody
Returns the next body layout to export, or a None if no body layout is required this iteration. 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. readPropertiesFromElement
Sets section state from a DOM element. readXml
Sets the item state from a DOM element. reloadSettings
Refreshes the section when global layout related options change. removeChild
Removes a child section
, deleting it.removeChildAt
Removes the child section at the specified index
, deleting it.reset
Resets the section, ready for a new iteration. row
Returns the row number of the section within it’s parent section. 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
.setParentSection
Sets the parent
report section.type
Returns the section subclass type. writePropertiesToElement
Stores section state within an XML DOM element. writeXml
Stores the section state in a DOM element. Signals
Attributes
Body
Children
End
Footer
Header
-
Body
= 1¶
-
Children
= 2¶
-
End
= 4¶
-
Header
= 0¶
-
class
SubSection
¶ Bases:
int
-
appendChild
(self, section: QgsAbstractReportSection)¶ Adds a child
section
, transferring ownership of the section to this section.See also
children()
See also
-
beginRender
(self) → bool¶
-
childCount
(self) → int¶ Return the number of child sections for this report section. The child sections form the body of the report section.
See also
children()
-
childSection
(self, index: int) → QgsAbstractReportSection¶ Returns the child section at the specified
index
.See also
children()
-
childSections
(self) → object¶ Return all child sections for this report section. The child sections form the body of the report section.
See also
See also
child()
See also
See also
See also
-
clone
(self) → QgsAbstractReportSection¶ Clones the report section. Ownership of the returned section is transferred to the caller.
Subclasses should call copyCommonProperties() in their clone() implementations.
-
context
(self) → QgsReportSectionContext¶ Returns the current context for this section.
See also
-
copyCommonProperties
(self, destination: QgsAbstractReportSection)¶ Copies the common properties of a report section to a
destination
section. This method should be called from clone() implementations.
-
count
(self) → int¶
-
description
(self) → str¶ Returns a user-visible, translated description of the section.
-
endRender
(self) → bool¶
-
filePath
(self, baseFilePath: str, extension: str) → str¶
Returns the footer for the section. Note that the footer is only included if footerEnabled() is true.
See also
See also
See also
Returns true if the footer for the section is enabled.
See also
See also
See also
-
header
(self) → QgsLayout¶ Returns the header for the section. Note that the header is only included if headerEnabled() is true.
See also
See also
See also
-
headerEnabled
(self) → bool¶ Returns true if the header for the section is enabled.
See also
See also
See also
-
icon
(self) → QIcon¶ Returns an icon representing the section.
-
insertChild
(self, index: int, section: QgsAbstractReportSection)¶ Inserts a child
section
at the specifiedindex
, transferring ownership of the section to this section.See also
children()
See also
-
layout
(self) → QgsLayout¶
-
next
(self) → bool¶
-
nextBody
(self) → Tuple[QgsLayout, bool]¶ Returns the next body layout to export, or a None if no body layout is required this iteration.
ok
will be set to false if no bodies remain for this section.
-
parentSection
(self) → QgsAbstractReportSection¶ Returns the parent report section.
Called just before rendering the section’s footer. Should return true if the footer is to be included for this section, or false to skip the footerfor the current section.
See also
-
prepareHeader
(self) → bool¶ Called just before rendering the section’s header. Should return true if the header is to be included for this section, or false to skip the header for the current section.
See also
-
project
(self) → QgsProject¶ Returns the associated project.
-
readPropertiesFromElement
(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Sets section state from a DOM element.
See also
See also
-
readXml
(self, sectionElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Sets the item state from a DOM element.
See also
-
reloadSettings
(self)¶ Refreshes the section when global layout related options change.
-
removeChild
(self, section: QgsAbstractReportSection)¶ Removes a child
section
, deleting it.See also
children()
-
removeChildAt
(self, index: int)¶ Removes the child section at the specified
index
, deleting it.See also
children()
-
reset
(self)¶ Resets the section, ready for a new iteration.
-
row
(self) → int¶ Returns the row number of the section within it’s parent section.
-
setContext
(self, context: QgsReportSectionContext)¶ Sets the current
context
for this section.See also
Sets the
footer
for the section. Note that the footer is only included if footerEnabled() is true. Ownership offooter
is transferred to the report section.See also
See also
See also
Sets whether the footer for the section is
enabled
.See also
See also
See also
-
setHeader
(self, header: QgsLayout)¶ Sets the
header
for the section. Note that the header is only included if headerEnabled() is true. Ownership ofheader
is transferred to the report section.See also
See also
See also
-
setHeaderEnabled
(self, enabled: bool)¶ Sets whether the header for the section is
enabled
.See also
See also
See also
-
setParentSection
(self, parent: QgsAbstractReportSection)¶ Sets the
parent
report section.
-
type
(self) → str¶ Returns the section subclass type.
-
writePropertiesToElement
(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Stores section state within an XML DOM element.
See also
See also
-