Class: QgsGeometryCheckRegistry¶
- class qgis.analysis.QgsGeometryCheckRegistry¶
Bases:
sip.wrapper
This class manages all known geometry check factories.
QgsGeometryCheckRegistry
is not usually directly created, but rather accessed throughQgsAnalysis.geometryCheckRegistry()
.Note
This class is a technology preview and unstable API.
Added in version 3.4.
QgsGeometryCheckRegistry() Constructor for
QgsGeometryCheckRegistry
.QgsGeometryCheckRegistry
is not usually directly created, but rather accessed throughQgsAnalysis.geometryCheckRegistry()
.QgsGeometryCheckRegistry(a0:
QgsGeometryCheckRegistry
)Methods
Create a new geometryCheck of type
checkId
Pass thecontext
andgeometryCheckConfiguration
to the newly created check.Returns all geometry check factories that are compatible with
layer
and have all of theflags
set.Registers a new geometry check factory.
- geometryCheck(self, checkId: str | None, context: QgsGeometryCheckContext | None, geometryCheckConfig: Dict[str, Any]) QgsGeometryCheck | None ¶
Create a new geometryCheck of type
checkId
Pass thecontext
andgeometryCheckConfiguration
to the newly created check. Ownership is transferred to the caller.Added in version 3.4.
- Parameters:
checkId (Optional[str])
context (Optional[QgsGeometryCheckContext])
geometryCheckConfig (Dict[str)
- Return type:
Optional[QgsGeometryCheck]
- geometryCheckFactories(self, layer: QgsVectorLayer | None, type: QgsGeometryCheck.CheckType, flags: QgsGeometryCheck.Flags | QgsGeometryCheck.Flag = QgsGeometryCheck.Flags()) List[QgsGeometryCheckFactory] ¶
Returns all geometry check factories that are compatible with
layer
and have all of theflags
set.Added in version 3.4.
- Parameters:
layer (Optional[QgsVectorLayer])
type (QgsGeometryCheck.CheckType)
flags (Union[QgsGeometryCheck.Flags)
- Return type:
List[QgsGeometryCheckFactory]
- registerGeometryCheck(self, checkFactory: QgsGeometryCheckFactory | None)¶
Registers a new geometry check factory.
Added in version 3.4.
- Parameters:
checkFactory (Optional[QgsGeometryCheckFactory])