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
Returns the color used for the background of the table.
Calculates the maximum width of text shown in columns.
Calculates the maximum height of text shown in rows.
Returns the margin distance between cell borders and their contents in mm.
Returns the cell style for a cell
group
.Returns a reference to the list of QgsLayoutTableColumns shown in the table
Returns the font used to draw text in table body cells.
Returns the color used to draw text in table body cells.
Returns the current contents of the table.
Checks whether a table contents contains a given row
Draws the horizontal grid lines for the table.
Returns the behavior mode for empty tables.
Returns the message for empty tables with no content rows.
Fetches the contents used for the cells in the table.
Returns the color used for grid lines in the table.
Returns the width of grid lines in the table in mm.
Returns the font used to draw header text in the table.
Returns the color used to draw header text in the table.
Returns the horizontal alignment for table headers.
Returns the display mode for headers in the table.
Returns whether the grid’s horizontal lines are drawn in the table.
Recalculates and updates the size of the table and all table frames.
Refreshes the contents shown in the table by querying for new data.
Calculates a range of rows which should be visible in a given frame.
Calculates how many content rows would be visible within a frame of the specified height.
Sets the
color
used for background of table.Sets the
margin
distance in mm between cell borders and their contents.Sets the cell
style
for a cellgroup
.Replaces the columns in the table with a specified list of QgsLayoutTableColumns.
Sets the
font
used to draw text in table body cells.Sets the
color
used to draw text in table body cells.Sets the behavior
mode
for empty tables with no content rows.Sets the
message
for empty tables with no content rows.Sets the
color
used for grid lines in the table.Sets the
width
in mm for grid lines in the table.Sets the
font
used to draw header text in the table.Sets the
color
used to draw header text in the table.Sets the horizontal
alignment
for table headers.Sets the display
mode
for headers in the table.Sets whether the grid’s horizontal lines should be drawn in the table
Sets whether empty rows should be drawn.
Sets whether grid lines should be drawn in the table
Sets whether the grid’s vertical lines should be drawn in the table
Sets the wrap
behavior
for the table, which controls how text within cells is automatically wrapped.Returns whether empty rows are drawn in the table.
Returns whether grid lines are drawn in the table
Returns whether the grid’s vertical lines are drawn in the table.
Returns the wrap behavior for the table, which controls how text within cells is automatically wrapped.
Signals
Attributes
-
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
See also
-
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
-
cellStyle
(self, group: QgsLayoutTable.CellStyleGroup) → QgsLayoutTableStyle¶ Returns the cell style for a cell
group
.See also
-
childEvent
()¶
-
columns
(self) → object¶ Returns a reference to the list of QgsLayoutTableColumns shown in the table
See also
-
connectNotify
()¶
-
contentFont
(self) → QFont¶ Returns the font used to draw text in table body cells.
See also
See also
-
contentFontColor
(self) → QColor¶ Returns the color used to draw text in table body cells.
See also
See also
See also
-
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.
See also
-
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.
See also
See also
-
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
See also
See also
-
gridStrokeWidth
(self) → float¶ Returns the width of grid lines in the table in mm.
See also
See also
See also
-
headerFont
(self) → QFont¶ Returns the font used to draw header text in the table.
See also
See also
-
headerFontColor
(self) → QColor¶ Returns the color used to draw header text in the table.
See also
See also
See also
-
headerHAlignment
(self) → QgsLayoutTable.HeaderHAlignment¶ Returns the horizontal alignment for table headers.
See also
-
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
-
horizontalGrid
(self) → bool¶ Returns whether the grid’s horizontal lines are drawn in the table.
See also
See also
See also
See also
-
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
See also
-
setCellMargin
(self, margin: float)¶ Sets the
margin
distance in mm between cell borders and their contents.See also
-
setCellStyle
(self, group: QgsLayoutTable.CellStyleGroup, style: QgsLayoutTableStyle)¶ Sets the cell
style
for a cellgroup
.See also
-
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
-
setContentFont
(self, font: QFont)¶ Sets the
font
used to draw text in table body cells.See also
See also
-
setContentFontColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the
color
used to draw text in table body cells.See also
See also
See also
-
setEmptyTableBehavior
(self, mode: QgsLayoutTable.EmptyTableMode)¶ Sets the behavior
mode
for empty tables with no content rows.See also
-
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.See also
See also
-
setGridColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the
color
used for grid lines in the table.See also
See also
See also
-
setGridStrokeWidth
(self, width: float)¶ Sets the
width
in mm for grid lines in the table.See also
See also
See also
-
setHeaderFont
(self, font: QFont)¶ Sets the
font
used to draw header text in the table.See also
See also
-
setHeaderFontColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the
color
used to draw header text in the table.See also
See also
See also
-
setHeaderHAlignment
(self, alignment: QgsLayoutTable.HeaderHAlignment)¶ Sets the horizontal
alignment
for table headers.See also
-
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
-
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
See also
See also
See also
-
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
-
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
See also
See also
-
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
See also
See also
See also
-
setWrapBehavior
(self, behavior: QgsLayoutTable.WrapBehavior)¶ Sets the wrap
behavior
for the table, which controls how text within cells is automatically wrapped.See also
-
showEmptyRows
(self) → bool¶ Returns whether empty rows are drawn in the table.
See also
-
showGrid
(self) → bool¶ Returns whether grid lines are drawn in the table
See also
See also
See also
-
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
See also
See also
See also
-
wrapBehavior
(self) → QgsLayoutTable.WrapBehavior¶ Returns the wrap behavior for the table, which controls how text within cells is automatically wrapped.
See also
-
writeObjectPropertiesToElement
()¶
-
writePropertiesToElement
(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool¶
-