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:
QgsProcessingDestinationParameter
Constructor for QgsProcessingParameterFeatureSink.
If
createByDefault
is false and the parameter isoptional
, 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.
- Parameters
name (str) –
description (str = '') –
type (QgsProcessing.SourceType = QgsProcessing.TypeVectorAnyGeometry) –
defaultValue (Any = None) –
optional (bool = False) –
createByDefault –
-
asScriptCode
(self) → str¶ - Return type
str
-
checkValueIsAcceptable
(self, input: Any, context: QgsProcessingContext = None) → bool¶ - Parameters
input (Any) –
context (
QgsProcessingContext
= None) –
- Return type
bool
-
clone
(self) → QgsProcessingParameterDefinition¶ - Return type
-
dataType
(self) → QgsProcessing.SourceType¶ Returns the layer type for sinks associated with the parameter.
See also
- Return type
-
defaultFileExtension
(self) → str¶ - Return type
str
-
fromScriptCode
(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterFeatureSink¶ Creates a new parameter using the definition from a script code.
- Parameters
name (str) –
description (str) –
isOptional (bool) –
definition (str) –
- Return type
-
fromVariantMap
(self, map: Dict[str, Any]) → bool¶ - Parameters
map (Dict[str) –
- Return type
bool
-
generateTemporaryDestination
(self) → str¶ - Return type
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.
- Return type
bool
-
originalProvider
()¶
-
setDataType
(self, type: QgsProcessing.SourceType)¶ Sets the layer
type
for the sinks associated with the parameter.See also
- Parameters
type (QgsProcessing.SourceType) –
-
supportedOutputVectorLayerExtensions
(self) → List[str]¶ Returns a list of the vector format file extensions supported by this parameter.
See also
New in version 3.2.
- Return type
List[str]
-
toOutputDefinition
(self) → QgsProcessingOutputDefinition¶ - Return type
-
toVariantMap
(self) → Dict[str, Any]¶ - Return type
Dict[str, Any]
-
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
value (Any) –
context (QgsProcessingContext) –
- Return type
str