Class: QgsProcessingParameterGeometry¶
- class qgis.core.QgsProcessingParameterGeometry(name: str, description: str = '', defaultValue: Any = None, optional: bool = False, geometryTypes: Iterable[int] = [], allowMultipart: bool = True)¶
Bases:
QgsProcessingParameterDefinition
Constructor for QgsProcessingParameterGeometry.
The
geometryTypes
argument allows for specifying a list of geometry types (seeQgsWkbTypes
.GeometryType) acceptable for this parameter. Passing a empty list will allow for any type of geometry. TheallowMultiPart
argument allows specifying a multi part geometryQgsProcessingParameterGeometry(
QgsProcessingParameterGeometry
)A geometry parameter for processing algorithms.
Methods
Returns the parameter allow multipart geometries.
- param outputType
- rtype
str
- param input
- rtype
QgsProcessingParameterDefinition
Creates a new parameter using the definition from a script code.
- param map
Returns the parameter allowed geometries, as a list of
QgsWkbTypes
.GeometryType values.Sets the allow multipart geometries
Sets the allowed
geometryTypes
, as a list ofQgsWkbTypes
.GeometryType values.- rtype
Dict[str, Any]
- rtype
str
Returns the type name for the parameter class.
- param value
- allowMultipart(self) → bool¶
Returns the parameter allow multipart geometries.
See also
- 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
input (Any) –
context (
QgsProcessingContext
= None) –
- Return type
bool
- clone(self) → QgsProcessingParameterDefinition¶
- Return type
- 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
- 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
- Return type
List[int]
- setAllowMultipart(self, allowMultipart: bool)¶
Sets the allow multipart geometries
See also
- Parameters
allowMultipart (bool) –
- setGeometryTypes(self, geometryTypes: Iterable[int])¶
Sets the allowed
geometryTypes
, as a list ofQgsWkbTypes
.GeometryType values.See also
- 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
value (Any) –
context (QgsProcessingContext) –
- Return type
str