Class: QgsProcessingParameterMultipleLayers¶
- class qgis.core.QgsProcessingParameterMultipleLayers¶
Bases:
QgsProcessingParameterDefinition
,QgsFileFilterGenerator
A parameter for processing algorithms which accepts multiple map layers.
QgsProcessingParameterMultipleLayers(name: str, description: str = ‘’, layerType: Qgis.ProcessingSourceType = Qgis.ProcessingSourceType.VectorAnyGeometry, defaultValue: Any = None, optional: bool = False) Constructor for QgsProcessingParameterMultipleLayers.
QgsProcessingParameterMultipleLayers(
QgsProcessingParameterMultipleLayers
)Methods
- param outputType:
- rtype:
str
- param input:
- rtype:
QgsProcessingParameterDefinition
- rtype:
str
Default gui value for an algorithm parameter from settings
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:
- param value:
- param value:
- asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass) str ¶
- Parameters:
outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.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
- defaultGuiValueFromSetting(self) Any ¶
Default gui value for an algorithm parameter from settings
- Returns:
default value from settings or invalid QVariant if there is no default value defined in the settings
New in version 3.34.
- 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) Qgis.ProcessingSourceType ¶
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: Qgis.ProcessingSourceType)¶
Sets the layer
type
for layers acceptable by the parameter.See also
- Parameters:
type (Qgis.ProcessingSourceType) –
- 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
- valueAsJsonObject(self, value: Any, context: QgsProcessingContext) Any ¶
- Parameters:
value (Any) –
context (QgsProcessingContext) –
- Return type:
Any
- valueAsPythonString(self, value: Any, context: QgsProcessingContext) str ¶
- Parameters:
value (Any) –
context (QgsProcessingContext) –
- Return type:
str
- valueAsString(self, value: Any, context: QgsProcessingContext) Tuple[str, bool] ¶
- Parameters:
value (Any) –
context (QgsProcessingContext) –
- Return type:
Tuple[str, bool]