Class: QgsProcessingParameterRasterDestination

class qgis.core.QgsProcessingParameterRasterDestination(name: str, description: str = '', defaultValue: Any = None, optional: bool = False, createByDefault: bool = True)

Bases: qgis._core.QgsProcessingDestinationParameter

Constructor for QgsProcessingParameterRasterDestination.

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

QgsProcessingParameterRasterDestination(QgsProcessingParameterRasterDestination)

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

New in version 3.0: Methods

checkValueIsAcceptable
clone
defaultFileExtension
fromScriptCode Creates a new parameter using the definition from a script code.
originalProvider
supportedOutputRasterLayerExtensions Returns a list of the raster format file extensions supported for this parameter.
toOutputDefinition
type
typeName Returns the type name for the parameter class.
valueAsPythonString

Signals

Attributes

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

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

originalProvider()
supportedOutputRasterLayerExtensions(self) → List[str]

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

New in version 3.2.

toOutputDefinition(self) → QgsProcessingOutputDefinition
type(self) → str
typeName() → str

Returns the type name for the parameter class.

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