Class: QgsMapLayerProxyModel¶
-
class
qgis.core.
QgsMapLayerProxyModel
(parent: QObject = None)¶ Bases:
PyQt5.QtCore.QSortFilterProxyModel
QgsMapLayerProxModel
creates a proxy model with aQgsMapLayerModel
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.
- Parameters
parent –
-
All
= 191¶
-
class
Filter
¶ Bases:
int
-
class
Filters
¶ Bases:
sip.wrapper
QgsMapLayerProxyModel.Filters(Union[QgsMapLayerProxyModel.Filters, QgsMapLayerProxyModel.Filter]) QgsMapLayerProxyModel.Filters(QgsMapLayerProxyModel.Filters)
-
baseClass
¶ alias of
QgsMapLayerProxyModel
-
-
HasGeometry
= 28¶
-
LineLayer
= 8¶
-
MeshLayer
= 128¶
-
NoGeometry
= 2¶
-
PluginLayer
= 32¶
-
PointLayer
= 4¶
-
PolygonLayer
= 16¶
-
RasterLayer
= 1¶
-
VectorLayer
= 30¶
-
WritableLayer
= 64¶
-
acceptsLayer
(self, layer: QgsMapLayer) → bool¶ Returns
True
if the proxy model accepts the specified maplayer
.New in version 3.8.
- Parameters
layer (QgsMapLayer) –
- Return type
bool
-
QgsMapLayerProxyModel.beginInsertColumns(self, QModelIndex, int, int)
-
QgsMapLayerProxyModel.beginInsertRows(self, QModelIndex, int, int)
-
QgsMapLayerProxyModel.beginMoveColumns(self, QModelIndex, int, int, QModelIndex, int) -> bool
-
QgsMapLayerProxyModel.beginMoveRows(self, QModelIndex, int, int, QModelIndex, int) -> bool
-
QgsMapLayerProxyModel.beginRemoveColumns(self, QModelIndex, int, int)
-
QgsMapLayerProxyModel.beginRemoveRows(self, QModelIndex, int, int)
-
beginResetModel
(self)¶
-
QgsMapLayerProxyModel.changePersistentIndex(self, QModelIndex, QModelIndex)
-
changePersistentIndexList
(self, Iterable[QModelIndex], Iterable[QModelIndex])¶
-
childEvent
(self, QChildEvent)¶
-
connectNotify
(self, QMetaMethod)¶
-
QgsMapLayerProxyModel.createIndex(self, int, int, object: object = 0) -> QModelIndex
-
customEvent
(self, QEvent)¶
-
QgsMapLayerProxyModel.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)¶
-
exceptedLayerIds
(self) → List[str]¶ Returns the blacklist of layer IDs which are excluded from the model.
See also
See also
- Return type
List[str]
-
exceptedLayerList
(self) → List[QgsMapLayer]¶ Returns the blacklist of layers which are excluded from the model.
See also
See also
See also
- Return type
List[QgsMapLayer]
-
excludedProviders
(self) → List[str]¶ Returns the blacklist of data providers which are excluded from the model.
See also
New in version 3.0.
- Return type
List[str]
-
filterAcceptsColumn
(self, int, QModelIndex) → bool¶
-
filterAcceptsRow
(self, source_row: int, source_parent: QModelIndex) → bool¶ - Parameters
source_row (int) –
source_parent (QModelIndex) –
- Return type
bool
-
filterString
(self) → str¶ Returns the current filter string, if set.
See also
New in version 3.4.
- Return type
str
-
filters
(self) → QgsMapLayerProxyModel.Filters¶ Returns the filter flags which affect how layers are filtered within the model.
See also
New in version 2.3.
- Return type
-
invalidateFilter
(self)¶
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
layerWhitelist
(self) → List[QgsMapLayer]¶ Returns the list of layers which are excluded from the model.
An empty list indicates that no whitelisting should be performed.
See also
See also
New in version 3.4.
- Return type
List[QgsMapLayer]
-
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¶
-
setExceptedLayerIds
(self, ids: Iterable[str])¶ Sets a blacklist of layers (by layer ID) to exclude from the model.
See also
See also
- Parameters
ids (Iterable[str]) –
-
setExceptedLayerList
(self, exceptList: Iterable[QgsMapLayer])¶ Sets a blacklist of layers to exclude from the model.
See also
See also
See also
- Parameters
exceptList (Iterable[QgsMapLayer]) –
-
setExcludedProviders
(self, providers: Iterable[str])¶ Sets a blacklist of data providers which should be excluded from the model.
See also
New in version 3.0.
- Parameters
providers (Iterable[str]) –
-
setFilterString
(self, filter: str)¶ Sets a
filter
string, such that only layers with names matching the specified string will be shown.See also
New in version 3.4.
- Parameters
filter (str) –
-
setFilters
(self, filters: Union[QgsMapLayerProxyModel.Filters, QgsMapLayerProxyModel.Filter]) → QgsMapLayerProxyModel¶ Sets
filter
flags which affect how layers are filtered within the model.See also
New in version 2.3.
- Parameters
filters (Union[QgsMapLayerProxyModel.Filters) –
- Return type
-
setLayerWhitelist
(self, layers: Iterable[QgsMapLayer])¶ Sets a whitelist of
layers
to include within the model. Only layers from this list will be shown.An empty list indicates that no whitelisting should be performed.
See also
See also
New in version 3.4.
- Parameters
layers (Iterable[QgsMapLayer]) –
-
sourceLayerModel
(self) → QgsMapLayerModel¶ layerModel returns the
QgsMapLayerModel
used in this QSortFilterProxyModel- Return type
-
timerEvent
(self, QTimerEvent)¶