Subgroup: Report

Class: QgsReportSectionLayout

class qgis.core.QgsReportSectionLayout(parentSection: QgsAbstractReportSection = None)

Bases: qgis._core.QgsAbstractReportSection

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

A report section consisting of a single QgsLayout body.

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

beginRender
body Returns the body layout for the section.
bodyEnabled Returns true if the body for the section is enabled.
clone
copyCommonProperties
description
icon
nextBody
readPropertiesFromElement
reloadSettings
setBody Sets the body layout for the section.
setBodyEnabled Sets whether the body for the section is enabled.
setParentSection
type
writePropertiesToElement

Signals

Attributes

beginRender(self) → bool
body(self) → QgsLayout

Returns the body layout for the section.

See also

setBody()

See also

bodyEnabled()

See also

setBodyEnabled()

bodyEnabled(self) → bool

Returns true if the body for the section is enabled.

See also

setBodyEnabled()

See also

body()

See also

setBody()

clone(self) → QgsReportSectionLayout
copyCommonProperties()
description(self) → str
icon(self) → QIcon
nextBody(self) → Tuple[QgsLayout, bool]
readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
reloadSettings(self)
setBody(self, body: QgsLayout)

Sets the body layout for the section. Ownership of body is transferred to the report section.

See also

body()

See also

bodyEnabled()

See also

setBodyEnabled()

setBodyEnabled(self, enabled: bool)

Sets whether the body for the section is enabled.

See also

bodyEnabled()

See also

body()

See also

setBody()

setParentSection()
type(self) → str
writePropertiesToElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool