Class: QgsProcessingParameterGeometry

class qgis.core.QgsProcessingParameterGeometry

Bases: QgsProcessingParameterDefinition

A geometry parameter for processing algorithms.

New in version 3.16.

QgsProcessingParameterGeometry(name: str, description: str = ‘’, defaultValue: Any = None, optional: bool = False, geometryTypes: Iterable[int] = [], allowMultipart: bool = True) Constructor for QgsProcessingParameterGeometry.

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

QgsProcessingParameterGeometry(QgsProcessingParameterGeometry)

Methods

allowMultipart

Returns the parameter allow multipart geometries.

asPythonString

param outputType:

asScriptCode

rtype:

str

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

defaultGuiValueFromSetting

Default gui value for an algorithm parameter from settings

fromScriptCode

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

fromVariantMap

param map:

geometryTypes

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

setAllowMultipart

Sets the allow multipart geometries

setGeometryTypes

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

toVariantMap

rtype:

Dict[str, Any]

type

rtype:

str

typeName

Returns the type name for the parameter class.

valueAsPythonString

param value:
allowMultipart(self) → bool

Returns the parameter allow multipart geometries.

See also

setAllowMultipart()

Return type:

bool

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

defaultGuiValueFromSetting(self) → Any

Default gui value for an algorithm parameter from settings

Returns:

default value from settings or invalid QVariant if there is no default value defined in the settings

New in version 3.34.

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 Qgis.GeometryType values.

See also

setGeometryTypes()

Return type:

List[int]

setAllowMultipart(self, allowMultipart: bool)

Sets the allow multipart geometries

See also

allowMultipart()

Parameters:

allowMultipart (bool) –

setGeometryTypes(self, geometryTypes: Iterable[int])

Sets the allowed geometryTypes, as a list of Qgis.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