Class: QgsProcessingParameterBand

class qgis.core.QgsProcessingParameterBand

Bases: QgsProcessingParameterDefinition

A raster band parameter for Processing algorithms.

New in version 3.0.

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

QgsProcessingParameterBand(QgsProcessingParameterBand)

Methods

allowMultiple

Returns whether multiple band selections are permitted.

asPythonString

param outputType:

asScriptCode

rtype:

str

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

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 band selections are permitted.

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 band selections are permitted.

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:
Return type:

bool

clone(self) QgsProcessingParameterDefinition
Return type:

QgsProcessingParameterDefinition

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:

QgsProcessingParameterBand

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 band selections are permitted.

See also

allowMultiple()

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.

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