Class: QgsFeatureFilterModel

class qgis.core.QgsFeatureFilterModel

Bases: QgsFeaturePickerModelBase

Provides a list of features based on filter conditions. Features are fetched asynchronously.

QgsFeatureFilterModel(parent: QObject = None) Create a new QgsFeatureFilterModel, optionally specifying a parent.

Methods

beginInsertColumns

beginInsertRows

beginMoveColumns

beginMoveRows

beginRemoveColumns

beginRemoveRows

beginResetModel

changePersistentIndex

changePersistentIndexList

childEvent

connectNotify

createIndex

customEvent

decodeData

disconnectNotify

encodeData

endInsertColumns

endInsertRows

endMoveColumns

endMoveRows

endRemoveColumns

endRemoveRows

endResetModel

extraIdentifierValue

extraIdentifierValues

Allows specifying one value that does not need to match the filter criteria but will still be available in the model.

identifierField

The identifier field should be a unique field that can be used to identify individual features.

identifierFields

The identifier field should be a unique field that can be used to identify individual features.

isSignalConnected

persistentIndexList

receivers

requestToReloadCurrentFeature

resetInternalData

sender

senderSignalIndex

setExtraIdentifierValue

setExtraIdentifierValueToNull

Allows specifying one value that does not need to match the filter criteria but will still be available in the model as NULL value(s).

setExtraIdentifierValueUnguarded

setExtraIdentifierValues

Allows specifying one value that does not need to match the filter criteria but will still be available in the model.

setIdentifierFields

The identifier field should be a unique field that can be used to identify individual features.

timerEvent

Signals

extraIdentifierValuesChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

identifierFieldsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

beginInsertColumns(self, QModelIndex, int, int)
beginInsertRows(self, QModelIndex, int, int)
beginMoveColumns(self, QModelIndex, int, int, QModelIndex, int) bool
beginMoveRows(self, QModelIndex, int, int, QModelIndex, int) bool
beginRemoveColumns(self, QModelIndex, int, int)
beginRemoveRows(self, QModelIndex, int, int)
beginResetModel(self)
changePersistentIndex(self, QModelIndex, QModelIndex)
changePersistentIndexList(self, Iterable[QModelIndex], Iterable[QModelIndex])
childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
createIndex(self, int, int, object: object = 0) QModelIndex
customEvent(self, QEvent)
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)
extraIdentifierValue()
extraIdentifierValues(self) List[Any]

Allows specifying one value that does not need to match the filter criteria but will still be available in the model.

New in version 3.10.

Return type:

List[Any]

extraIdentifierValuesChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

identifierField(self) str

The identifier field should be a unique field that can be used to identify individual features. It is normally set to the primary key of the layer. If there are several identifier fields defined, the behavior is not guaranteed

Deprecated since version QGIS: 3.10 use identifierFields instead

Return type:

str

identifierFields(self) List[str]

The identifier field should be a unique field that can be used to identify individual features. It is normally set to the primary key of the layer.

New in version 3.10.

Return type:

List[str]

identifierFieldsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

isSignalConnected(self, QMetaMethod) bool
persistentIndexList(self) List[QModelIndex]
receivers(self, PYQT_SIGNAL) int
requestToReloadCurrentFeature()
resetInternalData(self)
sender(self) QObject
senderSignalIndex(self) int
setExtraIdentifierValue()
setExtraIdentifierValueToNull(self)

Allows specifying one value that does not need to match the filter criteria but will still be available in the model as NULL value(s).

New in version 3.10.

setExtraIdentifierValueUnguarded()
setExtraIdentifierValues(self, extraIdentifierValues: Iterable[Any])

Allows specifying one value that does not need to match the filter criteria but will still be available in the model.

New in version 3.10.

Parameters:

extraIdentifierValues (Iterable[Any]) –

setIdentifierFields(self, identifierFields: Iterable[str])

The identifier field should be a unique field that can be used to identify individual features. It is normally set to the primary key of the layer.

Note

This will also reset identifier fields to NULL

New in version 3.10.

Parameters:

identifierFields (Iterable[str]) –

timerEvent(self, QTimerEvent)