Class: QgsProcessingParameterMultipleLayers¶
- class qgis.core.QgsProcessingParameterMultipleLayers(name: str, description: str = '', layerType: QgsProcessing.SourceType = QgsProcessing.TypeVectorAnyGeometry, defaultValue: Any = None, optional: bool = False)¶
Bases:
QgsProcessingParameterDefinition
,QgsFileFilterGenerator
Constructor for QgsProcessingParameterMultipleLayers.
QgsProcessingParameterMultipleLayers(
QgsProcessingParameterMultipleLayers
)A parameter for processing algorithms which accepts multiple map layers.
Methods
- param outputType
- rtype
str
- param input
- rtype
QgsProcessingParameterDefinition
- rtype
str
Creates a new parameter using the definition from a script code.
- param map
Returns the layer type for layers acceptable by the parameter.
Returns the minimum number of layers required for the parameter.
Sets the layer
type
for layers acceptable by the parameter.Sets the
minimum
number of layers required for the parameter.- rtype
Dict[str, Any]
- rtype
str
Returns the type name for the parameter class.
- 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
input (Any) –
context (
QgsProcessingContext
= None) –
- Return type
bool
- clone(self) → QgsProcessingParameterDefinition¶
- Return type
- 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
- 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
- Return type
- 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
- Return type
int
- setLayerType(self, type: QgsProcessing.SourceType)¶
Sets the layer
type
for layers acceptable by the parameter.See also
- 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.See also
- 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
- valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str¶
- Parameters
value (Any) –
context (QgsProcessingContext) –
- Return type
str