Subgroup: Processing

Class: QgsProcessingDestinationParameter

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

Bases: qgis._core.QgsProcessingParameterDefinition

Constructor for QgsProcessingDestinationParameter.

QgsProcessingDestinationParameter(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.

New in version 3.0: Methods

createByDefault Returns true if the destination should be created by default.
defaultFileExtension Returns the default file extension for destination file paths associated with this parameter.
fromVariantMap
generateTemporaryDestination Generates a temporary destination value for this parameter.
isDestination
setCreateByDefault Sets whether the destination should be created by default.
setSupportsNonFileBasedOutput Sets whether the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs.
supportsNonFileBasedOutput Returns true if the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs.
toOutputDefinition Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parameter.
toVariantMap

Signals

Attributes

createByDefault(self) → bool

Returns true if the destination should be created by default. For optional parameters, a return value of false indicates that the destination should not be created by default.

defaultFileExtension(self) → str

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

fromVariantMap(self, map: Dict[str, Any]) → bool
generateTemporaryDestination(self) → str

Generates a temporary destination value for this parameter. The returned value will be a file path or QGIS data provider URI suitable for temporary storage of created layers and files.

isDestination(self) → bool
setCreateByDefault(self, createByDefault: bool)

Sets whether the destination should be created by default. For optional parameters, a value of false indicates that the destination should not be created by default.

setSupportsNonFileBasedOutput(self, supportsNonFileBasedOutput: bool)

Sets whether the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs.

supportsNonFileBasedOutput(self) → bool

Returns true if the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs.

toOutputDefinition(self) → QgsProcessingOutputDefinition

Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parameter.

toVariantMap(self) → Dict[str, Any]