Subgroup: Processing
Class: QgsProcessingParameterVectorDestination¶
-
class
qgis.core.
QgsProcessingParameterVectorDestination
(name: str, description: str = '', type: QgsProcessing.SourceType = QgsProcessing.TypeVectorAnyGeometry, defaultValue: Any = None, optional: bool = False)¶ Bases:
qgis._core.QgsProcessingDestinationParameter
Constructor for QgsProcessingParameterVectorDestination.
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: Methods
asScriptCode
checkValueIsAcceptable
clone
dataType
Returns the layer type for this created vector layer. defaultFileExtension
fromScriptCode
Creates a new parameter using the definition from a script code. fromVariantMap
hasGeometry
Returns true if the created layer is likely to include geometries. setDataType
Sets the layer type
for the created vector layer.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 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.
-
setDataType
(self, type: QgsProcessing.SourceType)¶ Sets the layer
type
for the created vector layer.See also
-
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¶
-