Class: QgsProcessingParameterFeatureSource

An input feature source (such as vector layers) parameter for processing algorithms.

Class Hierarchy

Inheritance diagram of qgis.core.QgsProcessingParameterFeatureSource

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

QgsProcessingParameterLimitedDataTypes

Can be inherited by parameters which require limits to their acceptable data types.

QgsFileFilterGenerator

Abstract interface for classes which generate a file filter string.

Static Methods

fromScriptCode

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

typeName

Returns the type name for the parameter class.

class qgis.core.QgsProcessingParameterFeatureSource[source]

Bases: QgsProcessingParameterDefinition, QgsProcessingParameterLimitedDataTypes, QgsFileFilterGenerator

__init__(name: str | None, description: str | None = '', types: Iterable[int] = [], defaultValue: Any = None, optional: bool = False)

Constructor for QgsProcessingParameterFeatureSource.

Parameters:
  • name (Optional[str])

  • description (Optional[str] = '')

  • types (Iterable[int] = [])

  • defaultValue (Any = None)

  • optional (bool = False)

__init__(a0: QgsProcessingParameterFeatureSource)
Parameters:

a0 (QgsProcessingParameterFeatureSource)

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) QgsProcessingParameterFeatureSource | None[source]

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

Parameters:
  • name (Optional[str])

  • description (Optional[str])

  • isOptional (bool)

  • definition (Optional[str])

Return type:

Optional[QgsProcessingParameterFeatureSource]

static typeName() str[source]

Returns the type name for the parameter class.

Return type:

str