Class: QgsProcessingParameterBand¶
- class qgis.core.QgsProcessingParameterBand(name: str, description: str = '', defaultValue: Any = None, parentLayerParameterName: str = '', optional: bool = False, allowMultiple: bool = False)¶
Bases:
QgsProcessingParameterDefinition
Constructor for QgsProcessingParameterBand.
QgsProcessingParameterBand(
QgsProcessingParameterBand
)A raster band parameter for Processing algorithms.
New in version 3.0:
Methods
Returns whether multiple band selections are permitted.
- param outputType
- rtype
str
- param input
- rtype
QgsProcessingParameterDefinition
- 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 band selections are permitted.
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 band selections are permitted.
See also
New in version 3.4.
- 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
- dependsOnOtherParameters(self) List[str] ¶
- Return type
List[str]
- fromScriptCode(name: str, description: str, isOptional: bool, definition: str) QgsProcessingParameterBand ¶
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 band selections are permitted.
See also
New in version 3.4.
- Parameters
allowMultiple (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