Class: QgsProcessingParameterReliefColors

A parameter for raster relief colors.

Added in version 4.2.

List of all members, including inherited members

Class Hierarchy

Base classes

QgsProcessingParameterString	A string parameter for processing algorithms.
QgsProcessingParameterDefinition	Base class for the definition of processing parameters.

Constructor

__init__

Methods

parentLayerParameter	Returns the linked parent layer parameter name.
valueAsReliefColors	Returns the parameter value interpreted as a list of raster relief colors.

Static Methods

colorsAsVariant

Returns a list of raster relief colors encoded as a variant value.

class qgis.core.QgsProcessingParameterReliefColors

Bases: QgsProcessingParameterString

__init__(name: str | None, description: str | None = '', parentLayerParameter: str | None = '', optional: bool = True)

Constructor for QgsProcessingParameterReliefColors.

Parameters:

• name (Optional[str])

• description (Optional[str] = '')

• parentLayerParameter (Optional[str] = '')

• optional (bool = True)

__init__(a0: QgsProcessingParameterReliefColors)

Parameters:

a0 (QgsProcessingParameterReliefColors)

static colorsAsVariant(colors: Iterable[QgsRasterReliefColor]) → Any

Returns a list of raster relief colors encoded as a variant value.

Parameters:

colors (Iterable[QgsRasterReliefColor])

Return type:

Any

parentLayerParameter(self) → str

Returns the linked parent layer parameter name.

Return type:

str

valueAsReliefColors(self, value: Any, context: QgsProcessingContext) → list[QgsRasterReliefColor]

Returns the parameter value interpreted as a list of raster relief colors.

Parameters:

• value (Any)

• context (QgsProcessingContext)

Return type:

list[QgsRasterReliefColor]