Class: QgsLayoutItemAttributeTable¶

A layout table subclass that displays attributes from a vector layer.

Class Hierarchy¶

Base classes¶

`QgsLayoutTable`	Displays a table in the print layout, and allows the table to span over multiple frames.
`QgsLayoutMultiFrame`	Abstract base class for layout items with the ability to distribute the content to several frames (`QgsLayoutFrame` items).
`QgsLayoutObject`	A base class for objects which belong to a layout.
QObject
`QgsExpressionContextGenerator`	Abstract interface for generating an expression context.
`QgsLayoutUndoObjectInterface`	Interface for layout objects which support undo/redo commands.

Abstract Methods

getTableContents

Queries the attribute table's vector layer for attributes to show in the table.

Methods

`displayOnlyVisibleFeatures`	Returns `True` if the table is set to show only features visible on a corresponding map item.
`featureFilter`	Returns the current expression used to filter features for the table.
`filterFeatures`	Returns `True` if a feature filter is active on the attribute table.
`filterToAtlasFeature`	Returns `True` if the table is set to only show features which intersect the current atlas feature.
`map`	Returns the layout map whose extents are controlling the features shown in the table.
`maximumNumberOfFeatures`	Returns the maximum number of features to be shown by the table.
`relationId`	Returns the relation id which the table displays child features from.
`resetColumns`	Resets the attribute table's columns to match the vector layer's fields.
`setDisplayOnlyVisibleFeatures`	Sets the attribute table to only show features which are visible in a map item.
`setDisplayedFields`	Sets the attributes to display in the table.
`setFeatureFilter`	Sets the expression used for filtering features in the table.
`setFilterFeatures`	Sets whether the feature filter is active for the attribute table.
`setFilterToAtlasFeature`	Sets attribute table to only show features which intersect the current atlas feature.
`setMap`	Sets a layout map to use to limit the extent of features shown in the attribute table.
`setMaximumNumberOfFeatures`	Sets the maximum number of features shown by the table.
`setRelationId`	Sets the relation id from which to display child features
`setSource`	Sets the source for attributes to show in table body.
`setUniqueRowsOnly`	Sets attribute table to only show unique rows.
`setUseConditionalStyling`	Sets whether the attribute table will be rendered using the conditional styling properties of the linked vector layer.
`setVectorLayer`	Sets the vector layer from which to display feature attributes.
`setWrapString`	Sets a string to wrap the contents of the table cells by.
`source`	Returns the source for attributes shown in the table body.
`sourceLayer`	Returns the source layer for the table, considering the table source mode.
`uniqueRowsOnly`	Returns `True` if the table is set to show only unique rows.
`useConditionalStyling`	Returns `True` if the attribute table will be rendered using the conditional styling properties of the linked vector layer.
`vectorLayer`	Returns the vector layer the attribute table is currently using.
`wrapString`	Returns the string used to wrap the contents of the table cells by.

Static Methods

create

Returns a new QgsLayoutItemAttributeTable for the specified parent layout.

Attributes

`AtlasFeature`
`LayerAttributes`
`RelationChildren`

class qgis.core.QgsLayoutItemAttributeTable[source]¶

Bases: QgsLayoutTable

__init__(layout: QgsLayout | None)

Constructor for QgsLayoutItemAttributeTable, attached to the specified layout.

Ownership is transferred to the layout.

Parameters:: layout (Optional[QgsLayout])

AtlasFeature = 1¶

class ContentSource¶: Bases: int

LayerAttributes = 0¶

RelationChildren = 2¶

static create(layout: QgsLayout | None) → QgsLayoutItemAttributeTable | None[source]¶

Returns a new QgsLayoutItemAttributeTable for the specified parent layout.

Parameters:: layout (Optional[QgsLayout])
Return type:: Optional[QgsLayoutItemAttributeTable]

displayOnlyVisibleFeatures(self) → bool[source]¶

Returns True if the table is set to show only features visible on a corresponding map item.

See also

map()

See also

setDisplayOnlyVisibleFeatures()

Return type:: bool

featureFilter(self) → str[source]¶

Returns the current expression used to filter features for the table. The filter is only active if filterFeatures() is True.

See also

setFeatureFilter()

See also

filterFeatures()

Return type:: str

filterFeatures(self) → bool[source]¶

Returns True if a feature filter is active on the attribute table.

See also

setFilterFeatures()

See also

featureFilter()

Return type:: bool

filterToAtlasFeature(self) → bool[source]¶

Returns True if the table is set to only show features which intersect the current atlas feature.

See also

setFilterToAtlasFeature()

Return type:: bool

abstract getTableContents(self, contents: Any) → bool[source]¶

Queries the attribute table’s vector layer for attributes to show in the table.

Parameters:: contents (Any) – table content
Return type:: bool
Returns:: True if attributes were successfully fetched

map(self) → QgsLayoutItemMap | None[source]¶

Returns the layout map whose extents are controlling the features shown in the table. The extents of the map are only used if displayOnlyVisibleFeatures() is True.

See also

setMap()

See also

displayOnlyVisibleFeatures()

Return type:: Optional[QgsLayoutItemMap]

maximumNumberOfFeatures(self) → int[source]¶

Returns the maximum number of features to be shown by the table.

See also

setMaximumNumberOfFeatures()

Return type:: int

relationId(self) → str[source]¶

Returns the relation id which the table displays child features from.

See also

setRelationId()

See also

source()

Note

Only used if table source() is set to RelationChildren.

Return type:: str

resetColumns(self)[source]¶: Resets the attribute table’s columns to match the vector layer’s fields.

See also

setVectorLayer()

setDisplayOnlyVisibleFeatures(self, visibleOnly: bool)[source]¶

Sets the attribute table to only show features which are visible in a map item. Changing this setting forces the table to refetch features from its vector layer, and may result in the table changing size to accommodate the new displayed feature attributes.

See also

displayOnlyVisibleFeatures()

See also

setMap()

Parameters:: visibleOnly (bool)

setDisplayedFields(self, fields: Iterable[str | None], refresh: bool = True)[source]¶

Sets the attributes to display in the table.

Parameters:

fields (Iterable[Optional[str]]) – list of fields names from the vector layer to show. Set to an empty list to show all feature attributes.
refresh (bool = True) – set to True to force the table to refetch features from its vector layer and immediately update the display of the table. This may result in the table changing size to accommodate the new displayed feature attributes.

setFeatureFilter(self, expression: str | None)[source]¶

Sets the expression used for filtering features in the table. The filter is only active if filterFeatures() is set to True. Changing this setting forces the table to refetch features from its vector layer, and may result in the table changing size to accommodate the new displayed feature attributes.

See also

featureFilter()

See also

setFilterFeatures()

Parameters:: expression (Optional[str])

setFilterFeatures(self, filter: bool)[source]¶

Sets whether the feature filter is active for the attribute table. Changing this setting forces the table to refetch features from its vector layer, and may result in the table changing size to accommodate the new displayed feature attributes.

See also

filterFeatures()

See also

setFeatureFilter()

Parameters:: filter (bool)

setFilterToAtlasFeature(self, filterToAtlas: bool)[source]¶

Sets attribute table to only show features which intersect the current atlas feature.

See also

filterToAtlasFeature()

Parameters:: filterToAtlas (bool)

setMap(self, map: QgsLayoutItemMap | None)[source]¶

Sets a layout map to use to limit the extent of features shown in the attribute table. This setting only has an effect if setDisplayOnlyVisibleFeatures is set to True. Changing the map forces the table to refetch features from its vector layer, and may result in the table changing size to accommodate the new displayed feature attributes.

See also

map()

See also

setDisplayOnlyVisibleFeatures()

Parameters:: map (Optional[QgsLayoutItemMap])

setMaximumNumberOfFeatures(self, features: int)[source]¶

Sets the maximum number of features shown by the table. Changing this setting may result in the attribute table changing its size to accommodate the new number of rows, and requires the table to refetch features from its vector layer.

See also

maximumNumberOfFeatures()

Parameters:: features (int)

setRelationId(self, id: str | None)[source]¶

Sets the relation id from which to display child features

See also

relationId()

See also

setSource()

Note

Only used if table source() is set to RelationChildren.

Parameters:: id (Optional[str])

setSource(self, source: QgsLayoutItemAttributeTable.ContentSource)[source]¶

Sets the source for attributes to show in table body.

See also

source()

Parameters:: source (QgsLayoutItemAttributeTable.ContentSource)

setUniqueRowsOnly(self, uniqueOnly: bool)[source]¶

Sets attribute table to only show unique rows.

Set uniqueOnly to True to show only unique rows. Duplicate rows will be stripped from the table.

See also

uniqueRowsOnly()

Parameters:: uniqueOnly (bool)

setUseConditionalStyling(self, enabled: bool)[source]¶

Sets whether the attribute table will be rendered using the conditional styling properties of the linked vector layer.

See also

useConditionalStyling()

Added in version 3.12.

Parameters:: enabled (bool)

setVectorLayer(self, layer: QgsVectorLayer | None)[source]¶

Sets the vector layer from which to display feature attributes.

This is only considered if the table source() is LayerAttributes.

See also

vectorLayer()

Parameters:: layer (Optional[QgsVectorLayer])

setWrapString(self, wrapString: str | None)[source]¶

Sets a string to wrap the contents of the table cells by. Occurrences of this string will be replaced by a line break.

Parameters:: wrapString (Optional[str]) – string to replace with line break

See also

wrapString()

source(self) → QgsLayoutItemAttributeTable.ContentSource[source]¶

Returns the source for attributes shown in the table body.

See also

setSource()

Return type:: QgsLayoutItemAttributeTable.ContentSource

sourceLayer(self) → QgsVectorLayer | None[source]¶

Returns the source layer for the table, considering the table source mode. For example, if the table is set to atlas feature mode, then the source layer will be the atlas coverage layer. If the table is set to layer attributes mode, then the source layer will be the user specified vector layer.