Subgroup: Processing

Class: QgsProcessingParameterFeatureSink¶

class qgis.core.QgsProcessingParameterFeatureSink(name: str, description: str = '', type: QgsProcessing.SourceType = QgsProcessing.TypeVectorAnyGeometry, defaultValue: Any = None, optional: bool = False, createByDefault: bool = True)¶

Bases: qgis._core.QgsProcessingDestinationParameter

Constructor for QgsProcessingParameterFeatureSink.

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

QgsProcessingParameterFeatureSink(QgsProcessingParameterFeatureSink)

A feature sink output for processing algorithms.

A parameter which represents the destination feature sink for features created by an algorithm.

New in version 3.0: Methods

`asScriptCode`
`checkValueIsAcceptable`
`clone`
`dataType`	Returns the layer type for sinks associated with the parameter.
`defaultFileExtension`
`fromScriptCode`	Creates a new parameter using the definition from a script code.
`fromVariantMap`
`generateTemporaryDestination`
`hasGeometry`	Returns true if sink is likely to include geometries.
`originalProvider`
`setDataType`	Sets the layer `type` for the sinks associated with the parameter.
`supportedOutputVectorLayerExtensions`	Returns a list of the vector format file extensions supported by this parameter.
`toOutputDefinition`
`toVariantMap`
`type`
`typeName`	Returns the type name for the parameter class.
`valueAsPythonString`

Signals

Attributes

asScriptCode(self) → str¶

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool¶

clone(self) → QgsProcessingParameterDefinition¶

dataType(self) → QgsProcessing.SourceType¶: Returns the layer type for sinks associated with the parameter.

See also

setDataType()

defaultFileExtension(self) → str¶

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterFeatureSink¶: Creates a new parameter using the definition from a script code.

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

generateTemporaryDestination(self) → str¶

hasGeometry(self) → bool¶: Returns true if sink is likely to include geometries. In cases were presence of geometry cannot be reliably determined in advance, this method will default to returning true.

originalProvider()¶

setDataType(self, type: QgsProcessing.SourceType)¶: Sets the layer type for the sinks associated with the parameter.

See also

dataType()

supportedOutputVectorLayerExtensions(self) → List[str]¶: Returns a list of the vector format file extensions supported by this parameter.

See also

defaultFileExtension()

New in version 3.2.

toOutputDefinition(self) → QgsProcessingOutputDefinition¶

toVariantMap(self) → Dict[str, Any]¶

type(self) → str¶

typeName() → str¶: Returns the type name for the parameter class.

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