Class: QgsAggregateMappingWidget

A widget which creates a mapping for defining sets of aggregates of fields from a QgsFields object.

Added in version 3.14.

Class Hierarchy

Base classes

QgsPanelWidget	Base class for any widget that can be shown as an inline panel.
QWidget
QObject
QPaintDevice

class qgis.gui.QgsAggregateMappingWidget

Bases: QgsPanelWidget

__init__(parent: QWidget | None = None, sourceFields: QgsFields = QgsFields())

Constructs a QgsAggregateMappingWidget from a set of sourceFields. A parent object can also be specified.

Parameters:

• parent (Optional[QWidget] = None)

• sourceFields (QgsFields = QgsFields())

appendField(self, field: QgsField, source: str | None = '', aggregate: str | None = '')

Appends a new field to the model, with an optional source and aggregate

Parameters:

• field (QgsField)

• source (Optional[str] = '')

• aggregate (Optional[str] = '')

signal changed

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

mapping(self) → List[QgsAggregateMappingModel.Aggregate]

Returns a list of Aggregate objects representing the current status of the underlying mapping model

Return type:

List[QgsAggregateMappingModel.Aggregate]

model(self) → QgsAggregateMappingModel | None

Returns the underlying mapping model

Return type:

Optional[QgsAggregateMappingModel]

moveSelectedFieldsDown(self) → bool

Moves down currently selected field

Return type:

bool

moveSelectedFieldsUp(self) → bool

Moves up currently selected field

Return type:

bool

registerExpressionContextGenerator(self, generator: QgsExpressionContextGenerator | None)

Register an expression context generator class that will be used to retrieve an expression context for the widget.

Parameters:

generator (Optional[QgsExpressionContextGenerator])

removeSelectedFields(self) → bool

Removes the currently selected field from the model

Return type:

bool

scrollTo(self, index: QModelIndex)

Scroll the fields view to index

Parameters:

index (QModelIndex)

selectionModel(self) → QItemSelectionModel | None

Returns the selection model

Return type:

Optional[QItemSelectionModel]

setMapping(self, mapping: Iterable[QgsAggregateMappingModel.Aggregate])

Sets the mapping to show in the model.

Parameters:

mapping (Iterable[QgsAggregateMappingModel.Aggregate])

setSourceFields(self, sourceFields: QgsFields)

Set source fields of the underlying mapping model to sourceFields

Parameters:

sourceFields (QgsFields)

setSourceLayer(self, layer: QgsVectorLayer | None)

Sets a source layer to use when generating expression previews in the widget.

Added in version 3.16.

Parameters:

layer (Optional[QgsVectorLayer])

sourceLayer(self) → QgsVectorLayer | None

Returns the source layer for use when generating expression previews.

Returned value may be None.

Added in version 3.16.

Return type:

Optional[QgsVectorLayer]