Class: QgsProcessingParameterVectorDestination¶
-
class
qgis.core.
QgsProcessingParameterVectorDestination
(name: str, description: str = '', type: QgsProcessing.SourceType = QgsProcessing.TypeVectorAnyGeometry, defaultValue: Any = None, optional: bool = False, createByDefault: bool = True)¶ Bases:
qgis._core.QgsProcessingDestinationParameter
Constructor for QgsProcessingParameterVectorDestination.
If
createByDefault
is false and the parameter isoptional
, then this destination output will not be created by default.QgsProcessingParameterVectorDestination(QgsProcessingParameterVectorDestination)
A vector layer destination parameter, for specifying the destination path for a vector layer created by the algorithm.
Note
Consider using the more flexible QgsProcessingParameterFeatureSink wherever possible.
New in version 3.0: Enums
Methods
Returns the layer type for this created vector layer.
Creates a new parameter using the definition from a script code.
Returns true if the created layer is likely to include geometries.
Sets the layer
type
for the created vector layer.Returns a list of the vector format file extensions supported by this parameter.
Returns the type name for the parameter class.
Signals
Attributes
-
asPythonString
(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str¶
-
asScriptCode
(self) → str¶
-
checkValueIsAcceptable
(self, input: Any, context: QgsProcessingContext = None) → bool¶
-
clone
(self) → QgsProcessingParameterDefinition¶
-
dataType
(self) → QgsProcessing.SourceType¶ Returns the layer type for this created vector layer.
See also
-
defaultFileExtension
(self) → str¶
-
fromScriptCode
(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterVectorDestination¶ Creates a new parameter using the definition from a script code.
-
fromVariantMap
(self, map: Dict[str, Any]) → bool¶
-
hasGeometry
(self) → bool¶ Returns true if the created layer 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 created vector layer.See also
-
supportedOutputVectorLayerExtensions
(self) → List[str]¶ Returns a list of the vector format file extensions supported by this parameter.
See also
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¶
-