Class: QgsProcessingParameterPointCloudAttribute¶
- class qgis.core.QgsProcessingParameterPointCloudAttribute¶
Bases:
QgsProcessingParameterDefinition
A point cloud layer attribute parameter for Processing algorithms.
Added 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
Returns whether multiple field selections are permitted.
- param outputType:
- rtype:
str
- param input:
- rtype:
QgsProcessingParameterDefinition
Default gui value for an algorithm parameter from settings
Returns whether a parameter which allows multiple selections (see
allowMultiple()
) should automatically select all attributes as the default value.- rtype:
List[str]
Creates a new parameter using the definition from a script code.
- param map:
Returns the name of the parent layer parameter, or an empty string if this is not set.
Sets whether multiple field selections are permitted.
Sets whether a parameter which allows multiple selections (see
allowMultiple()
) should automatically select all attributes as the default value.Sets the name of the parent layer parameter.
- rtype:
Dict[str, Any]
- rtype:
str
Returns the type name for the parameter class.
- param value:
- allowMultiple(self) bool ¶
Returns whether multiple field selections are permitted.
See also
- 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:
input (Any)
context (
QgsProcessingContext
= None)
- Return type:
bool
- clone(self) QgsProcessingParameterDefinition ¶
- Return type:
- 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.
- 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 existingdefaultValue()
set on the parameter.See also
- 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:
- 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.
See also
- Return type:
str
- setAllowMultiple(self, allowMultiple: bool)¶
Sets whether multiple field selections are permitted.
See also
- 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 existingdefaultValue()
set on the parameter.See also
- Parameters:
enabled (bool)
- setParentLayerParameterName(self, parentLayerParameterName: str)¶
Sets the name of the parent layer parameter. Use an empty string if this is not required.
See also
- 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:
value (Any)
context (QgsProcessingContext)
- Return type:
str