Class: QgsProcessingParameterVectorLayer

class qgis.core.QgsProcessingParameterVectorLayer(name: str, description: str = '', types: Iterable[int] = [], defaultValue: Any = None, optional: bool = False)

Bases: QgsProcessingParameterDefinition, QgsProcessingParameterLimitedDataTypes

Constructor for QgsProcessingParameterVectorLayer.

QgsProcessingParameterVectorLayer(QgsProcessingParameterVectorLayer)

A vector layer (with or without geometry) parameter for processing algorithms. Consider using the more versatile QgsProcessingParameterFeatureSource wherever possible.

New in version 3.0.

Parameters
  • name (str) –

  • description (str = '') –

  • types (Iterable[int] = []) –

  • defaultValue (Any = None) –

  • optional

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
Return type

bool

clone(self) → QgsProcessingParameterDefinition
Return type

QgsProcessingParameterDefinition

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

QgsProcessingParameterVectorLayer

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
Return type

str