Class: QgsProcessingParameterFieldMapping

class qgis.core.QgsProcessingParameterFieldMapping(name: str, description: str = '', parentLayerParameterName: str = '', optional: bool = False)

Bases: QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterFieldMapping.

QgsProcessingParameterFieldMapping(QgsProcessingParameterFieldMapping)

A parameter for “field mapping” configurations, which consist of a definition of desired output fields, types, and expressions used to populate then.

Designed for use with the “Refactor fields” algorithm.

New in version 3.14.

Parameters
  • name (str) –

  • description (str = '') –

  • parentLayerParameterName (str = '') –

  • optional

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

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) –

Return type

str

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

bool

clone(self)QgsProcessingParameterDefinition
Return type

QgsProcessingParameterDefinition

dependsOnOtherParameters(self) → List[str]
Return type

List[str]

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

setParentLayerParameterName(self, name: str)

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

Parameters

name (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