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 toparent
.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
Returns the body layout for the section.
Returns true if the body for the section is enabled.
Returns the field associated with this section.
Returns the footer visibility mode.
Returns the header visibility mode.
Returns the vector layer associated with this section.
Sets the
body
layout for the section.Sets whether the body for the section is
enabled
.Sets the
field
associated with this section.Sets the visibility mode for the footer.
Sets the visibility mode for the header.
Sets the vector
layer
associated with this section.Sets whether the field values should be sorted ascending.
Returns true if the field values should be sorted ascending, or false for descending sort.
Signals
Attributes
-
AlwaysInclude
= 1¶
-
IncludeWhenFeaturesFound
= 0¶
-
class
SectionVisibility
¶ Bases:
int
-
beginRender
(self) → bool¶
-
body
(self) → QgsLayout¶ Returns the body layout for the section.
See also
See also
See also
-
bodyEnabled
(self) → bool¶ Returns true if the body for the section is enabled.
See also
See also
See also
-
clone
(self) → QgsReportSectionFieldGroup¶
-
copyCommonProperties
()¶
-
description
(self) → str¶
-
field
(self) → str¶ Returns the field associated with this section.
See also
Returns the footer visibility mode.
See also
-
headerVisibility
(self) → QgsReportSectionFieldGroup.SectionVisibility¶ Returns the header visibility mode.
See also
-
icon
(self) → QIcon¶
-
layer
(self) → QgsVectorLayer¶ Returns the vector layer associated with this section.
See also
-
nextBody
(self) → Tuple[QgsLayout, 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 ofbody
is transferred to the report section.See also
See also
See also
-
setBodyEnabled
(self, enabled: bool)¶ Sets whether the body for the section is
enabled
.See also
See also
See also
Sets the visibility mode for the footer.
See also
-
setHeaderVisibility
(self, visibility: QgsReportSectionFieldGroup.SectionVisibility)¶ Sets the visibility mode for the header.
See also
-
setLayer
(self, layer: QgsVectorLayer)¶ Sets the vector
layer
associated with this section.See also
-
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
(self) → bool¶ Returns true if the field values should be sorted ascending, or false for descending sort.
See also
-
type
(self) → str¶
-
writePropertiesToElement
(self, element: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶
-