Class: QgsLayoutProxyModel¶
-
class
qgis.core.
QgsLayoutProxyModel
(layout: QgsLayout, parent: QObject = None)¶ Bases:
PyQt5.QtCore.QSortFilterProxyModel
Constructor for
QgsLayoutProxyModelm
, attached to the specifiedlayout
.Allows for filtering a
QgsLayoutModel
by item type.New in version 3.0.
- Parameters
layout (QgsLayout) –
parent –
-
beginInsertColumns
()¶
-
beginInsertRows
()¶
-
beginMoveColumns
()¶
-
beginMoveRows
()¶
-
beginRemoveColumns
()¶
-
beginRemoveRows
()¶
-
beginResetModel
()¶
-
changePersistentIndex
()¶
-
changePersistentIndexList
()¶
-
childEvent
()¶
-
connectNotify
()¶
-
createIndex
()¶
-
customEvent
()¶
-
decodeData
()¶
-
disconnectNotify
()¶
-
encodeData
()¶
-
endInsertColumns
()¶
-
endInsertRows
()¶
-
endMoveColumns
()¶
-
endMoveRows
()¶
-
endRemoveColumns
()¶
-
endRemoveRows
()¶
-
endResetModel
()¶
-
exceptedItemList
(self) → List[QgsLayoutItem]¶ Returns the list of specific items excluded from the model.
See also
- Return type
List[QgsLayoutItem]
-
filterAcceptsColumn
()¶
-
filterAcceptsRow
(self, sourceRow: int, sourceParent: QModelIndex) → bool¶ - Parameters
sourceRow (int) –
sourceParent (QModelIndex) –
- Return type
bool
-
filterType
(self) → QgsLayoutItemRegistry.ItemType¶ Returns the current item type filter, or QgsLayoutItemRegistry.LayoutItem if no item type filter is set.
See also
- Return type
-
invalidateFilter
()¶
-
isSignalConnected
()¶
-
itemFromSourceIndex
(self, sourceIndex: QModelIndex) → QgsLayoutItem¶ Returns the
QgsLayoutItem
corresponding to an index from the sourceQgsLayoutModel
model.- Parameters
sourceIndex (QModelIndex) –
- Return type
-
lessThan
(self, left: QModelIndex, right: QModelIndex) → bool¶ - Parameters
left (QModelIndex) –
right (QModelIndex) –
- Return type
bool
-
persistentIndexList
()¶
-
receivers
()¶
-
resetInternalData
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setExceptedItemList
(self, items: Iterable[QgsLayoutItem])¶ Sets a list of specific
items
to exclude from the model.See also
- Parameters
items (Iterable[QgsLayoutItem]) –
-
setFilterType
(self, filter: QgsLayoutItemRegistry.ItemType)¶ Sets the item type
filter
. Only matching item types will be shown. Setfilter
to QgsLayoutItemRegistry.LayoutItem to show all item types.See also
- Parameters
filter (QgsLayoutItemRegistry.ItemType) –
-
sourceLayerModel
(self) → QgsLayoutModel¶ Returns the
QgsLayoutModel
used in this proxy model.- Return type
-
timerEvent
()¶