Class: QgsProcessingParameterVectorLayer¶
- class qgis.core.QgsProcessingParameterVectorLayer(name: str, description: str = '', types: Iterable[int] = [], defaultValue: Any = None, optional: bool = False)¶
Bases:
QgsProcessingParameterDefinition
,QgsProcessingParameterLimitedDataTypes
,QgsFileFilterGenerator
Constructor for QgsProcessingParameterVectorLayer.
QgsProcessingParameterVectorLayer(
QgsProcessingParameterVectorLayer
)A vector layer (with or without geometry) parameter for processing algorithms. Consider using the more versatile
QgsProcessingParameterFeatureSource
wherever possible.Methods
- param outputType
- param input
- rtype
QgsProcessingParameterDefinition
- rtype
str
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
- asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str¶
- Parameters
outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) –
- 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) → QgsProcessingParameterVectorLayer¶
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
- valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str¶
- Parameters
value (Any) –
context (QgsProcessingContext) –
- Return type
str