Class: QgsProcessingParameterMapLayer¶
- class qgis.core.QgsProcessingParameterMapLayer¶
Bases:
QgsProcessingParameterDefinition
,QgsProcessingParameterLimitedDataTypes
,QgsFileFilterGenerator
A map layer parameter for processing algorithms.
New in version 3.0.
QgsProcessingParameterMapLayer(name: str, description: str = ‘’, defaultValue: Any = None, optional: bool = False, types: Iterable[int] = []) Constructor for QgsProcessingParameterMapLayer.
QgsProcessingParameterMapLayer(
QgsProcessingParameterMapLayer
)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:
- 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.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
- 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) QgsProcessingParameterMapLayer ¶
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
- 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]