Class: QgsProcessingParameterField¶
- class qgis.core.QgsProcessingParameterField¶
Bases:
QgsProcessingParameterDefinition
A vector layer or feature source field parameter for processing algorithms.
New in version 3.0.
QgsProcessingParameterField(name: str, description: str = ‘’, defaultValue: Any = None, parentLayerParameterName: str = ‘’, type: QgsProcessingParameterField.DataType = QgsProcessingParameterField.Any, allowMultiple: bool = False, optional: bool = False, defaultToAllFields: bool = False) Constructor for QgsProcessingParameterField.
QgsProcessingParameterField(
QgsProcessingParameterField
)Methods
Returns whether multiple field selections are permitted.
- param outputType:
- rtype:
str
- param input:
- rtype:
QgsProcessingParameterDefinition
Returns the acceptable data type for the field.
Returns whether a parameter which allows multiple selections (see
allowMultiple()
) should automatically select all fields 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 the acceptable data
type
for the field.Sets whether a parameter which allows multiple selections (see
allowMultiple()
) should automatically select all fields 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:
Attributes
- Any = -1¶
- class DataType¶
Bases:
int
- DateTime = 2¶
- Numeric = 0¶
- String = 1¶
- allowMultiple(self) bool ¶
Returns whether multiple field selections are permitted.
See also
- Return type:
bool
- asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) str ¶
- Parameters:
outputType (QgsProcessing.PythonOutputType = QgsProcessing.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:
- dataType(self) QgsProcessingParameterField.DataType ¶
Returns the acceptable data type for the field.
See also
- Return type:
- defaultToAllFields(self) bool ¶
Returns whether a parameter which allows multiple selections (see
allowMultiple()
) should automatically select all fields as the default value.If
True
, this will override any existingdefaultValue()
set on the parameter.See also
New in version 3.12.
- Return type:
bool
- dependsOnOtherParameters(self) List[str] ¶
- Return type:
List[str]
- fromScriptCode(name: str, description: str, isOptional: bool, definition: str) QgsProcessingParameterField ¶
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) –
- setDataType(self, type: QgsProcessingParameterField.DataType)¶
Sets the acceptable data
type
for the field.See also
- Parameters:
type (QgsProcessingParameterField.DataType) –
- setDefaultToAllFields(self, enabled: bool)¶
Sets whether a parameter which allows multiple selections (see
allowMultiple()
) should automatically select all fields as the default value.If
True
, this will override any existingdefaultValue()
set on the parameter.See also
New in version 3.12.
- 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