Class: QgsProcessingParameterMultipleLayers

class qgis.core.QgsProcessingParameterMultipleLayers(name: str, description: str = '', layerType: QgsProcessing.SourceType = QgsProcessing.TypeVectorAnyGeometry, defaultValue: Any = None, optional: bool = False)

Bases: qgis._core.QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterMultipleLayers.

QgsProcessingParameterMultipleLayers(QgsProcessingParameterMultipleLayers)

A parameter for processing algorithms which accepts multiple map layers.

New in version 3.0: Enums

Methods

asScriptCode

checkValueIsAcceptable

clone

fromScriptCode

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

fromVariantMap

layerType

Returns the layer type for layers acceptable by the parameter.

minimumNumberInputs

Returns the minimum number of layers required for the parameter.

setLayerType

Sets the layer type for layers acceptable by the parameter.

setMinimumNumberInputs

Sets the minimum number of layers required for the parameter.

toVariantMap

type

typeName

Returns the type name for the parameter class.

valueAsPythonString

Signals

Attributes

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

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

fromVariantMap(self, map: Dict[str, Any]) → bool
layerType(self) → QgsProcessing.SourceType

Returns the layer type for layers acceptable by the parameter.

See also

setLayerType()

minimumNumberInputs(self) → int

Returns the minimum number of layers required for the parameter. If the return value is < 1 then the parameter accepts any number of layers.

setLayerType(self, type: QgsProcessing.SourceType)

Sets the layer type for layers acceptable by the parameter.

See also

layerType()

setMinimumNumberInputs(self, minimum: int)

Sets the minimum number of layers required for the parameter. The minimum must be >= 1 if the parameter is not optional.

toVariantMap(self) → Dict[str, Any]
type(self) → str
typeName() → str

Returns the type name for the parameter class.

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