Class: QgsProcessingParameterVectorLayer

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

Bases: qgis._core.QgsProcessingParameterDefinition, qgis._core.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: Methods

checkValueIsAcceptable
clone
fromScriptCode Creates a new parameter using the definition from a script code.
fromVariantMap
toVariantMap
type
typeName Returns the type name for the parameter class.
valueAsPythonString

Signals

Attributes

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
clone(self) → QgsProcessingParameterDefinition
fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterVectorLayer

Creates a new parameter using the definition from a script code.

fromVariantMap(self, map: Dict[str, Any]) → bool
toVariantMap(self) → Dict[str, Any]
type(self) → str
typeName() → str

Returns the type name for the parameter class.

valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str