Class: QgsAbstractReportSection¶

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.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: clone(), description(), icon(), type()

Class Hierarchy¶

Base classes¶

QgsAbstractLayoutIterator

An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter.

Subclasses¶

`QgsReport`	Represents a report for use with the `QgsLayout` engine.
`QgsReportSectionFieldGroup`	A report section consisting of a features.
`QgsReportSectionLayout`	A report section consisting of a single `QgsLayout` body.

Abstract Methods

`clone`	Clones the report section.
`description`	Returns a user-visible, translated description of the section.
`icon`	Returns an icon representing the section.
`type`	Returns the section subclass type.

Methods

`accept`	Accepts the specified style entity visitor, causing it to visit all style entities associated with the report.
`appendChild`	Adds a child section, transferring ownership of the section to this section.
`childCount`	Returns the number of child sections for this report section.
`childSection`	Returns the child section at the specified index.
`childSections`	Returns all child sections for this report section.
`context`	Returns the current context for this section.
`copyCommonProperties`	Copies the common properties of a report section to a destination section.
`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.
`insertChild`	Inserts a child section at the specified index, transferring ownership of the section to this section.
`parentSection`	Returns the parent report section.
`project`	Returns the associated project.
`readXml`	Sets the item state from a DOM element.
`removeChild`	Removes a child section, deleting it.
`removeChildAt`	Removes the child section at the specified index, deleting it.
`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.
`writeXml`	Stores the section state in a DOM element.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsAbstractReportSection. See the FAQ for more details.

`nextBody`	Returns the next body layout to export, or `None` if no body layout is required this iteration.
`prepareFooter`	Called just before rendering the section's footer.
`prepareHeader`	Called just before rendering the section's header.
`readPropertiesFromElement`	Sets section state from a DOM element.
`reloadSettings`	Refreshes the section when global layout related options change.
`reset`	Resets the section, ready for a new iteration.
`setParentSection`	Sets the parent report section.
`writePropertiesToElement`	Stores section state within an XML DOM element.

Attributes

`Body`
`Children`
`End`
`Footer`
`Header`

class qgis.core.QgsAbstractReportSection[source]¶

Bases: QgsAbstractLayoutIterator

__init__(parentSection: QgsAbstractReportSection | None = None)

Constructor for QgsAbstractReportSection, attached to the specified parent section. Note that ownership is not transferred to parent.

Parameters:: parentSection (Optional[QgsAbstractReportSection] = None)

Body = 1¶

Children = 2¶

End = 4¶

Footer = 3¶

Header = 0¶

class SubSection¶: Bases: int

accept(self, visitor: QgsStyleEntityVisitorInterface | None) → bool[source]¶

Accepts the specified style entity visitor, causing it to visit all style entities associated with the report.

Returns True if the visitor should continue visiting other objects, or False if visiting should be canceled.

Added in version 3.10.

Parameters:: visitor (Optional[QgsStyleEntityVisitorInterface])
Return type:: bool

appendChild(self, section: QgsAbstractReportSection | None)[source]¶

Adds a child section, transferring ownership of the section to this section.

See also

children()

See also

insertChild()

Parameters:: section (Optional[QgsAbstractReportSection])

childCount(self) → int[source]¶

Returns the number of child sections for this report section. The child sections form the body of the report section.

See also

children()

Return type:: int

childSection(self, index: int) → QgsAbstractReportSection | None[source]¶

Returns the child section at the specified index.

See also

children()

Parameters:: index (int)
Return type:: Optional[QgsAbstractReportSection]

childSections(self) → List[QgsAbstractReportSection]¶

Returns all child sections for this report section. The child sections form the body of the report section.

See also

childCount()

See also

child()

See also

appendChild()

See also

insertChild()

See also

removeChild()

Return type:: List[QgsAbstractReportSection]

abstract clone(self) → QgsAbstractReportSection | None[source]¶

Clones the report section. Ownership of the returned section is transferred to the caller.

Subclasses should call copyCommonProperties() in their clone() implementations.

Return type:: Optional[QgsAbstractReportSection]

context(self) → QgsReportSectionContext¶

Returns the current context for this section.

See also

setContext()

Return type:: QgsReportSectionContext

copyCommonProperties(self, destination: QgsAbstractReportSection | None)[source]¶

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

Parameters:: destination (Optional[QgsAbstractReportSection])

abstract description(self) → str[source]¶

Returns a user-visible, translated description of the section.

Return type:: str

footer(self) → QgsLayout | None[source]¶

Returns the footer for the section. Note that the footer is only included if footerEnabled() is True.

See also

setFooterEnabled()

See also

footerEnabled()

See also

setFooter()

Return type:: Optional[QgsLayout]

footerEnabled(self) → bool[source]¶

Returns True if the footer for the section is enabled.

See also

setFooterEnabled()

See also

footer()

See also

setFooter()

Return type:: bool

header(self) → QgsLayout | None[source]¶

Returns the header for the section. Note that the header is only included if headerEnabled() is True.

See also

setHeaderEnabled()

See also

headerEnabled()

See also

setHeader()

Return type:: Optional[QgsLayout]

headerEnabled(self) → bool[source]¶

Returns True if the header for the section is enabled.

See also

setHeaderEnabled()

See also

header()

See also

setHeader()

Return type:: bool

abstract icon(self) → QIcon[source]¶

Returns an icon representing the section.

Return type:: QIcon

insertChild(self, index: int, section: QgsAbstractReportSection | None)[source]¶

Inserts a child section at the specified index, transferring ownership of the section to this section.

See also

children()

See also

appendChild()

Parameters:

index (int)
section (Optional[QgsAbstractReportSection])

virtual nextBody(self)[source]¶

Returns the next body layout to export, or 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 | None[source]¶

Returns the parent report section.

Return type:: Optional[QgsAbstractReportSection]

virtual prepareFooter(self) → bool[source]¶

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()

Return type:: bool

virtual prepareHeader(self) → bool[source]¶

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

prepareFooter()

Return type:: bool

project(self) → QgsProject | None[source]¶

Returns the associated project.

Return type:: Optional[QgsProject]

virtual readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool[source]¶

Sets section state from a DOM element.

See also

writePropertiesToElement()

See also

readXml()

Parameters:

element (QDomElement)
document (QDomDocument)
context (QgsReadWriteContext)

Return type:

bool

readXml(self, sectionElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool[source]¶

Sets the item state from a DOM element.

See also

writeXml()

Parameters:

sectionElement (QDomElement)
document (QDomDocument)
context (QgsReadWriteContext)

Return type:

bool

virtual reloadSettings(self)[source]¶: Refreshes the section when global layout related options change.

removeChild(self, section: QgsAbstractReportSection | None)[source]¶

Removes a child section, deleting it.

See also

children()

Parameters:: section (Optional[QgsAbstractReportSection])

removeChildAt(self, index: int)[source]¶

Removes the child section at the specified index, deleting it.

See also

children()

Parameters:: index (int)

virtual reset(self)[source]¶: Resets the section, ready for a new iteration.

row(self) → int[source]¶

Returns the row number of the section within it’s parent section.

Return type:: int

setContext(self, context: QgsReportSectionContext)[source]¶

Sets the current context for this section.

See also

context()

Parameters:: context (QgsReportSectionContext)

setFooter(self, footer: QgsLayout | None)[source]¶

Sets the footer for the section. Note that the footer is only included if footerEnabled() is True. Ownership of footer is transferred to the report section.

See also

setFooterEnabled()

See also

footerEnabled()

See also

footer()

Parameters:: footer (Optional[QgsLayout])

setFooterEnabled(self, enabled: bool)[source]¶

Sets whether the footer for the section is enabled.

See also

footerEnabled()

See also

footer()

See also

setFooter()

Parameters:: enabled (bool)

setHeader(self, header: QgsLayout | None)[source]¶

Sets the header for the section. Note that the header is only included if headerEnabled() is True. Ownership of header is transferred to the report section.

See also

setHeaderEnabled()

See also

headerEnabled()

See also

header()

Parameters:: header (Optional[QgsLayout])

setHeaderEnabled(self, enabled: bool)[source]¶

Sets whether the header for the section is enabled.

See also

headerEnabled()

See also

header()

See also

setHeader()

Parameters:: enabled (bool)

virtual setParentSection(self, parent: QgsAbstractReportSection | None)[source]¶

Sets the parent report section.

Parameters:: parent (Optional[QgsAbstractReportSection])

abstract type(self) → str[source]¶

Returns the section subclass type.

Return type:: str

virtual writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool[source]¶

Stores section state within an XML DOM element.

See also

writeXml()

See also

readPropertiesFromElement()

Parameters:

element (QDomElement)
document (QDomDocument)
context (QgsReadWriteContext)

Return type:

bool

writeXml(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool[source]¶

Stores the section state in a DOM element.

See also

readXml()

Parameters:

parentElement (QDomElement)
document (QDomDocument)
context (QgsReadWriteContext)

Return type:

bool