Subgroup: Layout

Class: QgsLayoutTableColumn¶

class qgis.core.QgsLayoutTableColumn¶

Bases: PyQt5.QtCore.QObject

Stores properties of a column for a QgsLayoutTable. Some properties of aQgsLayoutTableColumn are applicable only in certain contexts. For instance, the attribute and setAttribute methods only have an effect for QgsLayoutItemAttributeTables, and have no effect for QgsLayoutItemTextTables.

New in version 3.0: Methods

`attribute`	Returns the attribute name or expression used for the column’s values.
`blockSignals`
`childEvent`
`children`
`clone`	Creates a duplicate column which is a deep copy of this column.
`connectNotify`
`customEvent`
`deleteLater`
`disconnect`
`disconnectNotify`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`event`
`eventFilter`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`hAlignment`	Returns the horizontal alignment for a column, which controls the alignment used for drawing column values within cells.
`heading`	Returns the heading for a column, which is the value displayed in the column’s header cell.
`inherits`
`installEventFilter`
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`metaObject`
`moveToThread`
`objectName`
`parent`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`readXml`	Reads the column’s properties from xml.
`receivers`
`removeEventFilter`
`sender`
`senderSignalIndex`
`setAttribute`	Sets the `attribute` name or expression used for the column’s values.
`setHAlignment`	Sets the horizontal `alignment` for a column, which controls the alignment used for drawing column values within cells.
`setHeading`	Sets the `heading` for a column, which is the value displayed in the column’s header cell.
`setObjectName`
`setParent`
`setProperty`
`setSortByRank`	Sets the sort `rank` for the column.
`setSortOrder`	Sets the sort `order` for the column.
`setVAlignment`	Sets the vertical `alignment` for a column, which controls the alignment used for drawing column values within cells.
`setWidth`	Sets the width for a column in mm.
`signalsBlocked`
`sortByRank`	Returns the sort rank for the column.
`sortOrder`	Returns the sort order for the column.
`startTimer`
`thread`
`timerEvent`
`tr`
`vAlignment`	Returns the vertical alignment for a column, which controls the alignment used for drawing column values within cells.
`width`	Returns the width for the column in mm, or 0 if column width is automatically calculated.
`writeXml`	Writes the column’s properties to xml for storage.

Attributes

`destroyed`	destroyed(self, QObject = None) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`staticMetaObject`

attribute(self) → str¶: Returns the attribute name or expression used for the column’s values. This property is only used when the column is part of a QgsLayoutItemAttributeTable.

Note

only applicable when used in a QgsLayoutItemAttributeTable

See also

setAttribute()

childEvent()¶

clone(self) → QgsLayoutTableColumn¶

Creates a duplicate column which is a deep copy of this column.

Returns:	a new QgsLayoutTableColumn with same properties as this column.

connectNotify()¶

customEvent()¶

disconnectNotify()¶

hAlignment(self) → Qt.AlignmentFlag¶: Returns the horizontal alignment for a column, which controls the alignment used for drawing column values within cells.

See also

setHAlignment()

See also

vAlignment()

heading(self) → str¶: Returns the heading for a column, which is the value displayed in the column’s header cell.

See also

setHeading()

isSignalConnected()¶

readXml(self, columnElem: QDomElement) → bool¶

Reads the column’s properties from xml.

Parameters:	columnElem – a QDomElement holding the column’s desired properties.

See also

writeXml()

receivers()¶

sender()¶

senderSignalIndex()¶

setAttribute(self, attribute: str)¶: Sets the attribute name or expression used for the column’s values. This property is only used when the column is part of a QgsLayoutItemAttributeTable.

Note

only applicable when used in a QgsLayoutItemAttributeTable

See also

attribute()

setHAlignment(self, alignment: Qt.AlignmentFlag)¶: Sets the horizontal alignment for a column, which controls the alignment used for drawing column values within cells.

See also

hAlignment()

See also

setVAlignment()

setHeading(self, heading: str)¶: Sets the heading for a column, which is the value displayed in the column’s header cell.

See also

heading()

setSortByRank(self, rank: int)¶: Sets the sort rank for the column. If the sort rank is > 0 then the column will be sorted in the table. The sort rank specifies the priority given to the column when the table is sorted by multiple columns, with lower sort ranks having higher priority. This property is only used when the column is part of a QgsComposerAttributeTable. If the sort rank is <= 0 then the column is not being sorted.

Note

only applicable when used in a QgsLayoutItemAttributeTable

See also

sortByRank()

See also

setSortOrder()

setSortOrder(self, order: Qt.SortOrder)¶: Sets the sort order for the column. This property is only used when the column is part of a QgsLayoutItemAttributeTable and when sortByRank() is > 0.

Note

only applicable when used in a QgsLayoutItemAttributeTable

See also

sortOrder()

See also

setSortByRank()

setVAlignment(self, alignment: Qt.AlignmentFlag)¶: Sets the vertical alignment for a column, which controls the alignment used for drawing column values within cells.

See also

vAlignment()

See also

setHAlignment()

setWidth(self, width: float)¶: Sets the width for a column in mm. Set the width to 0 if the column width is to be automatically calculated.

See also

width()

sortByRank(self) → int¶

Returns the sort rank for the column. If the sort rank is > 0 then the column will be sorted in the table. The sort rank specifies the priority given to the column when the table is sorted by multiple columns, with lower sort ranks having higher priority. This property is only used when the column is part of a QgsLayoutItemAttributeTable.

If sort rank is <= 0 then the column is not being sorted.

Note

only applicable when used in a QgsLayoutItemAttributeTable

See also

setSortByRank()

See also

sortOrder()

sortOrder(self) → Qt.SortOrder¶: Returns the sort order for the column. This property is only used when the column is part of a QgsLayoutItemAttributeTable and when sortByRank is > 0.

Note

only applicable when used in a QgsLayoutItemAttributeTable

See also

setSortOrder()

See also

sortByRank()

timerEvent()¶

vAlignment(self) → Qt.AlignmentFlag¶: Returns the vertical alignment for a column, which controls the alignment used for drawing column values within cells.

See also

setVAlignment()

See also

hAlignment()

width(self) → float¶: Returns the width for the column in mm, or 0 if column width is automatically calculated.

See also

setWidth()

writeXml(self, columnElem: QDomElement, doc: QDomDocument) → bool¶

Writes the column’s properties to xml for storage.

Parameters:	columnElem – an existing QDomElement in which to store the column’s properties. doc – QDomDocument for the destination xml.

See also

readXml()