Class: QgsProcessingParameterTinInputLayers

class qgis.core.QgsProcessingParameterTinInputLayers

Bases: QgsProcessingParameterDefinition

A parameter for processing algorithms that need a list of input vector layers to construct a TIN.

A valid value for this parameter is a list (QVariantList), where each item is a map (QVariantMap) in this form: { ‘source’: string that represents identification of the vector layer, ‘type’: how the vector layer is used : as vertices, structure lines or break lines ‘attributeIndex’ : the index of the attribute of the vector layer used to defined the Z value of vertices, if -1, the Z coordinates of features are used }

Added in version 3.16.

QgsProcessingParameterTinInputLayers(name: str, description: str = ‘’) Constructor

QgsProcessingParameterTinInputLayers(QgsProcessingParameterTinInputLayers)

Enums

Type

alias of ProcessingTinInputLayerType

Methods

asPythonString

param outputType:

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

defaultGuiValueFromSetting

Default gui value for an algorithm parameter from settings

type

rtype:

str

typeName

Returns the type name for the parameter class.

valueAsJsonObject

param value:

valueAsPythonString

param value:

valueAsString

param value:

class InputLayer
class InputLayer(QgsProcessingParameterTinInputLayers.InputLayer)

Bases: sip.wrapper

attributeIndex
source
type
Type

alias of ProcessingTinInputLayerType

asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass) str
Parameters:

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass)

Return type:

str

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) bool
Parameters:
Return type:

bool

clone(self) QgsProcessingParameterDefinition
Return type:

QgsProcessingParameterDefinition

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.

type(self) str
Return type:

str

typeName() str

Returns the type name for the parameter class.

Return type:

str

valueAsJsonObject(self, value: Any, context: QgsProcessingContext) Any
Parameters:
Return type:

Any

valueAsPythonString(self, value: Any, context: QgsProcessingContext) str
Parameters:
Return type:

str

valueAsString(self, value: Any, context: QgsProcessingContext) Tuple[str, bool]
Parameters:
Return type:

Tuple[str, bool]