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.

class qgis.core.QgsProcessingParameterRasterDestination

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)

defaultFileFormat(self) → str

Returns the default file format for destination file paths associated with this parameter.

Added in version 3.40.

Return type:

str

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

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]

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

See also

defaultFileExtension()

Deprecated since version 3.40: Use supportedOutputRasterLayerFormatAndExtensions() instead.

Return type:

List[str]

virtual supportedOutputRasterLayerFormatAndExtensions(self) → List[Tuple[str, str]]

Returns a list of (format, file extension) supported by this provider.

Added in version 3.40.

Return type:

List[Tuple[str, str]]

static typeName() → str

Returns the type name for the parameter class.

Return type:

str