Class: QgsTableCell

Encapsulates the contents and formatting of a single table cell.

Added in version 3.12.

Methods

backgroundColor	Returns the cell's background color, or an invalid color if a default color should be used for the background.
columnSpan	Returns the column span for the cell.
content	Returns the cell's content.
foregroundColor	Returns the cell's foreground color, or an invalid color if a default color should be used for the foreground.
horizontalAlignment	Returns the horizontal alignment for text in the cell.
numericFormat	Returns the numeric format used for numbers in the cell, or None if no format is set.
properties	Returns the properties of the cell.
rowSpan	Returns the row span for the cell.
setBackgroundColor	Sets the cell's background color.
setContent	Sets the cell's content.
setForegroundColor	Sets the cell's foreground color.
setHorizontalAlignment	Sets the horizontal alignment for text in the cell.
setNumericFormat	Sets the numeric format used for numbers in the cell, or None if no specific format is set.
setProperties	Sets the properties for the cell.
setSpan	Sets the row and column span for the cell.
setTextFormat	Sets the cell's text format.
setVerticalAlignment	Sets the vertical alignment for text in the cell.
textFormat	Returns the cell's text format.
verticalAlignment	Returns the vertical alignment for text in the cell.

class qgis.core.QgsTableCell

Bases: object

__init__(content: Any = None)

Constructor for QgsTableCell, with the specified content.

Parameters:

content (Any = None)

__init__(other: QgsTableCell)

Parameters:

other (QgsTableCell)

backgroundColor(self) → QColor

Returns the cell’s background color, or an invalid color if a default color should be used for the background.

See also

setBackgroundColor()

Return type:

QColor

columnSpan(self) → int

Returns the column span for the cell.

See also

rowSpan()

See also

setSpan()

Added in version 3.40.

Return type:

int

content(self) → Any

Returns the cell’s content.

See also

setContent()

Return type:

Any

foregroundColor(self) → QColor

Returns the cell’s foreground color, or an invalid color if a default color should be used for the foreground.

See also

setForegroundColor()

Return type:

QColor

horizontalAlignment(self) → Qt.Alignment

Returns the horizontal alignment for text in the cell.

See also

setHorizontalAlignment()

See also

verticalAlignment()

Added in version 3.16.

Return type:

Qt.Alignment

numericFormat(self) → QgsNumericFormat | None

Returns the numeric format used for numbers in the cell, or None if no format is set.

See also

setNumericFormat()

Return type:

Optional[QgsNumericFormat]

properties(self, context: QgsReadWriteContext) → Dict[str, Any]

Returns the properties of the cell.

See also

setProperties()

Parameters:

context (QgsReadWriteContext)

Return type:

Dict[str, Any]

rowSpan(self) → int

Returns the row span for the cell.

See also

columnSpan()

See also

setSpan()

Added in version 3.40.

Return type:

int

setBackgroundColor(self, color: QColor | Qt.GlobalColor)

Sets the cell’s background color.

Set an invalid color if a default color should be used for the background.

See also

backgroundColor()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setContent(self, content: Any)

Sets the cell’s content.

See also

content()

Parameters:

content (Any)

setForegroundColor(self, color: QColor | Qt.GlobalColor)

Sets the cell’s foreground color.

Set an invalid color if a default color should be used for the foreground.

See also

foregroundColor()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setHorizontalAlignment(self, alignment: Qt.Alignment | Qt.AlignmentFlag)

Sets the horizontal alignment for text in the cell.

See also

horizontalAlignment()

See also

setVerticalAlignment()

Added in version 3.16.

Parameters:

alignment (Union[Qt.Alignment, Qt.AlignmentFlag])

setNumericFormat(self, format: QgsNumericFormat | None)

Sets the numeric format used for numbers in the cell, or None if no specific format is set.

Ownership of format is transferred to the cell.

See also

numericFormat()

Parameters:

format (Optional[QgsNumericFormat])

setProperties(self, properties: Dict[str, Any], context: QgsReadWriteContext)

Sets the properties for the cell.

See also

properties()

Parameters:

• properties (Dict[str, Any])

• context (QgsReadWriteContext)

setSpan(self, rowSpan: int, columnSpan: int)

Sets the row and column span for the cell.

See also

rowSpan()

See also

columnSpan()

Added in version 3.40.

Parameters:

• rowSpan (int)

• columnSpan (int)

setTextFormat(self, format: QgsTextFormat)

Sets the cell’s text format.

Note

The text format will only be used if hasTextFormat() returns True.

See also

textFormat()

Added in version 3.16.

Parameters:

format (QgsTextFormat)

setVerticalAlignment(self, alignment: Qt.Alignment | Qt.AlignmentFlag)

Sets the vertical alignment for text in the cell.

See also

verticalAlignment()

See also

setHorizontalAlignment()

Added in version 3.16.

Parameters:

alignment (Union[Qt.Alignment, Qt.AlignmentFlag])

textFormat(self) → QgsTextFormat

Returns the cell’s text format.

Note

The text format will only be used if hasTextFormat() returns True.

See also

setTextFormat()

Added in version 3.16.

Return type:

QgsTextFormat

verticalAlignment(self) → Qt.Alignment

Returns the vertical alignment for text in the cell.

See also

setVerticalAlignment()

See also

horizontalAlignment()

Added in version 3.16.

Return type:

Qt.Alignment