Subgroup: Map

Class: QgsMapLayerProxyModel

class qgis.core.QgsMapLayerProxyModel(parent: QObject = None)

Bases: PyQt5.QtCore.QSortFilterProxyModel

QgsMapLayerProxModel creates a proxy model with a QgsMapLayerModel as source model. It can be used to filter the layers list in a widget.

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
changePersistentIndex
changePersistentIndexList
childEvent
connectNotify
createIndex
customEvent
decodeData
disconnectNotify
encodeData
endInsertColumns
endInsertRows
endMoveColumns
endMoveRows
endRemoveColumns
endRemoveRows
endResetModel
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.
filterAcceptsColumn
filterAcceptsRow
filters
invalidateFilter
isSignalConnected
lessThan
persistentIndexList
receivers
resetInternalData
sender
senderSignalIndex
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.
setFilters setFilters set flags that affect how layers are filtered
sourceLayerModel layerModel returns the QgsMapLayerModel used in this QSortFilterProxyModel
timerEvent

Signals

Attributes

All
HasGeometry
LineLayer
NoGeometry
PluginLayer
PointLayer
PolygonLayer
RasterLayer
VectorLayer
WritableLayer
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.

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.

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()