Subgroup: Processing

Class: QgsProcessingParameterMapLayer

class qgis.core.QgsProcessingParameterMapLayer(name: str, description: str = '', defaultValue: Any = None, optional: bool = False)

Bases: qgis._core.QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterMapLayer.

QgsProcessingParameterMapLayer(QgsProcessingParameterMapLayer)

A map layer parameter for processing algorithms.

New in version 3.0: Methods

checkValueIsAcceptable
clone
fromScriptCode Creates a new parameter using the definition from a script code.
type
typeName Returns the type name for the parameter class.
valueAsPythonString

Signals

Attributes

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
clone(self) → QgsProcessingParameterDefinition
fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterMapLayer

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

type(self) → str
typeName() → str

Returns the type name for the parameter class.

valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str