Class: QgsLayoutTable

class qgis.core.QgsLayoutTable(layout: QgsLayout)

Bases: qgis._core.QgsLayoutMultiFrame

Constructor for QgsLayoutTable, belonging to the specified layout.

A class to display a table in the print layout, and allow the table to span over multiple frames

New in version 3.0: Enums

Methods

backgroundColor Returns the color used for the background of the table.
calculateMaxColumnWidths Calculates the maximum width of text shown in columns.
calculateMaxRowHeights Calculates the maximum height of text shown in rows.
cellMargin Returns the margin distance between cell borders and their contents in mm.
cellStyle Returns the cell style for a cell group.
childEvent
columns Returns a reference to the list of QgsLayoutTableColumns shown in the table
connectNotify
contentFont Returns the font used to draw text in table body cells.
contentFontColor Returns the color used to draw text in table body cells.
contents Returns the current contents of the table.
contentsContainsRow Checks whether a table contents contains a given row
customEvent
disconnectNotify
drawHorizontalGridLines Draws the horizontal grid lines for the table.
emptyTableBehavior Returns the behavior mode for empty tables.
emptyTableMessage Returns the message for empty tables with no content rows.
fixedFrameSize
getTableContents Fetches the contents used for the cells in the table.
gridColor Returns the color used for grid lines in the table.
gridStrokeWidth Returns the width of grid lines in the table in mm.
headerFont Returns the font used to draw header text in the table.
headerFontColor Returns the color used to draw header text in the table.
headerHAlignment Returns the horizontal alignment for table headers.
headerMode Returns the display mode for headers in the table.
horizontalGrid Returns whether the grid’s horizontal lines are drawn in the table.
isSignalConnected
minFrameSize
readObjectPropertiesFromElement
readPropertiesFromElement
recalculateFrameSizes
recalculateTableSize Recalculates and updates the size of the table and all table frames.
receivers
refresh
refreshAttributes Refreshes the contents shown in the table by querying for new data.
render
rowRange Calculates a range of rows which should be visible in a given frame.
rowsVisible Calculates how many content rows would be visible within a frame of the specified height.
sender
senderSignalIndex
setBackgroundColor Sets the color used for background of table.
setCellMargin Sets the margin distance in mm between cell borders and their contents.
setCellStyle Sets the cell style for a cell group.
setColumns Replaces the columns in the table with a specified list of QgsLayoutTableColumns.
setContentFont Sets the font used to draw text in table body cells.
setContentFontColor Sets the color used to draw text in table body cells.
setEmptyTableBehavior Sets the behavior mode for empty tables with no content rows.
setEmptyTableMessage Sets the message for empty tables with no content rows.
setGridColor Sets the color used for grid lines in the table.
setGridStrokeWidth Sets the width in mm for grid lines in the table.
setHeaderFont Sets the font used to draw header text in the table.
setHeaderFontColor Sets the color used to draw header text in the table.
setHeaderHAlignment Sets the horizontal alignment for table headers.
setHeaderMode Sets the display mode for headers in the table.
setHorizontalGrid Sets whether the grid’s horizontal lines should be drawn in the table
setShowEmptyRows Sets whether empty rows should be drawn.
setShowGrid Sets whether grid lines should be drawn in the table
setVerticalGrid Sets whether the grid’s vertical lines should be drawn in the table
setWrapBehavior Sets the wrap behavior for the table, which controls how text within cells is automatically wrapped.
showEmptyRows Returns whether empty rows are drawn in the table.
showGrid Returns whether grid lines are drawn in the table
timerEvent
totalHeight
totalSize
totalWidth
verticalGrid Returns whether the grid’s vertical lines are drawn in the table.
wrapBehavior Returns the wrap behavior for the table, which controls how text within cells is automatically wrapped.
writeObjectPropertiesToElement
writePropertiesToElement

Signals

Attributes

AllFrames
EvenColumns
EvenRows
FirstColumn
FirstFrame
FirstRow
FollowColumn
HeaderCenter
HeaderLeft
HeaderRight
HeaderRow
HeadersOnly
HideTable
LastColumn
LastRow
NoHeaders
OddColumns
OddRows
ShowMessage
TruncateText
WrapText
AllFrames = 1
class CellStyleGroup

Bases: int

class EmptyTableMode

Bases: int

EvenColumns = 1
EvenRows = 3
FirstColumn = 4
FirstFrame = 0
FirstRow = 7
FollowColumn = 0
HeaderCenter = 2
class HeaderHAlignment

Bases: int

HeaderLeft = 1
class HeaderMode

Bases: int

HeaderRight = 3
HeaderRow = 6
HeadersOnly = 0
HideTable = 1
LastColumn = 5
LastRow = 8
NoHeaders = 2
OddColumns = 0
OddRows = 2
ShowMessage = 2
TruncateText = 0
class WrapBehavior

Bases: int

WrapText = 1
backgroundColor(self) → QColor

Returns the color used for the background of the table.

See also

gridColor()

calculateMaxColumnWidths(self) → bool

Calculates the maximum width of text shown in columns.

calculateMaxRowHeights(self) → bool

Calculates the maximum height of text shown in rows.

cellMargin(self) → float

Returns the margin distance between cell borders and their contents in mm.

See also

setCellMargin()

cellStyle(self, group: QgsLayoutTable.CellStyleGroup) → QgsLayoutTableStyle

Returns the cell style for a cell group.

See also

setCellStyle()

childEvent()
columns(self) → object

Returns a reference to the list of QgsLayoutTableColumns shown in the table

See also

setColumns()

connectNotify()
contentFont(self) → QFont

Returns the font used to draw text in table body cells.

See also

setContentFont()

See also

headerFont()

contentFontColor(self) → QColor

Returns the color used to draw text in table body cells.

See also

contentFont()

contents(self) → object

Returns the current contents of the table. Excludes header cells.

contentsContainsRow(self, contents: object, row: Iterable[Any]) → bool

Checks whether a table contents contains a given row

Parameters:
  • contents – table contents to check
  • row – row to check for
Returns:

True if contents contains rows

customEvent()
disconnectNotify()
drawHorizontalGridLines(self, painter: QPainter, firstRow: int, lastRow: int, drawHeaderLines: bool)

Draws the horizontal grid lines for the table.

Parameters:
  • painter – destination painter for grid lines
  • firstRow – index corresponding to first row shown in frame
  • lastRow – index corresponding to last row shown in frame. If greater than the number of content rows in the table, then the default row height will be used for the remaining rows.
  • drawHeaderLines – set to True to include for the table header

See also

drawVerticalGridLines()

emptyTableBehavior(self) → QgsLayoutTable.EmptyTableMode

Returns the behavior mode for empty tables. This property controls how the table is drawn if it contains no content rows.

emptyTableMessage(self) → str

Returns the message for empty tables with no content rows. This message is displayed in the table body if the empty table behavior is set to ShowMessage.

fixedFrameSize(self, frameIndex: int = -1) → QSizeF
getTableContents(self, contents: object) → bool

Fetches the contents used for the cells in the table.

Returns:True if table contents were successfully retrieved.
Parameters:contents – QgsLayoutTableContents to store retrieved row data in
gridColor(self) → QColor

Returns the color used for grid lines in the table.

See also

setGridColor()

See also

showGrid()

gridStrokeWidth(self) → float

Returns the width of grid lines in the table in mm.

See also

showGrid()

See also

gridColor()

headerFont(self) → QFont

Returns the font used to draw header text in the table.

See also

setHeaderFont()

See also

contentFont()

headerFontColor(self) → QColor

Returns the color used to draw header text in the table.

See also

headerFont()

headerHAlignment(self) → QgsLayoutTable.HeaderHAlignment

Returns the horizontal alignment for table headers.

headerMode(self) → QgsLayoutTable.HeaderMode

Returns the display mode for headers in the table. This property controls if and where headers are shown in the table.

See also

setHeaderMode()

horizontalGrid(self) → bool

Returns whether the grid’s horizontal lines are drawn in the table.

See also

setShowGrid()

See also

setGridColor()

isSignalConnected()
minFrameSize(self, frameIndex: int = -1) → QSizeF
readObjectPropertiesFromElement()
readPropertiesFromElement(self, itemElem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool
recalculateFrameSizes(self)
recalculateTableSize(self)

Recalculates and updates the size of the table and all table frames.

receivers()
refresh(self)
refreshAttributes(self)

Refreshes the contents shown in the table by querying for new data. This also causes the column widths and size of the table to change to accommodate the new data.

render(self, context: QgsLayoutItemRenderContext, renderExtent: QRectF, frameIndex: int)
rowRange(self, frameIndex: int) → Tuple[int, int]

Calculates a range of rows which should be visible in a given frame.

Parameters:frameIndex – index number for frame
Returns:row range
rowsVisible(self, frameHeight: float, firstRow: int, includeHeader: bool, includeEmptyRows: bool) → int

Calculates how many content rows would be visible within a frame of the specified height.

Parameters:
  • frameHeight – height of frame
  • firstRow – index of first row visible in frame (where 0 = first row in table)
  • includeHeader – set to True if frame would include a header row
  • includeEmptyRows – set to True to also include rows which would be empty in the returned count. For instance, if the frame would include all table content rows and have space left for extra rows then setting this parameter to True would also include a count of these extra blank rows.
Returns:

number of visible content rows (excluding header row)

rowsVisible(self, frameIndex: int, firstRow: int, includeEmptyRows: bool) -> int Calculates how many content rows are visible within a given frame.

Parameters:
  • frameIndex – index number for frame
  • firstRow – index of first row visible in frame (where 0 = first row in table)
  • includeEmptyRows – set to True to also include rows which would be empty in the returned count. For instance, if the frame would include all table content rows and have space left for extra rows then setting this parameter to True would also include a count of these extra blank rows.
Returns:

number of visible content rows (excludes header rows)

sender()
senderSignalIndex()
setBackgroundColor(self, color: Union[QColor, Qt.GlobalColor])

Sets the color used for background of table.

See also

setGridColor()

setCellMargin(self, margin: float)

Sets the margin distance in mm between cell borders and their contents.

See also

cellMargin()

setCellStyle(self, group: QgsLayoutTable.CellStyleGroup, style: QgsLayoutTableStyle)

Sets the cell style for a cell group.

See also

cellStyle()

setColumns(self, columns: object)

Replaces the columns in the table with a specified list of QgsLayoutTableColumns.

Parameters:columns – list of QgsLayoutTableColumns to show in table.

See also

columns()

setContentFont(self, font: QFont)

Sets the font used to draw text in table body cells.

See also

contentFont()

See also

setHeaderFont()

setContentFontColor(self, color: Union[QColor, Qt.GlobalColor])

Sets the color used to draw text in table body cells.

See also

setContentFont()

setEmptyTableBehavior(self, mode: QgsLayoutTable.EmptyTableMode)

Sets the behavior mode for empty tables with no content rows.

setEmptyTableMessage(self, message: str)

Sets the message for empty tables with no content rows. This message is displayed in the table body if the empty table behavior is set to ShowMessage.

setGridColor(self, color: Union[QColor, Qt.GlobalColor])

Sets the color used for grid lines in the table.

See also

gridColor()

See also

setShowGrid()

setGridStrokeWidth(self, width: float)

Sets the width in mm for grid lines in the table.

See also

setShowGrid()

See also

setGridColor()

setHeaderFont(self, font: QFont)

Sets the font used to draw header text in the table.

See also

headerFont()

See also

setContentFont()

setHeaderFontColor(self, color: Union[QColor, Qt.GlobalColor])

Sets the color used to draw header text in the table.

See also

setHeaderFont()

setHeaderHAlignment(self, alignment: QgsLayoutTable.HeaderHAlignment)

Sets the horizontal alignment for table headers.

setHeaderMode(self, mode: QgsLayoutTable.HeaderMode)

Sets the display mode for headers in the table. This property controls if and where headers are shown in the table.

See also

headerMode()

setHorizontalGrid(self, horizontalGrid: bool)

Sets whether the grid’s horizontal lines should be drawn in the table

Parameters:horizontalGrid – set to True to draw grid’s horizontal lines

See also

setShowGrid()

See also

setGridColor()

setShowEmptyRows(self, showEmpty: bool)

Sets whether empty rows should be drawn. Tables default to hiding empty rows.

Parameters:showEmpty – set to True to show empty rows in the table

See also

showEmptyRows()

setShowGrid(self, showGrid: bool)

Sets whether grid lines should be drawn in the table

Parameters:showGrid – set to True to show grid lines

See also

showGrid()

See also

setGridColor()

setVerticalGrid(self, verticalGrid: bool)

Sets whether the grid’s vertical lines should be drawn in the table

Parameters:verticalGrid – set to True to draw grid’s vertical lines

See also

setShowGrid()

See also

setGridColor()

setWrapBehavior(self, behavior: QgsLayoutTable.WrapBehavior)

Sets the wrap behavior for the table, which controls how text within cells is automatically wrapped.

See also

wrapBehavior()

showEmptyRows(self) → bool

Returns whether empty rows are drawn in the table.

showGrid(self) → bool

Returns whether grid lines are drawn in the table

See also

setShowGrid()

See also

gridColor()

timerEvent()
totalHeight(self) → float
totalSize(self) → QSizeF
totalWidth(self) → float
verticalGrid(self) → bool

Returns whether the grid’s vertical lines are drawn in the table.

See also

setShowGrid()

See also

setGridColor()

wrapBehavior(self) → QgsLayoutTable.WrapBehavior

Returns the wrap behavior for the table, which controls how text within cells is automatically wrapped.

writeObjectPropertiesToElement()
writePropertiesToElement(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool