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, defaultToAllFields: bool = False)

Bases: QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterField.

QgsProcessingParameterField(QgsProcessingParameterField)

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

New in version 3.0.

Parameters
  • name (str) –

  • description (str = '') –

  • defaultValue (Any = None) –

  • parentLayerParameterName (str = '') –

  • type (QgsProcessingParameterField.DataType = QgsProcessingParameterField.Any) –

  • allowMultiple (bool = False) –

  • optional (bool = False) –

  • defaultToAllFields

Any = -1
class DataType

Bases: int

DateTime = 2
Numeric = 0
String = 1
allowMultiple(self) → bool

Returns whether multiple field selections are permitted.

Return type

bool

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

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) –

Return type

str

asScriptCode(self) → str
Return type

str

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
Parameters
Return type

bool

clone(self) → QgsProcessingParameterDefinition
Return type

QgsProcessingParameterDefinition

dataType(self) → QgsProcessingParameterField.DataType

Returns the acceptable data type for the field.

See also

setDataType()

Return type

QgsProcessingParameterField.DataType

defaultToAllFields(self) → bool

Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all fields as the default value.

If True, this will override any existing defaultValue() set on the parameter.

New in version 3.12.

Return type

bool

dependsOnOtherParameters(self) → List[str]
Return type

List[str]

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterField

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

Parameters
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type

QgsProcessingParameterField

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.

Return type

str

setAllowMultiple(self, allowMultiple: bool)

Sets whether multiple field selections are permitted.

See also

allowMultiple()

Parameters

allowMultiple (bool) –

setDataType(self, type: QgsProcessingParameterField.DataType)

Sets the acceptable data type for the field.

See also

dataType()

Parameters

type (QgsProcessingParameterField.DataType) –

setDefaultToAllFields(self, enabled: bool)

Sets whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all fields as the default value.

If True, this will override any existing defaultValue() set on the parameter.

New in version 3.12.

Parameters

enabled (bool) –

setParentLayerParameterName(self, parentLayerParameterName: str)

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

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
Return type

str