Class: QgsProcessingParameterRasterDestination

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

Bases: 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.

Parameters

  • name (str) –

  • description (str = '') –

  • defaultValue (Any = None) –

  • optional (bool = False) –

  • createByDefault –

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
Parameters
Return type

bool

clone(self) → QgsProcessingParameterDefinition
Return type

QgsProcessingParameterDefinition

defaultFileExtension(self) → str
Return type

str

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterRasterDestination

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

Parameters

  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type

QgsProcessingParameterRasterDestination

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

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

See also

defaultFileExtension()

New in version 3.2.

Return type

List[str]

toOutputDefinition(self) → QgsProcessingOutputDefinition
Return type

QgsProcessingOutputDefinition

type(self) → str
Return type

str

typeName() → str

Returns the type name for the parameter class.

Return type

str

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

str