Class: QgsColorRampShader¶

A ramp shader will color a raster pixel based on a list of values ranges in a ramp.

Class Hierarchy¶

The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color.

Enums

`ClassificationMode`	alias of `ShaderClassificationMethod`
`Type`	alias of `ShaderInterpolationMethod`

Methods

`classificationMode`	Returns the classification mode.
`classifyColorRamp`	Classify color ramp shader
`classifyColorRampV2`	Classify color ramp shader
`clip`	Returns whether the shader will clip values which are out of range.
`colorRampItemList`	Returns the custom color map.
`colorRampType`	Returns the color ramp interpolation method.
`colorRampTypeAsQString`	Returns the color ramp type as a string.
`createColorRamp`	Creates a gradient color ramp from shader settings.
`isEmpty`	Whether the color ramp contains any items
`legendSettings`	Returns the color ramp shader legend settings.
`readXml`	Reads configuration from the given DOM element
`setClassificationMode`	Sets the classification mode.
`setClip`	Sets whether the shader should not render values out of range.
`setColorRampItemList`
`setColorRampType`	Sets the color ramp interpolation method.
`setLegendSettings`	Sets the color ramp shader legend settings.
`setSourceColorRamp`	Set the source color ramp.
`sourceColorRamp`	Returns the source color ramp.
`writeXml`	Writes configuration to a new DOM element

class qgis.core.QgsColorRampShader[source]¶

Bases: QgsRasterShaderFunction

__init__(minimumValue: float = 0, maximumValue: float = 255, colorRamp: QgsColorRamp | None = None, type: Qgis.ShaderInterpolationMethod = Qgis.ShaderInterpolationMethod.Linear, classificationMode: Qgis.ShaderClassificationMethod = Qgis.ShaderClassificationMethod.Continuous)

Creates a new color ramp shader.

Parameters:

minimumValue (float = 0) – minimum value for the raster shader
maximumValue (float = 255) – maximum value for the raster shader
type (Qgis.ShaderInterpolationMethod = Qgis.ShaderInterpolationMethod.Linear) – interpolation type used
classificationMode (Qgis.ShaderClassificationMethod = Qgis.ShaderClassificationMethod.Continuous) – method used to classify the color ramp shader
colorRamp (Optional[QgsColorRamp] = None) – vector color ramp used to classify the color ramp shader. Ownership is transferred to the shader.

__init__(other: QgsColorRampShader)

class ColorRampItem¶

Bases: object

QgsColorRampShader.ColorRampItem(val: float, col: Union[QColor, Qt.GlobalColor], lbl: Optional[str] = ‘’) convenience constructor

QgsColorRampShader.ColorRampItem(a0: QgsColorRampShader.ColorRampItem)

Returns the classification mode.

See also

classifyColorRamp(self, classes: int = 0, band: int = -1, extent: QgsRectangle = QgsRectangle(), input: QgsRasterInterface | None = None)[source]¶

Classify color ramp shader

Parameters:

classes (int = 0) – number of classes
band (int = -1) – raster band used in classification (only used in quantile mode)
extent (QgsRectangle = QgsRectangle()) – extent used in classification (only used in quantile mode)
input (Optional[QgsRasterInterface] = None) – raster input used in classification (only used in quantile mode)

classifyColorRampV2(self, band: int = -1, extent: QgsRectangle = QgsRectangle(), input: QgsRasterInterface | None = None)¶

Classify color ramp shader

Parameters:

band (int = -1) – raster band used in classification (quantile mode only)
extent (QgsRectangle = QgsRectangle()) – extent used in classification (quantile mode only)
input (Optional[QgsRasterInterface] = None) – raster input used in classification (quantile mode only)