Subgroup: Processing
Class: QgsProcessingParameterFileDestination¶
-
class
qgis.core.
QgsProcessingParameterFileDestination
¶ Bases:
qgis._core.QgsProcessingDestinationParameter
A generic file based destination parameter, for specifying the destination path for a file (non-map layer) created by the algorithm.
New in version 3.0: Methods
algorithm
Returns a pointer to the algorithm which owns this parameter. asScriptCode
Returns the parameter definition encoded in a string which can be used within a Python processing script. checkValueIsAcceptable
clone
createByDefault
Returns true if the destination should be created by default. defaultFileExtension
defaultValue
Returns the default value for the parameter. dependsOnOtherParameters
Returns a list of other parameter names on which this parameter is dependent (e.g. description
Returns the description for the parameter. dynamicLayerParameterName
Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. dynamicPropertyDefinition
Returns the property definition for dynamic properties. fileFilter
Returns the file filter string for file destinations compatible with this parameter. flags
Returns any flags associated with the parameter. fromScriptCode
Creates a new parameter using the definition from a script code. fromVariantMap
generateTemporaryDestination
Generates a temporary destination value for this parameter. isDestination
isDynamic
Returns true if the parameter supports is dynamic, and can support data-defined values (i.e. metadata
Returns the parameter’s freeform metadata. name
Returns the name of the parameter. provider
Returns a pointer to the provider for the algorithm which owns this parameter. setCreateByDefault
Sets whether the destination should be created by default. setDefaultValue
Sets the default value
for the parameter.setDescription
Sets the description
for the parameter.setDynamicLayerParameterName
Sets the name
for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set.setDynamicPropertyDefinition
Sets the property definition
for dynamic properties.setFileFilter
Sets the file filter
string for file destinations compatible with this parameter.setFlags
Sets the flags
associated with the parameter.setIsDynamic
Sets whether the parameter is dynamic
, and can support data-defined values (i.e.setMetadata
Sets the parameter’s freeform metadata
.setName
Sets the name
of the parameter.setSupportsNonFileBasedOutputs
Sets whether the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs. supportsNonFileBasedOutputs
Returns true if the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs. toOutputDefinition
toVariantMap
toolTip
Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type). type
typeName
Returns the type name for the parameter class. valueAsPythonString
Attributes
FlagAdvanced
FlagHidden
FlagOptional
-
checkValueIsAcceptable
(self, input: Any, context: QgsProcessingContext = None) → bool¶
-
clone
(self) → QgsProcessingParameterDefinition¶
-
defaultFileExtension
(self) → str¶
-
fileFilter
(self) → str¶ Returns the file filter string for file destinations compatible with this parameter.
See also
-
fromScriptCode
(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterFileDestination¶ Creates a new parameter using the definition from a script code.
-
fromVariantMap
(self, map: Dict[str, Any]) → bool¶
-
setFileFilter
(self, filter: str)¶ Sets the file
filter
string for file destinations compatible with this parameter.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¶
-