Subgroup: Feature

Class: QgsFeatureFilterModel¶

class qgis.core.QgsFeatureFilterModel¶

Bases: PyQt5.QtCore.QAbstractItemModel

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

New in version 3.0: Methods

`allowNull`	Add a NULL entry to the list.
`beginInsertColumns`
`beginInsertRows`
`beginMoveColumns`
`beginMoveRows`
`beginRemoveColumns`
`beginRemoveRows`
`beginResetModel`
`blockSignals`
`buddy`
`canDropMimeData`
`canFetchMore`
`changePersistentIndex`
`changePersistentIndexList`
`childEvent`
`children`
`columnCount`
`connectNotify`
`createIndex`
`customEvent`
`data`
`decodeData`
`deleteLater`
`disconnect`
`disconnectNotify`
`displayExpression`	The display expression will be used for
`dropMimeData`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`encodeData`
`endInsertColumns`
`endInsertRows`
`endMoveColumns`
`endMoveRows`
`endRemoveColumns`
`endRemoveRows`
`endResetModel`
`event`
`eventFilter`
`extraIdentifierValue`	Allows specifying one value that does not need to match the filter criteria but will still be available in the model.
`extraIdentifierValueIndex`	The index at which the extra identifier value is available within the model.
`extraValueDoesNotExist`	Flag indicating that the extraIdentifierValue does not exist in the data.
`fetchMore`
`filterExpression`	An additional filter expression to apply, next to the filterValue.
`filterValue`	This value will be used to filter the features available from this model.
`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`
`identifierField`	The identifier field should be a unique field that can be used to identify individual features.
`index`
`inherits`
`insertColumn`
`insertColumns`
`insertRow`
`insertRows`
`installEventFilter`
`isLoading`	Indicator if the model is currently performing any feature iteration in the background.
`isSignalConnected`
`isWidgetType`
`isWindowType`
`itemData`
`killTimer`
`match`
`metaObject`
`mimeData`
`mimeTypes`
`moveColumn`
`moveColumns`
`moveRow`
`moveRows`
`moveToThread`
`objectName`
`parent`
`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`
`setAllowNull`	Add a NULL entry to the list.
`setData`
`setDisplayExpression`	The display expression will be used for
`setExtraIdentifierValue`	Allows specifying one value that does not need to match the filter criteria but will still be available in the model.
`setFilterExpression`	An additional filter expression to apply, next to the filterValue.
`setFilterValue`	This value will be used to filter the features available from this model.
`setHeaderData`
`setIdentifierField`	The identifier field should be a unique field that can be used to identify individual features.
`setItemData`
`setObjectName`
`setParent`
`setProperty`
`setSourceLayer`	The source layer from which features will be fetched.
`sibling`
`signalsBlocked`
`sort`
`sourceLayer`	The source layer from which features will be fetched.
`span`
`startTimer`
`submit`
`supportedDragActions`
`supportedDropActions`
`thread`
`timerEvent`
`tr`

Attributes

`HorizontalSortHint`
`IdentifierValueRole`
`NoLayoutChangeHint`
`ValueRole`
`VerticalSortHint`
`allowNullChanged`	Add a NULL entry to the list.
`beginUpdate`	Notification that the model is about to be changed because a job was completed.
`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]
`displayExpressionChanged`	The display expression will be used for
`endUpdate`	Notification that the model change is finished.
`extraIdentifierValueChanged`	Allows specifying one value that does not need to match the filter criteria but will still be available in the model.
`extraIdentifierValueIndexChanged`	The index at which the extra identifier value is available within the model.
`extraValueDoesNotExistChanged`	Flag indicating that the extraIdentifierValue does not exist in the data.
`filterExpressionChanged`	An additional filter expression to apply, next to the filterValue.
`filterJobCompleted`	Indicates that a filter job has been completed and new data may be available.
`filterValueChanged`	This value will be used to filter the features available from this model.
`identifierFieldChanged`	The identifier field should be a unique field that can be used to identify individual features.
`isLoadingChanged`	Indicator if the model is currently performing any feature iteration in the background.
`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]
`sourceLayerChanged`	The source layer from which features will be fetched.
`staticMetaObject`

IdentifierValueRole = 256¶

class Role¶: Bases: int

ValueRole = 257¶

allowNull(self) → bool¶: Add a NULL entry to the list.

allowNullChanged¶: Add a NULL entry to the list. [signal]

beginInsertColumns()¶

beginInsertRows()¶

beginMoveColumns()¶

beginMoveRows()¶

beginRemoveColumns()¶

beginRemoveRows()¶

beginResetModel()¶

beginUpdate¶: Notification that the model is about to be changed because a job was completed. [signal]

changePersistentIndex()¶

changePersistentIndexList()¶

childEvent()¶

columnCount(self, parent: QModelIndex) → int¶

connectNotify()¶

createIndex()¶

customEvent()¶

data(self, index: QModelIndex, role: int) → Any¶

decodeData()¶

disconnectNotify()¶

displayExpression(self) → str¶

The display expression will be used for

displaying values in the combobox
filtering based on filterValue

displayExpressionChanged¶

The display expression will be used for

displaying values in the combobox
filtering based on filterValue [signal]

encodeData()¶

endInsertColumns()¶

endInsertRows()¶

endMoveColumns()¶

endMoveRows()¶

endRemoveColumns()¶

endRemoveRows()¶

endResetModel()¶

endUpdate¶: Notification that the model change is finished. Will always be emitted in sync with beginUpdate. [signal]

extraIdentifierValue(self) → Any¶: Allows specifying one value that does not need to match the filter criteria but will still be available in the model.

extraIdentifierValueChanged¶: Allows specifying one value that does not need to match the filter criteria but will still be available in the model. [signal]

extraIdentifierValueIndex(self) → int¶: The index at which the extra identifier value is available within the model.

extraIdentifierValueIndexChanged¶: The index at which the extra identifier value is available within the model. [signal]

extraValueDoesNotExist(self) → bool¶: Flag indicating that the extraIdentifierValue does not exist in the data.

extraValueDoesNotExistChanged¶: Flag indicating that the extraIdentifierValue does not exist in the data. [signal]

filterExpression(self) → str¶: An additional filter expression to apply, next to the filterValue. Can be used for spatial filtering etc.

filterExpressionChanged¶: An additional filter expression to apply, next to the filterValue. Can be used for spatial filtering etc. [signal]

filterJobCompleted¶: Indicates that a filter job has been completed and new data may be available. [signal]

filterValue(self) → str¶: This value will be used to filter the features available from this model. Whenever a substring of the displayExpression of a feature matches the filter value, it will be accessible by this model.

filterValueChanged¶: This value will be used to filter the features available from this model. Whenever a substring of the displayExpression of a feature matches the filter value, it will be accessible by this model. [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.

identifierFieldChanged¶: 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. [signal]

index(self, row: int, column: int, parent: QModelIndex) → QModelIndex¶

isLoading(self) → bool¶: Indicator if the model is currently performing any feature iteration in the background.

isLoadingChanged¶: Indicator if the model is currently performing any feature iteration in the background. [signal]

isSignalConnected()¶

parent(self, child: QModelIndex) → QModelIndex¶

persistentIndexList()¶

receivers()¶

resetInternalData()¶

rowCount(self, parent: QModelIndex) → int¶

sender()¶

senderSignalIndex()¶

setAllowNull(self, allowNull: bool)¶: Add a NULL entry to the list.

setDisplayExpression(self, displayExpression: str)¶

The display expression will be used for

displaying values in the combobox
filtering based on filterValue

setExtraIdentifierValue(self, extraIdentifierValue: Any)¶: Allows specifying one value that does not need to match the filter criteria but will still be available in the model.

setFilterExpression(self, filterExpression: str)¶: An additional filter expression to apply, next to the filterValue. Can be used for spatial filtering etc.

setFilterValue(self, filterValue: str)¶: This value will be used to filter the features available from this model. Whenever a substring of the displayExpression of a feature matches the filter value, it will be accessible by this model.

setIdentifierField(self, identifierField: 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.

setSourceLayer(self, sourceLayer: QgsVectorLayer)¶: The source layer from which features will be fetched.

sourceLayer(self) → QgsVectorLayer¶: The source layer from which features will be fetched.

sourceLayerChanged¶: The source layer from which features will be fetched. [signal]

timerEvent()¶