Class: QgsProcessingParameterAggregate¶
- class qgis.core.QgsProcessingParameterAggregate¶
Bases:
QgsProcessingParameterDefinition
A parameter for “aggregate” configurations, which consist of a definition of desired output fields, types, and aggregate used to populate then.
Designed for use with the “Aggregate” algorithm.
New in version 3.14.
QgsProcessingParameterAggregate(name: str, description: str = ‘’, parentLayerParameterName: str = ‘’, optional: bool = False) Constructor for QgsProcessingParameterAggregate.
QgsProcessingParameterAggregate(
QgsProcessingParameterAggregate
)Methods
- param outputType:
- param input:
- rtype:
QgsProcessingParameterDefinition
Default gui value for an algorithm parameter from settings
- rtype:
List[str]
- param map:
Returns the name of the parent layer parameter, or an empty string if this is not set.
Sets the
name
of the parent layer parameter.- rtype:
Dict[str, Any]
- rtype:
str
Returns the type name for the parameter class.
- param value:
- 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:
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
New in version 3.34.
- dependsOnOtherParameters(self) List[str] ¶
- Return type:
List[str]
- 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
- setParentLayerParameterName(self, name: str)¶
Sets the
name
of the parent layer parameter. Use an empty string if this is not required.See also
- Parameters:
name (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