Class: QgsMapLayerModel¶
-
class
qgis.core.
QgsMapLayerModel
(parent: QObject = None)¶ Bases:
PyQt5.QtCore.QAbstractItemModel
QgsMapLayerModel
creates a model to display layers in widgets.QgsMapLayerModel(layers: Iterable[QgsMapLayer], parent: QObject = None)
QgsMapLayerModel
creates a model to display a specific list of layers in a widget.The
QgsMapLayerModel
class is a model to display layers in widgets.See also
See also
New in version 2.3.
- Parameters
parent –
-
AdditionalRole
= 260¶
-
EmptyRole
= 259¶
-
class
ItemDataRole
¶ Bases:
int
-
baseClass
¶ alias of
QgsMapLayerModel
-
-
LayerIdRole
= 257¶
-
LayerRole
= 258¶
-
addLayers
(self, layers: Iterable[QgsMapLayer])¶ - Parameters
layers (Iterable[QgsMapLayer]) –
-
additionalItems
(self) → List[str]¶ Returns the list of additional (non map layer) items included at the end of the model.
See also
New in version 3.0.
- Return type
List[str]
-
allowEmptyLayer
(self) → bool¶ Returns
True
if the model allows the empty layer (“not set”) choice.See also
New in version 3.0.
- Return type
bool
-
QgsMapLayerModel.beginInsertColumns(self, QModelIndex, int, int)
-
QgsMapLayerModel.beginInsertRows(self, QModelIndex, int, int)
-
QgsMapLayerModel.beginMoveColumns(self, QModelIndex, int, int, QModelIndex, int) -> bool
-
QgsMapLayerModel.beginMoveRows(self, QModelIndex, int, int, QModelIndex, int) -> bool
-
QgsMapLayerModel.beginRemoveColumns(self, QModelIndex, int, int)
-
QgsMapLayerModel.beginRemoveRows(self, QModelIndex, int, int)
-
beginResetModel
(self)¶
-
QgsMapLayerModel.changePersistentIndex(self, QModelIndex, QModelIndex)
-
changePersistentIndexList
(self, Iterable[QModelIndex], Iterable[QModelIndex])¶
-
checkAll
(self, checkState: Qt.CheckState)¶ checkAll changes the checkstate for all the layers
- Parameters
checkState (Qt.CheckState) –
-
childEvent
(self, QChildEvent)¶
-
columnCount
(self, parent: QModelIndex = QModelIndex()) → int¶ - Parameters
parent (QModelIndex = QModelIndex()) –
- Return type
int
-
connectNotify
(self, QMetaMethod)¶
-
QgsMapLayerModel.createIndex(self, int, int, object: object = 0) -> QModelIndex
-
customEvent
(self, QEvent)¶
-
data
(self, index: QModelIndex, role: int = Qt.DisplayRole) → Any¶ - Parameters
index (QModelIndex) –
role (int = Qt.DisplayRole) –
- Return type
Any
-
QgsMapLayerModel.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)¶
-
flags
(self, index: QModelIndex) → Qt.ItemFlags¶ - Parameters
index (QModelIndex) –
- Return type
Qt.ItemFlags
-
iconForLayer
(layer: QgsMapLayer) → QIcon¶ Returns the icon corresponding to a specified map
layer
.New in version 3.0.
- Parameters
layer (QgsMapLayer) –
- Return type
QIcon
-
index
(self, row: int, column: int, parent: QModelIndex = QModelIndex()) → QModelIndex¶ - Parameters
row (int) –
column (int) –
parent (QModelIndex = QModelIndex()) –
- Return type
QModelIndex
-
indexFromLayer
(self, layer: QgsMapLayer) → QModelIndex¶ indexFromLayer returns the model index for a given layer
See also
- Parameters
layer (QgsMapLayer) –
- Return type
QModelIndex
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
itemsCheckable
(self) → bool¶ returns if the items can be checked or not
- Return type
bool
-
layerFromIndex
(self, index: QModelIndex) → QgsMapLayer¶ Returns the map layer corresponding to the specified
index
.See also
New in version 3.0.
- Parameters
index (QModelIndex) –
- Return type
-
layersChecked
(self, checkState: Qt.CheckState = Qt.Checked) → List[QgsMapLayer]¶ layersChecked returns the list of layers which are checked (or unchecked)
- Parameters
checkState (Qt.CheckState = Qt.Checked) –
- Return type
List[QgsMapLayer]
-
parent
(self, child: QModelIndex) → QModelIndex¶ - Parameters
child (QModelIndex) –
- Return type
QModelIndex
-
persistentIndexList
(self) → List[QModelIndex]¶
-
receivers
(self, PYQT_SIGNAL) → int¶
-
removeLayers
(self, layerIds: Iterable[str])¶ - Parameters
layerIds (Iterable[str]) –
-
resetInternalData
(self)¶
-
rowCount
(self, parent: QModelIndex = QModelIndex()) → int¶ - Parameters
parent (QModelIndex = QModelIndex()) –
- Return type
int
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setAdditionalItems
(self, items: Iterable[str])¶ Sets a list of additional (non map layer) items to include at the end of the model. These may represent additional layers such as layers which are not included in the map layer registry, or paths to layers which have not yet been loaded into QGIS.
See also
New in version 3.0.
- Parameters
items (Iterable[str]) –
-
setAllowEmptyLayer
(self, allowEmpty: bool)¶ Sets whether an optional empty layer (“not set”) option is present in the model.
See also
New in version 3.0.
- Parameters
allowEmpty (bool) –
-
setData
(self, index: QModelIndex, value: Any, role: int = Qt.EditRole) → bool¶ - Parameters
index (QModelIndex) –
value (Any) –
role (int = Qt.EditRole) –
- Return type
bool
-
setItemsCheckable
(self, checkable: bool)¶ setItemsCheckable defines if layers should be selectable in the widget
- Parameters
checkable (bool) –
-
setShowCrs
(self, showCrs: bool)¶ Sets whether the CRS of layers is also included in the model’s display role.
See also
New in version 3.0.
- Parameters
showCrs (bool) –
-
showCrs
(self) → bool¶ Returns
True
if the model includes layer’s CRS in the display role.See also
New in version 3.0.
- Return type
bool
-
timerEvent
(self, QTimerEvent)¶