Subgroup: Map

Class: QgsMapLayerProxyModel¶

class qgis.core.QgsMapLayerProxyModel¶

Bases: PyQt5.QtCore.QSortFilterProxyModel

The QgsMapLayerProxyModel class provides an easy to use model to display the list of layers in widgets.

New in version 2.3: Methods

`beginInsertColumns`
`beginInsertRows`
`beginMoveColumns`
`beginMoveRows`
`beginRemoveColumns`
`beginRemoveRows`
`beginResetModel`
`blockSignals`
`buddy`
`canDropMimeData`
`canFetchMore`
`changePersistentIndex`
`changePersistentIndexList`
`childEvent`
`children`
`columnCount`
`connectNotify`
`createIndex`
`customEvent`
`data`
`decodeData`
`deleteLater`
`disconnect`
`disconnectNotify`
`dropMimeData`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`dynamicSortFilter`
`encodeData`
`endInsertColumns`
`endInsertRows`
`endMoveColumns`
`endMoveRows`
`endRemoveColumns`
`endRemoveRows`
`endResetModel`
`event`
`eventFilter`
`exceptedLayerIds`	Get the list of maplayer ids which are excluded from the list
`exceptedLayerList`	Get the list of maplayers which are excluded from the list
`excludedProviders`	Returns the list of data providers which are excluded from the model.
`fetchMore`
`filterAcceptsColumn`
`filterAcceptsRow`
`filterCaseSensitivity`
`filterKeyColumn`
`filterRegExp`
`filterRole`
`filters`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`flags`
`hasChildren`
`hasIndex`
`headerData`
`index`
`inherits`
`insertColumn`
`insertColumns`
`insertRow`
`insertRows`
`installEventFilter`
`invalidate`
`invalidateFilter`
`isSignalConnected`
`isSortLocaleAware`
`isWidgetType`
`isWindowType`
`itemData`
`killTimer`
`lessThan`
`mapFromSource`
`mapSelectionFromSource`
`mapSelectionToSource`
`mapToSource`
`match`
`metaObject`
`mimeData`
`mimeTypes`
`moveColumn`
`moveColumns`
`moveRow`
`moveRows`
`moveToThread`
`objectName`
`parent`	parent(self) -> QObject
`persistentIndexList`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`receivers`
`removeColumn`
`removeColumns`
`removeEventFilter`
`removeRow`
`removeRows`
`resetInternalData`
`revert`
`roleNames`
`rowCount`
`sender`
`senderSignalIndex`
`setData`
`setDynamicSortFilter`
`setExceptedLayerIds`	Set the list of maplayer ids which are excluded from the list
`setExceptedLayerList`	offer the possibility to except some layers to be listed
`setExcludedProviders`	Sets a list of data providers which should be excluded from the model.
`setFilterCaseSensitivity`
`setFilterFixedString`
`setFilterKeyColumn`
`setFilterRegExp`	setFilterRegExp(self, str)
`setFilterRole`
`setFilterWildcard`
`setFilters`	setFilters set flags that affect how layers are filtered
`setHeaderData`
`setItemData`
`setObjectName`
`setParent`
`setProperty`
`setSortCaseSensitivity`
`setSortLocaleAware`
`setSortRole`
`setSourceModel`
`sibling`
`signalsBlocked`
`sort`
`sortCaseSensitivity`
`sortColumn`
`sortOrder`
`sortRole`
`sourceLayerModel`	layerModel returns the QgsMapLayerModel used in this QSortFilterProxyModel
`sourceModel`
`span`
`startTimer`
`submit`
`supportedDragActions`
`supportedDropActions`
`thread`
`timerEvent`
`tr`

Attributes

`All`
`HasGeometry`
`HorizontalSortHint`
`LineLayer`
`NoGeometry`
`NoLayoutChangeHint`
`PluginLayer`
`PointLayer`
`PolygonLayer`
`RasterLayer`
`VectorLayer`
`VerticalSortHint`
`WritableLayer`
`columnsAboutToBeInserted`	columnsAboutToBeInserted(self, QModelIndex, int, int) [signal]
`columnsAboutToBeMoved`	columnsAboutToBeMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
`columnsAboutToBeRemoved`	columnsAboutToBeRemoved(self, QModelIndex, int, int) [signal]
`columnsInserted`	columnsInserted(self, QModelIndex, int, int) [signal]
`columnsMoved`	columnsMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
`columnsRemoved`	columnsRemoved(self, QModelIndex, int, int) [signal]
`dataChanged`	dataChanged(self, QModelIndex, QModelIndex, Iterable[int] = []) [signal]
`destroyed`	destroyed(self, QObject = None) [signal]
`layoutAboutToBeChanged`	layoutAboutToBeChanged(self, object = QList<QPersistentModelIndex>(), QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]
`layoutChanged`	layoutChanged(self, Iterable[QPersistentModelIndex] = [], QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]
`modelAboutToBeReset`	modelAboutToBeReset(self) [signal]
`modelReset`	modelReset(self) [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`rowsAboutToBeInserted`	rowsAboutToBeInserted(self, QModelIndex, int, int) [signal]
`rowsAboutToBeMoved`	rowsAboutToBeMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
`rowsAboutToBeRemoved`	rowsAboutToBeRemoved(self, QModelIndex, int, int) [signal]
`rowsInserted`	rowsInserted(self, QModelIndex, int, int) [signal]
`rowsMoved`	rowsMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]
`rowsRemoved`	rowsRemoved(self, QModelIndex, int, int) [signal]
`sourceModelChanged`	sourceModelChanged(self) [signal]
`staticMetaObject`

All = 63¶

class Filter¶: Bases: int

class Filters¶

Bases: sip.wrapper

QgsMapLayerProxyModel.Filters(Union[QgsMapLayerProxyModel.Filters, QgsMapLayerProxyModel.Filter]) QgsMapLayerProxyModel.Filters(QgsMapLayerProxyModel.Filters)

HasGeometry = 28¶

LineLayer = 8¶

NoGeometry = 2¶

PluginLayer = 32¶

PointLayer = 4¶

PolygonLayer = 16¶

RasterLayer = 1¶

VectorLayer = 30¶

WritableLayer = 64¶

beginInsertColumns()¶

beginInsertRows()¶

beginMoveColumns()¶

beginMoveRows()¶

beginRemoveColumns()¶

beginRemoveRows()¶

beginResetModel()¶

changePersistentIndex()¶

changePersistentIndexList()¶

childEvent()¶

connectNotify()¶

createIndex()¶

customEvent()¶

decodeData()¶

disconnectNotify()¶

encodeData()¶

endInsertColumns()¶

endInsertRows()¶

endMoveColumns()¶

endMoveRows()¶

endRemoveColumns()¶

endRemoveRows()¶

endResetModel()¶

exceptedLayerIds(self) → List[str]¶: Get the list of maplayer ids which are excluded from the list

exceptedLayerList(self) → List[QgsMapLayer]¶: Get the list of maplayers which are excluded from the list

excludedProviders(self) → List[str]¶: Returns the list of data providers which are excluded from the model.

See also

setExcludedProviders()

New in version 3.0.

filterAcceptsColumn()¶

filterAcceptsRow(self, source_row: int, source_parent: QModelIndex) → bool¶

filters(self) → QgsMapLayerProxyModel.Filters¶

invalidateFilter()¶

isSignalConnected()¶

lessThan(self, left: QModelIndex, right: QModelIndex) → bool¶

persistentIndexList()¶

receivers()¶

resetInternalData()¶

sender()¶

senderSignalIndex()¶

setExceptedLayerIds(self, ids: Iterable[str])¶: Set the list of maplayer ids which are excluded from the list

setExceptedLayerList(self, exceptList: Iterable[QgsMapLayer])¶: offer the possibility to except some layers to be listed

setExcludedProviders(self, providers: Iterable[str])¶: Sets a list of data providers which should be excluded from the model.

New in version 3.0.

See also

excludedProviders()

setFilters(self, filters: Union[QgsMapLayerProxyModel.Filters, QgsMapLayerProxyModel.Filter]) → QgsMapLayerProxyModel¶

setFilters set flags that affect how layers are filtered

Parameters:	filters – are Filter flags

New in version 2.3.

sourceLayerModel(self) → QgsMapLayerModel¶: layerModel returns the QgsMapLayerModel used in this QSortFilterProxyModel

timerEvent()¶