Class: QgsProcessingParameterVectorTileDestination¶

class qgis.core.QgsProcessingParameterVectorTileDestination¶

Bases: QgsProcessingDestinationParameter

A vector tile layer destination parameter, for specifying the destination path for a vector tile layer created by the algorithm.

Added in version 3.32.

QgsProcessingParameterVectorTileDestination(name: str, description: str = ‘’, defaultValue: Any = None, optional: bool = False, createByDefault: bool = True) Constructor for QgsProcessingParameterVectorTileDestination.

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

QgsProcessingParameterVectorTileDestination(QgsProcessingParameterVectorTileDestination)

Methods

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

createFileFilter

rtype:

str

defaultFileExtension

rtype:

str

defaultGuiValueFromSetting

Default gui value for an algorithm parameter from settings

fromScriptCode

Creates a new parameter using the definition from a script code.

originalProvider

Original (source) provider which this parameter has been derived from.

supportedOutputVectorTileLayerExtensions

Returns a list of the point cloud format file extensions supported for this parameter.

toOutputDefinition

rtype:

QgsProcessingOutputDefinition

type

rtype:

str

typeName

Returns the type name for the parameter class.

valueAsPythonString

param value:

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

Parameters:

input (Any)
context (QgsProcessingContext = None)

Return type:

bool

clone(self) → QgsProcessingParameterDefinition¶

Return type:: QgsProcessingParameterDefinition

createFileFilter(self) → str¶

Return type:: str

defaultFileExtension(self) → str¶

Return type:: str

defaultGuiValueFromSetting(self) → Any¶

Default gui value for an algorithm parameter from settings

Returns:: default value from settings or invalid QVariant if there is no default value defined in the settings

Added in version 3.34.

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterVectorTileDestination¶

Creates a new parameter using the definition from a script code.

Parameters:

name (str)
description (str)
isOptional (bool)
definition (str)

Return type:

QgsProcessingParameterVectorTileDestination

originalProvider(self) → QgsProcessingProvider¶: Original (source) provider which this parameter has been derived from. In the case of destination parameters which are part of model algorithms, this will reflect the child algorithm’s provider which actually generates the parameter, as opposed to the provider which this parameter belongs to (i.e. the model provider)

Added in version 3.2.

supportedOutputVectorTileLayerExtensions(self) → List[str]¶

Returns a list of the point cloud format file extensions supported for this parameter.