Class: QgsProcessingParameterFieldMapping

class qgis.core.QgsProcessingParameterFieldMapping

Bases: QgsProcessingParameterDefinition

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.

QgsProcessingParameterFieldMapping(name: str, description: str = ‘’, parentLayerParameterName: str = ‘’, optional: bool = False) Constructor for QgsProcessingParameterFieldMapping.

QgsProcessingParameterFieldMapping(QgsProcessingParameterFieldMapping)

Methods

asPythonString

param outputType:

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

defaultGuiValueFromSetting

Default gui value for an algorithm parameter from settings

dependsOnOtherParameters

rtype:

List[str]

fromVariantMap

param map:

parentLayerParameterName

Returns the name of the parent layer parameter, or an empty string if this is not set.

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:

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

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

Return type:

str

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

bool

clone(self) QgsProcessingParameterDefinition
Return type:

QgsProcessingParameterDefinition

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

New in version 3.34.

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