Class: QgsReportSectionFieldGroup

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

Bases: qgis._core.QgsAbstractReportSection

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

A report section consisting of a features

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: Enums

Methods

beginRender
body Returns the body layout for the section.
bodyEnabled Returns True if the body for the section is enabled.
clone
copyCommonProperties
description
field Returns the field associated with this section.
footerVisibility Returns the footer visibility mode.
headerVisibility Returns the header visibility mode.
icon
layer Returns the vector layer associated with this section.
nextBody
prepareFooter
prepareHeader
readPropertiesFromElement
reloadSettings
reset
setBody Sets the body layout for the section.
setBodyEnabled Sets whether the body for the section is enabled.
setField Sets the field associated with this section.
setFooterVisibility Sets the visibility mode for the footer.
setHeaderVisibility Sets the visibility mode for the header.
setLayer Sets the vector layer associated with this section.
setParentSection
setSortAscending Sets whether the field values should be sorted ascending.
sortAscending Returns True if the field values should be sorted ascending, or False for descending sort.
type
writePropertiesToElement

Signals

Attributes

AlwaysInclude
IncludeWhenFeaturesFound
AlwaysInclude = 1
IncludeWhenFeaturesFound = 0
class SectionVisibility

Bases: int

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) → QgsReportSectionFieldGroup
copyCommonProperties()
description(self) → str
field(self) → str

Returns the field associated with this section.

See also

setField()

footerVisibility(self) → QgsReportSectionFieldGroup.SectionVisibility

Returns the footer visibility mode.

headerVisibility(self) → QgsReportSectionFieldGroup.SectionVisibility

Returns the header visibility mode.

icon(self) → QIcon
layer(self) → QgsVectorLayer

Returns the vector layer associated with this section.

See also

setLayer()

nextBody(self) → Tuple[QgsLayout, bool]
prepareFooter(self) → bool
prepareHeader(self) → bool
readPropertiesFromElement(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool
reloadSettings(self)
reset(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()

setField(self, field: str)

Sets the field associated with this section.

See also

field()

setFooterVisibility(self, visibility: QgsReportSectionFieldGroup.SectionVisibility)

Sets the visibility mode for the footer.

setHeaderVisibility(self, visibility: QgsReportSectionFieldGroup.SectionVisibility)

Sets the visibility mode for the header.

setLayer(self, layer: QgsVectorLayer)

Sets the vector layer associated with this section.

See also

layer()

setParentSection(self, parentSection: QgsAbstractReportSection)
setSortAscending(self, sortAscending: bool)

Sets whether the field values should be sorted ascending. Set to True to sort ascending, or False for descending sort.

See also

sortAscending()

sortAscending(self) → bool

Returns True if the field values should be sorted ascending, or False for descending sort.

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