QgsColorRamp Class Reference

Abstract base class for color ramps. More...

#include <qgscolorramp.h>

Inheritance diagram for QgsColorRamp:

Public Member Functions
virtual	~QgsColorRamp ()=default
virtual QgsColorRamp *	clone () const =0
	Creates a clone of the color ramp. More...
virtual QColor	color (double value) const =0
	Returns the color corresponding to a specified value. More...
virtual int	count () const =0
	Returns number of defined colors, or -1 if undefined. More...
virtual void	invert ()
	Inverts the ordering of the color ramp. More...
virtual QVariantMap	properties () const =0
	Returns a string map containing all the color ramp's properties. More...
virtual QString	type () const =0
	Returns a string representing the color ramp type. More...
virtual double	value (int index) const =0
	Returns relative value between [0,1] of color at specified index. More...

Static Public Member Functions
static QList< QPair< QString, QString > >	rampTypes ()
	Returns a list of available ramp types, where the first value in each item is the QgsColorRamp::type() string and the second is a user friendly, translated name for the color ramp type. More...

Detailed Description

Abstract base class for color ramps.

Since

QGIS 3.0

Definition at line 31 of file qgscolorramp.h.

Constructor & Destructor Documentation

~QgsColorRamp()

virtual QgsColorRamp::~QgsColorRamp ( )

virtualdefault

Member Function Documentation

clone()

virtual QgsColorRamp* QgsColorRamp::clone ( ) const

pure virtual

Creates a clone of the color ramp.

Implemented in QgsCptCityColorRamp, QgsColorBrewerColorRamp, QgsPresetSchemeColorRamp, QgsRandomColorRamp, QgsLimitedRandomColorRamp, and QgsGradientColorRamp.

color()

virtual QColor QgsColorRamp::color ( double  value ) const

pure virtual

Returns the color corresponding to a specified value.

Parameters

value

value between [0, 1] inclusive

Returns

color for value

Implemented in QgsColorBrewerColorRamp, QgsPresetSchemeColorRamp, QgsRandomColorRamp, QgsLimitedRandomColorRamp, and QgsGradientColorRamp.

count()

virtual int QgsColorRamp::count ( ) const

pure virtual

Returns number of defined colors, or -1 if undefined.

Implemented in QgsColorBrewerColorRamp, QgsPresetSchemeColorRamp, QgsRandomColorRamp, QgsLimitedRandomColorRamp, and QgsGradientColorRamp.

invert()

virtual void QgsColorRamp::invert ( )

inlinevirtual

Inverts the ordering of the color ramp.

Reimplemented in QgsCptCityColorRamp, QgsColorBrewerColorRamp, QgsPresetSchemeColorRamp, and QgsGradientColorRamp.

Definition at line 82 of file qgscolorramp.h.

properties()

virtual QVariantMap QgsColorRamp::properties ( ) const

pure virtual

Returns a string map containing all the color ramp's properties.

Implemented in QgsCptCityColorRamp, QgsColorBrewerColorRamp, QgsPresetSchemeColorRamp, QgsRandomColorRamp, QgsLimitedRandomColorRamp, and QgsGradientColorRamp.

rampTypes()

QList< QPair< QString, QString > > QgsColorRamp::rampTypes ( )

static

Returns a list of available ramp types, where the first value in each item is the QgsColorRamp::type() string and the second is a user friendly, translated name for the color ramp type.

The ramp types are returned in a order of precedence for exposing in UI, with more commonly used types listed first.

Since

QGIS 3.16

Definition at line 948 of file qgscolorramp.cpp.

type()

virtual QString QgsColorRamp::type ( ) const

pure virtual

Returns a string representing the color ramp type.

Implemented in QgsCptCityColorRamp, QgsColorBrewerColorRamp, QgsPresetSchemeColorRamp, QgsRandomColorRamp, QgsLimitedRandomColorRamp, and QgsGradientColorRamp.

value()

virtual double QgsColorRamp::value ( int  index ) const

pure virtual

Returns relative value between [0,1] of color at specified index.

Implemented in QgsColorBrewerColorRamp, QgsPresetSchemeColorRamp, QgsRandomColorRamp, QgsLimitedRandomColorRamp, and QgsGradientColorRamp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.20.0+99unstable/src/core/qgscolorramp.h
• /build/qgis-3.20.0+99unstable/src/core/qgscolorramp.cpp