Subgroup: Processing

Class: QgsProcessingParameterString¶

class qgis.core.QgsProcessingParameterString¶

Bases: qgis._core.QgsProcessingParameterDefinition

A string parameter for processing algorithms.

New in version 3.0: Methods

`algorithm`	Returns a pointer to the algorithm which owns this parameter.
`asScriptCode`
`checkValueIsAcceptable`	Checks whether the specified `input` value is acceptable for the parameter.
`clone`
`defaultValue`	Returns the default value for the parameter.
`dependsOnOtherParameters`	Returns a list of other parameter names on which this parameter is dependent (e.g.
`description`	Returns the description for the parameter.
`dynamicLayerParameterName`	Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set.
`dynamicPropertyDefinition`	Returns the property definition for dynamic properties.
`flags`	Returns any flags associated with the parameter.
`fromScriptCode`	Creates a new parameter using the definition from a script code.
`fromVariantMap`
`isDestination`	Returns true if this parameter represents a file or layer destination, e.g.
`isDynamic`	Returns true if the parameter supports is dynamic, and can support data-defined values (i.e.
`metadata`	Returns the parameter’s freeform metadata.
`multiLine`	Returns true if the parameter allows multiline strings.
`name`	Returns the name of the parameter.
`provider`	Returns a pointer to the provider for the algorithm which owns this parameter.
`setDefaultValue`	Sets the default `value` for the parameter.
`setDescription`	Sets the `description` for the parameter.
`setDynamicLayerParameterName`	Sets the `name` for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set.
`setDynamicPropertyDefinition`	Sets the property `definition` for dynamic properties.
`setFlags`	Sets the `flags` associated with the parameter.
`setIsDynamic`	Sets whether the parameter is `dynamic`, and can support data-defined values (i.e.
`setMetadata`	Sets the parameter’s freeform `metadata`.
`setMultiLine`	Sets whether the parameter allows multiline strings.
`setName`	Sets the `name` of the parameter.
`toVariantMap`
`toolTip`	Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type).
`type`
`typeName`	Returns the type name for the parameter class.
`valueAsPythonString`

Attributes

`FlagAdvanced`
`FlagHidden`
`FlagOptional`

asScriptCode(self) → str¶

clone(self) → QgsProcessingParameterDefinition¶

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterString¶: Creates a new parameter using the definition from a script code.

fromVariantMap(self, map: Dict[str, Any]) → bool¶

multiLine(self) → bool¶: Returns true if the parameter allows multiline strings.

See also

setMultiLine()

setMultiLine(self, multiLine: bool)¶: Sets whether the parameter allows multiline strings.

See also

multiLine()

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¶