Subgroup: Processing

Class: QgsProcessingParameterMultipleLayers¶

class qgis.core.QgsProcessingParameterMultipleLayers¶

Bases: qgis._core.QgsProcessingParameterDefinition

A parameter for processing algorithms which accepts multiple map layers.

New in version 3.0: Methods

`algorithm`	Returns a pointer to the algorithm which owns this parameter.
`asScriptCode`
`checkValueIsAcceptable`
`clone`
`defaultValue`	Returns the default value for the parameter.
`dependsOnOtherParameters`	Returns a list of other parameter names on which this parameter is dependent (e.g.
`description`	Returns the description for the parameter.
`dynamicLayerParameterName`	Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set.
`dynamicPropertyDefinition`	Returns the property definition for dynamic properties.
`flags`	Returns any flags associated with the parameter.
`fromScriptCode`	Creates a new parameter using the definition from a script code.
`fromVariantMap`
`isDestination`	Returns true if this parameter represents a file or layer destination, e.g.
`isDynamic`	Returns true if the parameter supports is dynamic, and can support data-defined values (i.e.
`layerType`	Returns the layer type for layers acceptable by the parameter.
`metadata`	Returns the parameter’s freeform metadata.
`minimumNumberInputs`	Returns the minimum number of layers required for the parameter.
`name`	Returns the name of the parameter.
`provider`	Returns a pointer to the provider for the algorithm which owns this parameter.
`setDefaultValue`	Sets the default `value` for the parameter.
`setDescription`	Sets the `description` for the parameter.
`setDynamicLayerParameterName`	Sets the `name` for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set.
`setDynamicPropertyDefinition`	Sets the property `definition` for dynamic properties.
`setFlags`	Sets the `flags` associated with the parameter.
`setIsDynamic`	Sets whether the parameter is `dynamic`, and can support data-defined values (i.e.
`setLayerType`	Sets the layer `type` for layers acceptable by the parameter.
`setMetadata`	Sets the parameter’s freeform `metadata`.
`setMinimumNumberInputs`	Sets the `minimum` number of layers required for the parameter.
`setName`	Sets the `name` of the parameter.
`toVariantMap`
`toolTip`	Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type).
`type`
`typeName`	Returns the type name for the parameter class.
`valueAsPythonString`

Attributes

`FlagAdvanced`
`FlagHidden`
`FlagOptional`

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.

See also

setMinimumNumberInputs()

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.

See also

minimumNumberInputs()

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¶