Class: QgsLayoutItemTextTable¶
-
class
qgis.core.
QgsLayoutItemTextTable
(layout: QgsLayout)¶ Bases:
QgsLayoutTable
Constructor for
QgsLayoutItemTextTable
, for the specifiedlayout
.Ownership is transferred to the layout.
A text table item that reads text from string lists
New in version 3.0.
- Parameters
layout –
-
addRow
(self, row: Iterable[str])¶ Adds a row to the table
- Parameters
row (Iterable[str]) – list of strings to use for each cell’s value in the newly added row
Note
If row is shorter than the number of columns in the table than blank cells will be inserted at the end of the row. If row contains more strings then the number of columns in the table then these extra strings will be ignored.
Note
if adding many rows, setContents() is much faster
-
calculateMaxColumnWidths
(self) → bool¶ Calculates the maximum width of text shown in columns.
-
calculateMaxRowHeights
(self) → bool¶ Calculates the maximum height of text shown in rows.
-
childEvent
(self, QChildEvent)¶
-
connectNotify
(self, QMetaMethod)¶
-
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
-
create
(layout: QgsLayout) → QgsLayoutItemTextTable¶ Returns a new
QgsLayoutItemTextTable
for the specified parentlayout
.- Parameters
layout (QgsLayout) –
- Return type
-
customEvent
(self, QEvent)¶
-
disconnectNotify
(self, QMetaMethod)¶
-
displayName
(self) → str¶ - Return type
str
-
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()
-
getTableContents
(self, contents: object) → bool¶ - Parameters
contents (object) –
- Return type
bool
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
readObjectPropertiesFromElement
(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Sets object properties from a DOM element
- Parameters
parentElement – is the parent DOM element for the object
document – DOM document
context – read write context
- Returns
True
if read was successful
See also
-
recalculateTableSize
(self)¶ Recalculates and updates the size of the table and all table frames.
-
receivers
(self, PYQT_SIGNAL) → 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 rowincludeEmptyRows – 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 toTrue
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 toTrue
would also include a count of these extra blank rows.
- Returns
number of visible content rows (excludes header rows)
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setContents
(self, contents: Iterable[Iterable[str]])¶ Sets the contents of the text table.
- Parameters
contents (Iterable[Iterable[str]]) – list of table rows
See also
-
timerEvent
(self, QTimerEvent)¶
-
totalHeight
(self) → float¶
-
totalWidth
(self) → float¶
-
type
(self) → int¶ - Return type
int
-
writeObjectPropertiesToElement
(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool¶ Stores object properties within an XML DOM element.
- Parameters
parentElement – is the parent DOM element to store the object’s properties in
document – DOM document
context – read write context
- Returns
True
if write was successful
See also