Class: QgsProcessingParameterBand

A raster band parameter for Processing algorithms.

Class Hierarchy

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

Methods

allowMultiple	Returns whether multiple band selections are permitted.
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.

Static Methods

fromScriptCode	Creates a new parameter using the definition from a script code.
typeName	Returns the type name for the parameter class.

class qgis.core.QgsProcessingParameterBand

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '', defaultValue: Any = None, parentLayerParameterName: str | None = '', optional: bool = False, allowMultiple: bool = False)

Constructor for QgsProcessingParameterBand.

Parameters:

• name (Optional[str])

• description (Optional[str] = '')

• defaultValue (Any = None)

• parentLayerParameterName (Optional[str] = '')

• optional (bool = False)

• allowMultiple (bool = False)

__init__(a0: QgsProcessingParameterBand)

Parameters:

a0 (QgsProcessingParameterBand)

allowMultiple(self) → bool

Returns whether multiple band selections are permitted.

See also

setAllowMultiple()

Added in version 3.4.

Return type:

bool

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterBand | None

Creates a new parameter using the definition from a script code.

Parameters:

• name (Optional[str])

• description (Optional[str])

• isOptional (bool)

• definition (Optional[str])

Return type:

Optional[QgsProcessingParameterBand]

parentLayerParameterName(self) → str

Returns the name of the parent layer parameter, or an empty string if this is not set.

See also

setParentLayerParameterName()

Return type:

str

setAllowMultiple(self, allowMultiple: bool)

Sets whether multiple band selections are permitted.

See also

allowMultiple()

Added in version 3.4.

Parameters:

allowMultiple (bool)

setParentLayerParameterName(self, parentLayerParameterName: str | None)

Sets the name of the parent layer parameter. Use an empty string if this is not required.

See also

parentLayerParameterName()

Parameters:

parentLayerParameterName (Optional[str])

static typeName() → str

Returns the type name for the parameter class.

Return type:

str