Class: QgsAggregateToolButton

Offers a toolbutton to choose between different aggregate functions.

Functions are filtered based on the type.

List of all members, including inherited members

Class Hierarchy

Base classes

QToolButton
QAbstractButton
QWidget
QObject
QPaintDevice

Constructor

__init__

Methods

active	When this flag is False, the aggregate will be deactivated.
aggregate	The function name of the selected aggregate or a Null String if none is chosen.
setActive	When this flag is False, the aggregate will be deactivated.
setAggregate	The function name of the selected aggregate or a Null String if none is chosen.
setType	Based on the type of underlying data, some aggregates will be available or not.
type	Based on the type of underlying data, some aggregates will be available or not.

Signals

activeChanged	A function has been selected or deselected.
aggregateChanged	The function name of the selected aggregate has changed.

class qgis.gui.QgsAggregateToolButton

Bases: QToolButton

__init__()

Constructor

active(self) → bool

When this flag is False, the aggregate will be deactivated. I.e. no aggregate is chosen.

Return type:

bool

signal activeChanged

A function has been selected or deselected.

aggregate(self) → str

The function name of the selected aggregate or a Null String if none is chosen.

Return type:

str

signal aggregateChanged

The function name of the selected aggregate has changed.

setActive(self, active: bool)

When this flag is False, the aggregate will be deactivated. I.e. no aggregate is chosen.

Parameters:

active (bool)

setAggregate(self, aggregate: str | None)

The function name of the selected aggregate or a Null String if none is chosen.

Parameters:

aggregate (Optional[str])

setType(self, type: QMetaType.Type)

Based on the type of underlying data, some aggregates will be available or not.

setType(self, type: QVariant.Type) Based on the type of underlying data, some aggregates will be available or not.

Deprecated since version 3.38: Use the method with a QMetaType.Type argument instead.

Parameters:

type (QMetaType.Type)

type(self) → QMetaType.Type

Based on the type of underlying data, some aggregates will be available or not.

Return type:

QMetaType.Type