Class: QgsProcessingParameterExpression¶
-
class
qgis.core.
QgsProcessingParameterExpression
(name: str, description: str = '', defaultValue: Any = None, parentLayerParameterName: str = '', optional: bool = False)¶ Bases:
qgis._core.QgsProcessingParameterDefinition
Constructor for QgsProcessingParameterExpression.
QgsProcessingParameterExpression(QgsProcessingParameterExpression)
An expression parameter for processing algorithms.
New in version 3.0: Enums
Methods
Creates a new parameter using the definition from a script code.
Returns the name of the parent layer parameter, or an empty string if this is not set.
Sets the name of the parent layer parameter.
Returns the type name for the parameter class.
Signals
Attributes
-
asPythonString
(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str¶
-
clone
(self) → QgsProcessingParameterDefinition¶
-
dependsOnOtherParameters
(self) → List[str]¶
-
fromScriptCode
(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterExpression¶ Creates a new parameter using the definition from a script code.
-
fromVariantMap
(self, map: Dict[str, Any]) → bool¶
-
parentLayerParameterName
(self) → str¶ Returns the name of the parent layer parameter, or an empty string if this is not set.
See also
-
setParentLayerParameterName
(self, parentLayerParameterName: str)¶ Sets the name of the parent layer parameter. Use an empty string if this is not required.
See also
-
toVariantMap
(self) → Dict[str, Any]¶
-
type
(self) → str¶
-
typeName
() → str¶ Returns the type name for the parameter class.
-
valueAsPythonString
(self, value: Any, context: QgsProcessingContext) → str¶
-