Subgroup: Processing
Class: QgsProcessingParameterBand¶
-
class
qgis.core.
QgsProcessingParameterBand
(name: str, description: str = '', defaultValue: Any = None, parentLayerParameterName: str = '', optional: bool = False)¶ Bases:
qgis._core.QgsProcessingParameterDefinition
Constructor for QgsProcessingParameterBand.
QgsProcessingParameterBand(QgsProcessingParameterBand)
A raster band parameter for Processing algorithms.
New in version 3.0: Methods
asScriptCode
checkValueIsAcceptable
clone
dependsOnOtherParameters
fromScriptCode
Creates a new parameter using the definition from a script code. fromVariantMap
parentLayerParameterName
Returns the name of the parent layer parameter, or an empty string if this is not set. setParentLayerParameterName
Sets the name of the parent layer parameter. toVariantMap
type
typeName
Returns the type name for the parameter class. valueAsPythonString
Signals
Attributes
-
asScriptCode
(self) → str¶
-
checkValueIsAcceptable
(self, input: Any, context: QgsProcessingContext = None) → bool¶
-
clone
(self) → QgsProcessingParameterDefinition¶
-
dependsOnOtherParameters
(self) → List[str]¶
-
fromScriptCode
(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterBand¶ Creates a new parameter using the definition from a script code.
-
fromVariantMap
(self, map: Dict[str, Any]) → bool¶
-
parentLayerParameterName
(self) → str¶ Returns the name of the parent layer parameter, or an empty string if this is not set.
See also
-
setParentLayerParameterName
(self, parentLayerParameterName: str)¶ Sets the name of the parent layer parameter. Use an empty string if this is not required.
See also
-
toVariantMap
(self) → Dict[str, Any]¶
-
type
(self) → str¶
-
typeName
() → str¶ Returns the type name for the parameter class.
-
valueAsPythonString
(self, value: Any, context: QgsProcessingContext) → str¶
-