Class: QgsProcessingParameterAnnotationLayer

An annotation layer parameter for processing algorithms.

Added in version 3.22.

Class Hierarchy

Inheritance diagram of qgis.core.QgsProcessingParameterAnnotationLayer

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

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.QgsProcessingParameterAnnotationLayer[source]

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '', defaultValue: Any = None, optional: bool = False)

Constructor for QgsProcessingParameterAnnotationLayer.

Parameters:

  • name (Optional[str])

  • description (Optional[str] = '')

  • defaultValue (Any = None)

  • optional (bool = False)

__init__(a0: QgsProcessingParameterAnnotationLayer)
Parameters:

a0 (QgsProcessingParameterAnnotationLayer)

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterAnnotationLayer | 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[QgsProcessingParameterAnnotationLayer]

static typeName() → str[source]

Returns the type name for the parameter class.

Return type:

str