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

clone

dependsOnOtherParameters

fromScriptCode

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

fromVariantMap

parentLayerParameterName

Returns the name of the parent layer parameter, or an empty string if this is not set.

setParentLayerParameterName

Sets the name of the parent layer parameter.

toVariantMap

type

typeName

Returns the type name for the parameter class.

valueAsPythonString

Signals

Attributes

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.

setParentLayerParameterName(self, parentLayerParameterName: str)

Sets the name of the parent layer parameter. Use an empty string if this is not required.

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