Class: QgsLayoutTableColumn¶
- class qgis.core.QgsLayoutTableColumn¶
Bases:
sip.wrapper
Stores properties of a column for a
QgsLayoutTable
.Some properties of a
QgsLayoutTableColumn
are applicable only in certain contexts. For instance, the attribute and setAttribute methods only have an effect forQgsLayoutItemAttributeTables
, and have no effect forQgsLayoutItemTextTables
.New in version 3.0.
QgsLayoutTableColumn(heading: str = ‘’) Constructor for QgsLayoutTableColumn.
- Parameters
heading – column heading
QgsLayoutTableColumn(
QgsLayoutTableColumn
)Methods
Returns the attribute name or expression used for the column's values.
Creates a duplicate column which is a deep copy of this column.
Returns the horizontal alignment for a column, which controls the alignment used for drawing column values within cells.
Returns the heading for a column, which is the value displayed in the column's header cell.
Reads the column's properties from xml.
Sets the
attribute
name or expression used for the column's values.Sets the horizontal
alignment
for a column, which controls the alignment used for drawing column values within cells.Sets the
heading
for a column, which is the value displayed in the column's header cell.Sets the sort
rank
for the column.Sets the sort
order
for the column.Sets the vertical
alignment
for a column, which controls the alignment used for drawing column values within cells.Sets the width for a column in mm.
Returns the sort rank for the column.
Returns the sort order for the column.
Returns the vertical alignment for a column, which controls the alignment used for drawing column values within cells.
Returns the width for the column in mm, or 0 if column width is automatically calculated.
Writes the column's properties to xml for storage.
- 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
- Return type
str
- clone(self) QgsLayoutTableColumn ¶
Creates a duplicate column which is a deep copy of this column.
- Return type
- Returns
a new
QgsLayoutTableColumn
with same properties as this column.
Deprecated since version QGIS: 3.14 use a copy instead
- hAlignment(self) Qt.AlignmentFlag ¶
Returns the horizontal alignment for a column, which controls the alignment used for drawing column values within cells.
See also
See also
- Return type
Qt.AlignmentFlag
- heading(self) str ¶
Returns the heading for a column, which is the value displayed in the column’s header cell.
See also
- Return type
str
- readXml(self, columnElem: QDomElement) bool ¶
Reads the column’s properties from xml.
- Parameters
columnElem (QDomElement) – a QDomElement holding the column’s desired properties.
See also
- Return type
bool
- 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 aQgsLayoutItemAttributeTable
.Note
only applicable when used in a
QgsLayoutItemAttributeTable
See also
- Parameters
attribute (str) –
- 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
See also
- Parameters
alignment (Qt.AlignmentFlag) –
- setHeading(self, heading: str)¶
Sets the
heading
for a column, which is the value displayed in the column’s header cell.See also
- Parameters
heading (str) –
- 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 aQgsLayoutItemAttributeTable
. If the sortrank
is <= 0 then the column is not being sorted.Note
only applicable when used in a
QgsLayoutItemAttributeTable
See also
See also
Deprecated since version QGIS: 3.14 the order is now hold in a dedicated model
- Parameters
rank (int) –
- setSortOrder(self, order: Qt.SortOrder)¶
Sets the sort
order
for the column. This property is only used when the column is part of aQgsLayoutItemAttributeTable
and whensortByRank()
is > 0.Note
only applicable when used in a
QgsLayoutItemAttributeTable
See also
See also
- Parameters
order (Qt.SortOrder) –
- 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
See also
- Parameters
alignment (Qt.AlignmentFlag) –
- 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
- Parameters
width (float) –
- 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
See also
Deprecated since version QGIS: 3.14 the order is now hold in a dedicated model
- Return type
int
- 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
See also
- Return type
Qt.SortOrder
- vAlignment(self) Qt.AlignmentFlag ¶
Returns the vertical alignment for a column, which controls the alignment used for drawing column values within cells.
See also
See also
- Return type
Qt.AlignmentFlag
- width(self) float ¶
Returns the width for the column in mm, or 0 if column width is automatically calculated.
See also
- Return type
float
- writeXml(self, columnElem: QDomElement, doc: QDomDocument) bool ¶
Writes the column’s properties to xml for storage.
- Parameters
columnElem (QDomElement) – an existing QDomElement in which to store the column’s properties.
doc (QDomDocument) – QDomDocument for the destination xml.
See also
- Return type
bool