Class: QgsLayoutProxyModel

class qgis.core.QgsLayoutProxyModel

Bases: PyQt5.QtCore.QSortFilterProxyModel

Allows for filtering a QgsLayoutModel by item type.

New in version 3.0.

QgsLayoutProxyModel(layout: QgsLayout, parent: QObject = None) Constructor for QgsLayoutProxyModelm, attached to the specified layout.

Methods

allowEmptyItem

Returns True if the model includes the empty item choice.

beginInsertColumns

beginInsertRows

beginMoveColumns

beginMoveRows

beginRemoveColumns

beginRemoveRows

beginResetModel

changePersistentIndex

changePersistentIndexList

childEvent

connectNotify

createIndex

customEvent

decodeData

disconnectNotify

encodeData

endInsertColumns

endInsertRows

endMoveColumns

endMoveRows

endRemoveColumns

endRemoveRows

endResetModel

exceptedItemList

Returns the list of specific items excluded from the model.

filterAcceptsColumn

filterAcceptsRow

param sourceRow

filterType

Returns the current item type filter, or QgsLayoutItemRegistry.LayoutItem if no item type filter is set.

invalidateFilter

isSignalConnected

itemFlags

Returns the layout item flags used for filtering the available items.

itemFromSourceIndex

Returns the QgsLayoutItem corresponding to an index from the source QgsLayoutModel model.

layout

Returns the associated layout.

lessThan

param left

persistentIndexList

receivers

resetInternalData

sender

senderSignalIndex

setAllowEmptyItem

Sets whether an optional empty layout item is present in the model.

setExceptedItemList

Sets a list of specific items to exclude from the model.

setFilterType

Sets the item type filter.

setItemFlags

Sets layout item flags to use for filtering the available items.

sourceLayerModel

Returns the QgsLayoutModel used in this proxy model.

timerEvent

allowEmptyItem(self)bool

Returns True if the model includes the empty item choice.

New in version 3.8.

Return type

bool

QgsLayoutProxyModel.beginInsertColumns(self, QModelIndex, int, int)
QgsLayoutProxyModel.beginInsertRows(self, QModelIndex, int, int)
QgsLayoutProxyModel.beginMoveColumns(self, QModelIndex, int, int, QModelIndex, int) -> bool
QgsLayoutProxyModel.beginMoveRows(self, QModelIndex, int, int, QModelIndex, int) -> bool
QgsLayoutProxyModel.beginRemoveColumns(self, QModelIndex, int, int)
QgsLayoutProxyModel.beginRemoveRows(self, QModelIndex, int, int)
beginResetModel(self)
QgsLayoutProxyModel.changePersistentIndex(self, QModelIndex, QModelIndex)
changePersistentIndexList(self, Iterable[QModelIndex], Iterable[QModelIndex])
childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
QgsLayoutProxyModel.createIndex(self, int, int, object: object = 0) -> QModelIndex
customEvent(self, QEvent)
QgsLayoutProxyModel.decodeData(self, int, int, QModelIndex, QDataStream) -> bool
disconnectNotify(self, QMetaMethod)
encodeData(self, Iterable[QModelIndex], QDataStream)
endInsertColumns(self)
endInsertRows(self)
endMoveColumns(self)
endMoveRows(self)
endRemoveColumns(self)
endRemoveRows(self)
endResetModel(self)
exceptedItemList(self)List[QgsLayoutItem]

Returns the list of specific items excluded from the model.

Return type

List[QgsLayoutItem]

filterAcceptsColumn(self, int, QModelIndex)bool
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

setFilterType()

Return type

QgsLayoutItemRegistry.ItemType

invalidateFilter(self)
isSignalConnected(self, QMetaMethod)bool
itemFlags(self)QgsLayoutItem.Flags

Returns the layout item flags used for filtering the available items.

Returns None if no flag based filtering is occurring.

See also

setItemFlags()

New in version 3.16.

Return type

QgsLayoutItem.Flags

itemFromSourceIndex(self, sourceIndex: QModelIndex)QgsLayoutItem

Returns the QgsLayoutItem corresponding to an index from the source QgsLayoutModel model.

Parameters

sourceIndex (QModelIndex) –

Return type

QgsLayoutItem

layout(self)QgsLayout

Returns the associated layout.

New in version 3.8.

Return type

QgsLayout

lessThan(self, left: QModelIndex, right: QModelIndex)bool
Parameters
  • left (QModelIndex) –

  • right (QModelIndex) –

Return type

bool

persistentIndexList(self)List[QModelIndex]
receivers(self, PYQT_SIGNAL)int
resetInternalData(self)
sender(self)QObject
senderSignalIndex(self)int
setAllowEmptyItem(self, allowEmpty: bool)

Sets whether an optional empty layout item is present in the model.

See also

allowEmptyItem()

New in version 3.8.

Parameters

allowEmpty (bool) –

setExceptedItemList(self, items: Iterable[QgsLayoutItem])

Sets a list of specific items to exclude from the model.

Parameters

items (Iterable[QgsLayoutItem]) –

setFilterType(self, filter: QgsLayoutItemRegistry.ItemType)

Sets the item type filter. Only matching item types will be shown. Set filter to QgsLayoutItemRegistry.LayoutItem to show all item types.

See also

filterType()

Parameters

filter (QgsLayoutItemRegistry.ItemType) –

setItemFlags(self, flags: Union[QgsLayoutItem.Flags, QgsLayoutItem.Flag])

Sets layout item flags to use for filtering the available items.

Set flags to None to clear the flag based filtering.

See also

itemFlags()

New in version 3.16.

Parameters

flags (Union[QgsLayoutItem.Flags) –

sourceLayerModel(self)QgsLayoutModel

Returns the QgsLayoutModel used in this proxy model.

Return type

QgsLayoutModel

timerEvent(self, QTimerEvent)