Class: QgsProcessingParameterField¶

class qgis.core.QgsProcessingParameterField(name: str, description: str = '', defaultValue: Any = None, parentLayerParameterName: str = '', type: QgsProcessingParameterField.DataType = QgsProcessingParameterField.Any, allowMultiple: bool = False, optional: bool = False)¶

Bases: qgis._core.QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterField.

QgsProcessingParameterField(QgsProcessingParameterField)

A vector layer or feature source field parameter for processing algorithms.

New in version 3.0: Enums

Methods

`allowMultiple`	Returns whether multiple field selections are permitted.
`asPythonString`
`asScriptCode`
`checkValueIsAcceptable`
`clone`
`dataType`	Returns the acceptable data type for the field.
`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.
`setAllowMultiple`	Sets whether multiple field selections are permitted.
`setDataType`	Sets the acceptable data `type` for the field.
`setParentLayerParameterName`	Sets the name of the parent layer parameter.
`toVariantMap`
`type`
`typeName`	Returns the type name for the parameter class.
`valueAsPythonString`

Signals

Attributes

`Any`
`DateTime`
`Numeric`
`String`

Any = -1¶

class DataType¶: Bases: int

DateTime = 2¶

Numeric = 0¶

String = 1¶

allowMultiple(self) → bool¶: Returns whether multiple field selections are permitted.

See also

setAllowMultiple()

asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str¶

asScriptCode(self) → str¶

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool¶

clone(self) → QgsProcessingParameterDefinition¶

dataType(self) → QgsProcessingParameterField.DataType¶: Returns the acceptable data type for the field.

See also

setDataType()

dependsOnOtherParameters(self) → List[str]¶

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterField¶: 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()

setAllowMultiple(self, allowMultiple: bool)¶: Sets whether multiple field selections are permitted.

See also

allowMultiple()

setDataType(self, type: QgsProcessingParameterField.DataType)¶: Sets the acceptable data type for the field.

See also

dataType()

setParentLayerParameterName(self, parentLayerParameterName: str)¶: Sets the name of the parent layer parameter. Use an empty string if this is not required.

See also

parentLayerParameterName()

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¶