Class: QgsProcessingParameterRasterLayer

A raster layer parameter for processing algorithms.

Class Hierarchy

Inheritance diagram of qgis.core.QgsProcessingParameterRasterLayer

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

QgsFileFilterGenerator

Abstract interface for classes which generate a file filter string.

Methods

parameterCapabilities

Returns flags containing the supported capabilities of the raster layer parameter.

setParameterCapabilities

Sets the supported capabilities of the raster layer parameter.

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

Bases: QgsProcessingParameterDefinition, QgsFileFilterGenerator

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

Constructor for QgsProcessingParameterRasterLayer.

Parameters:

  • name (Optional[str])

  • description (Optional[str] = '')

  • defaultValue (Any = None)

  • optional (bool = False)

__init__(a0: QgsProcessingParameterRasterLayer)
Parameters:

a0 (QgsProcessingParameterRasterLayer)

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

parameterCapabilities(self) → Qgis.RasterProcessingParameterCapabilities[source]

Returns flags containing the supported capabilities of the raster layer parameter.

Added in version 4.0.

Return type:

Qgis.RasterProcessingParameterCapabilities

setParameterCapabilities(self, capabilities: Qgis.RasterProcessingParameterCapabilities | Qgis.RasterProcessingParameterCapability)[source]

Sets the supported capabilities of the raster layer parameter.

Parameters:

capabilities (Union[Qgis.RasterProcessingParameterCapabilities, Qgis.RasterProcessingParameterCapability]) – Capabilities to be set to the raster layer parameter.

Added in version 4.0.

static typeName() → str[source]

Returns the type name for the parameter class.

Return type:

str