Class: QgsAttributeTableConfig

class qgis.core.QgsAttributeTableConfig

Bases: sip.wrapper

This is a container for configuration of the attribute table. The configuration is specific for one vector layer.

QgsAttributeTableConfig() Constructor for QgsAttributeTableConfig.

QgsAttributeTableConfig(a0: QgsAttributeTableConfig)

Methods

actionWidgetStyle

Gets the style of the action widget

actionWidgetVisible

Returns True if the action widget is visible

columnHidden

Returns True if the specified column is hidden.

columnWidth

Returns the width of a column, or -1 if column should use default width.

columns

Gets the list with all columns and their configuration.

hasSameColumns

Compare this configuration's columns name, type, and order to other.

isEmpty

Returns True if the configuration is empty, ie it contains no columns.

mapVisibleColumnToIndex

Maps a visible column index to its original column index.

readXml

Deserialize to XML on layer load

setActionWidgetStyle

Set the style of the action widget

setActionWidgetVisible

Set if the action widget is visible

setColumnHidden

Sets whether the specified column should be hidden.

setColumnWidth

Sets the width of a column.

setColumns

Set the list of columns visible in the attribute table.

setSortExpression

Set the sort expression used for sorting.

setSortOrder

Set the sort order

size

Returns the number of columns in the configuration.

sortExpression

Gets the expression used for sorting.

sortOrder

Gets the sort order

update

Update the configuration with the given fields.

writeXml

Serialize to XML on layer save

Attributes

Action

ButtonList

DropDown

Field

Action = 1
class ActionWidgetStyle

Bases: int

ButtonList = 0
class ColumnConfig

Bases: sip.wrapper

Constructor for ColumnConfig

QgsAttributeTableConfig.ColumnConfig(a0: QgsAttributeTableConfig.ColumnConfig)

hidden
name
type
width
DropDown = 1
Field = 0
class Type

Bases: int

actionWidgetStyle(self) QgsAttributeTableConfig.ActionWidgetStyle

Gets the style of the action widget

Return type:

QgsAttributeTableConfig.ActionWidgetStyle

actionWidgetVisible(self) bool

Returns True if the action widget is visible

Return type:

bool

columnHidden(self, column: int) bool

Returns True if the specified column is hidden.

Parameters:

column (int) – column index

Raises:

IndexError – if the column is not found

Return type:

bool

columnWidth(self, column: int) int

Returns the width of a column, or -1 if column should use default width.

Parameters:

column (int) – column index

Raises:

IndexError – if the column is not found

See also

setColumnWidth()

Return type:

int

columns(self) List[QgsAttributeTableConfig.ColumnConfig]

Gets the list with all columns and their configuration. The list order defines the order of appearance.

Return type:

List[QgsAttributeTableConfig.ColumnConfig]

hasSameColumns(self, other: QgsAttributeTableConfig) bool

Compare this configuration’s columns name, type, and order to other. The column’s width is not considered.

Parameters:

other (QgsAttributeTableConfig)

Return type:

bool

isEmpty(self) bool

Returns True if the configuration is empty, ie it contains no columns.

See also

size()

Return type:

bool

mapVisibleColumnToIndex(self, visibleColumn: int) int

Maps a visible column index to its original column index.

Parameters:

visibleColumn (int) – index of visible column

Return type:

int

Returns:

corresponding index when hidden columns are considered

readXml(self, node: QDomNode)

Deserialize to XML on layer load

Parameters:

node (QDomNode)

setActionWidgetStyle(self, actionWidgetStyle: QgsAttributeTableConfig.ActionWidgetStyle)

Set the style of the action widget

Parameters:

actionWidgetStyle (QgsAttributeTableConfig.ActionWidgetStyle)

setActionWidgetVisible(self, visible: bool)

Set if the action widget is visible

Parameters:

visible (bool)

setColumnHidden(self, column: int, hidden: bool)

Sets whether the specified column should be hidden.

Parameters:
  • column (int) – column index

  • hidden (bool) – set to True to hide column

Raises:

IndexError – if the column is not found

See also

columnHidden()

setColumnWidth(self, column: int, width: int)

Sets the width of a column.

Parameters:
  • column (int) – column index

  • width (int) – column width in pixels, or -1 if column should use default width

Raises:

IndexError – if the column is not found

See also

columnWidth()

setColumns(self, columns: Iterable[QgsAttributeTableConfig.ColumnConfig])

Set the list of columns visible in the attribute table. The list order defines the order of appearance.

Parameters:

columns (Iterable[QgsAttributeTableConfig.ColumnConfig])

setSortExpression(self, sortExpression: str | None)

Set the sort expression used for sorting.

Parameters:

sortExpression (Optional[str])

setSortOrder(self, sortOrder: Qt.SortOrder)

Set the sort order

Parameters:

sortOrder (Qt.SortOrder)

size(self) int

Returns the number of columns in the configuration.

Added in version 3.22.

Return type:

int

sortExpression(self) str

Gets the expression used for sorting.

Return type:

str

sortOrder(self) Qt.SortOrder

Gets the sort order

Return type:

Qt.SortOrder

update(self, fields: QgsFields)

Update the configuration with the given fields. Any field which is present in the configuration but not present in the parameter fields will be removed. Any field which is in the parameter fields but not in the configuration will be appended.

Parameters:

fields (QgsFields)

writeXml(self, node: QDomNode)

Serialize to XML on layer save

Parameters:

node (QDomNode)