Class: QgsProcessingParameterMapLayer

class qgis.core.QgsProcessingParameterMapLayer

Bases: QgsProcessingParameterDefinition, QgsProcessingParameterLimitedDataTypes, QgsFileFilterGenerator

A map layer parameter for processing algorithms.

New in version 3.0.

QgsProcessingParameterMapLayer(name: str, description: str = ‘’, defaultValue: Any = None, optional: bool = False, types: Iterable[int] = []) Constructor for QgsProcessingParameterMapLayer.

QgsProcessingParameterMapLayer(QgsProcessingParameterMapLayer)

Methods

asPythonString

param outputType

asScriptCode

rtype

str

checkValueIsAcceptable

param input

clone

rtype

QgsProcessingParameterDefinition

createFileFilter

rtype

str

fromScriptCode

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

fromVariantMap

param map

toVariantMap

rtype

Dict[str, Any]

type

rtype

str

typeName

Returns the type name for the parameter class.

valueAsJsonObject

param value

valueAsPythonString

param value

valueAsString

param value

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

createFileFilter(self) str
Return type

str

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) QgsProcessingParameterMapLayer

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

Parameters
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type

QgsProcessingParameterMapLayer

fromVariantMap(self, map: Dict[str, Any]) bool
Parameters

map (Dict[str) –

Return type

bool

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

valueAsJsonObject(self, value: Any, context: QgsProcessingContext) Any
Parameters
Return type

Any

valueAsPythonString(self, value: Any, context: QgsProcessingContext) str
Parameters
Return type

str

valueAsString(self, value: Any, context: QgsProcessingContext) Tuple[str, bool]
Parameters
Return type

Tuple[str, bool]