Class: QgsProcessingParameterField

class qgis.core.QgsProcessingParameterField

Bases: QgsProcessingParameterDefinition

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

QgsProcessingParameterField(name: str, description: str = ‘’, defaultValue: Any = None, parentLayerParameterName: str = ‘’, type: Qgis.ProcessingFieldParameterDataType = Qgis.ProcessingFieldParameterDataType.Any, allowMultiple: bool = False, optional: bool = False, defaultToAllFields: bool = False) Constructor for QgsProcessingParameterField.

QgsProcessingParameterField(QgsProcessingParameterField)

Enums

DataType

alias of ProcessingFieldParameterDataType

Methods

allowMultiple	Returns whether multiple field selections are permitted.
asPythonString	param outputType:
asScriptCode	rtype: str
checkValueIsAcceptable	param input:
clone	rtype: QgsProcessingParameterDefinition
dataType	Returns the acceptable data type for the field.
defaultGuiValueFromSetting	Default gui value for an algorithm parameter from settings
defaultToAllFields	Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all fields as the default value.
dependsOnOtherParameters	rtype: List[str]
fromScriptCode	Creates a new parameter using the definition from a script code.
fromVariantMap	param map:
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.
setDefaultToAllFields	Sets whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all fields as the default value.
setParentLayerParameterName	Sets the name of the parent layer parameter.
toVariantMap	rtype: Dict[str, Any]
type	rtype: str
typeName	Returns the type name for the parameter class.
valueAsPythonString	param value:

DataType

alias of ProcessingFieldParameterDataType

allowMultiple(self) → bool

Returns whether multiple field selections are permitted.

See also

setAllowMultiple()

Return type:

bool

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

Parameters:

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass)

Return type:

str

asScriptCode(self) → str

Return type:

str

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

Parameters:

• input (Any)

• context (QgsProcessingContext = None)

Return type:

bool

clone(self) → QgsProcessingParameterDefinition

Return type:

QgsProcessingParameterDefinition

dataType(self) → Qgis.ProcessingFieldParameterDataType

Returns the acceptable data type for the field.

See also

setDataType()

Return type:

Qgis.ProcessingFieldParameterDataType

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.

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.

See also

setDefaultToAllFields()

Added 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.

See also

setParentLayerParameterName()

Return type:

str

setAllowMultiple(self, allowMultiple: bool)

Sets whether multiple field selections are permitted.

See also

allowMultiple()

Parameters:

allowMultiple (bool)

setDataType(self, type: Qgis.ProcessingFieldParameterDataType)

Sets the acceptable data type for the field.

See also

dataType()

Parameters:

type (Qgis.ProcessingFieldParameterDataType)

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.

See also

defaultToAllFields()

Added 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.

See also

parentLayerParameterName()

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