Class: QgsProcessingParameterExpression¶
- class qgis.core.QgsProcessingParameterExpression¶
Bases:
QgsProcessingParameterDefinition
An expression parameter for processing algorithms.
QgsProcessingParameterExpression(name: str, description: str = ‘’, defaultValue: Any = None, parentLayerParameterName: str = ‘’, optional: bool = False, type: Qgis.ExpressionType = Qgis.ExpressionType.Qgis) Constructor for QgsProcessingParameterExpression.
QgsProcessingParameterExpression(
QgsProcessingParameterExpression
)Methods
- param outputType:
- rtype:
QgsProcessingParameterDefinition
Default gui value for an algorithm parameter from settings
- rtype:
List[str]
Returns the parameter's expression type.
Creates a new parameter using the definition from a script code.
- param map:
Returns the name of the parent layer parameter, or an empty string if this is not set.
Sets the parameter's expression
type
.Sets the name of the parent layer parameter.
- rtype:
Dict[str, Any]
- rtype:
str
Returns the type name for the parameter class.
- param value:
- asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass) str ¶
- Parameters:
outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass)
- Return type:
str
- clone(self) QgsProcessingParameterDefinition ¶
- Return type:
- 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
Added in version 3.34.
- dependsOnOtherParameters(self) List[str] ¶
- Return type:
List[str]
- expressionType(self) Qgis.ExpressionType ¶
Returns the parameter’s expression type.
See also
Added in version 3.32.
- Return type:
- fromScriptCode(name: str, description: str, isOptional: bool, definition: str) QgsProcessingParameterExpression ¶
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
- parentLayerParameterName(self) str ¶
Returns the name of the parent layer parameter, or an empty string if this is not set.
See also
- Return type:
str
- setExpressionType(self, type: Qgis.ExpressionType)¶
Sets the parameter’s expression
type
.See also
Added in version 3.32.
- Parameters:
type (Qgis.ExpressionType)
- setParentLayerParameterName(self, parentLayerParameterName: str)¶
Sets the name of the parent layer parameter. Use an empty string if this is not required.
See also
- Parameters:
parentLayerParameterName (str)
- 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