Class: QgsProcessingParameterGeometry

class qgis.core.QgsProcessingParameterGeometry(name: str, description: str = '', defaultValue: Any = None, optional: bool = False, geometryTypes: Iterable[int] = [])

Bases: QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterGeometry.

The geometryTypes argument allows for specifying a list of geometry types (see QgsWkbTypes.GeometryType) acceptable for this parameter. Passing a empty list will allow for any type of geometry.

QgsProcessingParameterGeometry(QgsProcessingParameterGeometry)

A geometry parameter for processing algorithms.

New in version 3.16.

Parameters

  • name (str) –

  • description (str = '') –

  • defaultValue (Any = None) –

  • optional (bool = False) –

  • geometryTypes –

asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str
Parameters

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) –

Return type

str

asScriptCode(self) → str
Return type

str

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
Parameters
Return type

bool

clone(self) → QgsProcessingParameterDefinition
Return type

QgsProcessingParameterDefinition

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterGeometry

Creates a new parameter using the definition from a script code.

Parameters

  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type

QgsProcessingParameterGeometry

fromVariantMap(self, map: Dict[str, Any]) → bool
Parameters

map (Dict[str) –

Return type

bool

geometryTypes(self) → List[int]

Returns the parameter allowed geometries, as a list of QgsWkbTypes.GeometryType values.

See also

setGeometryTypes()

Return type

List[int]

setGeometryTypes(self, geometryTypes: Iterable[int])

Sets the allowed geometryTypes, as a list of QgsWkbTypes.GeometryType values.

See also

geometryTypes()

Parameters

geometryTypes (Iterable[int]) –

toVariantMap(self) → Dict[str, Any]
Return type

Dict[str, Any]

type(self) → str
Return type

str

typeName() → str

Returns the type name for the parameter class.

Return type

str

valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str
Parameters
Return type

str