Class: QgsProcessingParameterColor

class qgis.core.QgsProcessingParameterColor(name: str, description: str = '', defaultValue: Any = None, opacityEnabled: bool = True, optional: bool = False)

Bases: QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterColor.

If opacityEnabled is True, then users will have the option of varying color opacity.

QgsProcessingParameterColor(QgsProcessingParameterColor)

A color parameter for processing algorithms.

QgsProcessingParameterColor should be evaluated by calling QgsProcessingAlgorithm.parameterAsColor()

New in version 3.10.

Parameters
  • name (str) –

  • description (str = '') –

  • defaultValue (Any = None) –

  • opacityEnabled (bool = True) –

  • optional

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

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterColor

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

Parameters
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type

QgsProcessingParameterColor

fromVariantMap(self, map: Dict[str, Any]) → bool
Parameters

map (Dict[str) –

Return type

bool

opacityEnabled(self) → bool

Returns True if the parameter allows opacity control.

The default behavior is to allow users to set opacity for the color.

Return type

bool

setOpacityEnabled(self, enabled: bool)

Sets whether the parameter allows opacity control.

The default behavior is to allow users to set opacity for the color.

See also

opacityEnabled()

Parameters

enabled (bool) –

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