Class: QgsProcessingParameterRasterDestination¶

A raster layer destination parameter, for specifying the destination path for a raster layer created by the algorithm.

Class Hierarchy¶

Base classes¶

`QgsProcessingDestinationParameter`	Base class for all parameter definitions which represent file or layer destinations, e.g. parameters which are used for the destination for layers output by an algorithm.
`QgsProcessingParameterDefinition`	Base class for the definition of processing parameters.
`QgsFileFilterGenerator`	Abstract interface for classes which generate a file filter string.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsProcessingParameterRasterDestination. See the FAQ for more details.

supportedOutputRasterLayerExtensions

Returns a list of the raster format file extensions supported for this 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.QgsProcessingParameterRasterDestination[source]¶

Bases: QgsProcessingDestinationParameter

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

Constructor for QgsProcessingParameterRasterDestination.

If createByDefault is False and the parameter is optional, then this destination output will not be created by default.

Parameters:

name (Optional[str])
description (Optional[str] = '')
defaultValue (Any = None)
optional (bool = False)
createByDefault (bool = True)

__init__(a0: QgsProcessingParameterRasterDestination)

Parameters:: a0 (QgsProcessingParameterRasterDestination)

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

virtual supportedOutputRasterLayerExtensions(self) → List[str][source]¶

Returns a list of the raster format file extensions supported for this parameter.