Class: QgsProcessingParameterMultipleLayers

class qgis.core.QgsProcessingParameterMultipleLayers

Bases: QgsProcessingParameterDefinition, QgsFileFilterGenerator

A parameter for processing algorithms which accepts multiple map layers.

New in version 3.0.

QgsProcessingParameterMultipleLayers(name: str, description: str = ‘’, layerType: QgsProcessing.SourceType = QgsProcessing.TypeVectorAnyGeometry, defaultValue: Any = None, optional: bool = False) Constructor for QgsProcessingParameterMultipleLayers.

QgsProcessingParameterMultipleLayers(QgsProcessingParameterMultipleLayers)

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:

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

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) QgsProcessingParameterMultipleLayers

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

Parameters:
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type:

QgsProcessingParameterMultipleLayers

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

map (Dict[str) –

Return type:

bool

layerType(self) QgsProcessing.SourceType

Returns the layer type for layers acceptable by the parameter.

See also

setLayerType()

Return type:

QgsProcessing.SourceType

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.

Return type:

int

setLayerType(self, type: QgsProcessing.SourceType)

Sets the layer type for layers acceptable by the parameter.

See also

layerType()

Parameters:

type (QgsProcessing.SourceType) –

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.

Parameters:

minimum (int) –

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]