Class: QgsProcessingParameterPointCloudAttribute

class qgis.core.QgsProcessingParameterPointCloudAttribute

Bases: QgsProcessingParameterDefinition

A point cloud layer attribute parameter for Processing algorithms.

New in version 3.32.

QgsProcessingParameterPointCloudAttribute(name: str, description: str = ‘’, defaultValue: Any = None, parentLayerParameterName: str = ‘’, allowMultiple: bool = False, optional: bool = False, defaultToAllAttributes: bool = False) Constructor for QgsProcessingParameterField.

QgsProcessingParameterPointCloudAttribute(QgsProcessingParameterPointCloudAttribute)

Methods

allowMultiple

Returns whether multiple field selections are permitted.

asPythonString

param outputType:

asScriptCode

rtype:

str

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

defaultGuiValueFromSetting

Default gui value for an algorithm parameter from settings

defaultToAllAttributes

Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all attributes as the default value.

dependsOnOtherParameters

rtype:

List[str]

fromScriptCode

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

fromVariantMap

param map:

parentLayerParameterName

Returns the name of the parent layer parameter, or an empty string if this is not set.

setAllowMultiple

Sets whether multiple field selections are permitted.

setDefaultToAllAttributes

Sets whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all attributes as the default value.

setParentLayerParameterName

Sets the name of the parent layer parameter.

toVariantMap

rtype:

Dict[str, Any]

type

rtype:

str

typeName

Returns the type name for the parameter class.

valueAsPythonString

param value:

allowMultiple(self) bool

Returns whether multiple field selections are permitted.

Return type:

bool

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

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

Return type:

str

asScriptCode(self) str
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

New in version 3.34.

defaultToAllAttributes(self) bool

Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all attributes as the default value.

If True, this will override any existing defaultValue() set on the parameter.

Return type:

bool

dependsOnOtherParameters(self) List[str]
Return type:

List[str]

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) QgsProcessingParameterPointCloudAttribute

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

Parameters:
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type:

QgsProcessingParameterPointCloudAttribute

fromVariantMap(self, map: Dict[str, Any]) bool
Parameters:

map (Dict[str) –

Return type:

bool

parentLayerParameterName(self) str

Returns the name of the parent layer parameter, or an empty string if this is not set.

Return type:

str

setAllowMultiple(self, allowMultiple: bool)

Sets whether multiple field selections are permitted.

See also

allowMultiple()

Parameters:

allowMultiple (bool) –

setDefaultToAllAttributes(self, enabled: bool)

Sets whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all attributes as the default value.

If True, this will override any existing defaultValue() set on the parameter.

Parameters:

enabled (bool) –

setParentLayerParameterName(self, parentLayerParameterName: str)

Sets the name of the parent layer parameter. Use an empty string if this is not required.

Parameters:

parentLayerParameterName (str) –

toVariantMap(self) Dict[str, Any]
Return type:

Dict[str, Any]

type(self) str
Return type:

str

typeName() str

Returns the type name for the parameter class.

Return type:

str

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

str