Class: QgsGradientColorRamp

class qgis.core.QgsGradientColorRamp(color1: Union[QColor, Qt.GlobalColor, QGradient] = DEFAULT_GRADIENT_COLOR1, color2: Union[QColor, Qt.GlobalColor, QGradient] = DEFAULT_GRADIENT_COLOR2, discrete: bool = False, stops: Iterable[QgsGradientStop] = [])

Bases: QgsColorRamp

Constructor for QgsGradientColorRamp

Parameters
  • color1 (Union[QColor) – start color, corresponding to a position of 0.0

  • color2 (Union[QColor) – end color, corresponding to a position of 1.0

  • discrete (bool = False) – set to True for discrete interpolation instead of smoothly interpolating between colors

  • stops (Iterable[QgsGradientStop] = []) – optional list of additional color stops

QgsGradientColorRamp(QgsGradientColorRamp)

Gradient color ramp, which smoothly interpolates between two colors and also supports optional extra color stops.

Methods

addStopsToGradient

Copy color ramp stops to a QGradient

clone

rtype

QgsGradientColorRamp

color

param value

color1

Returns the gradient start color.

color2

Returns the gradient end color.

convertToDiscrete

Converts a gradient with existing color stops to or from discrete interpolation.

count

rtype

int

create

Creates a new QgsColorRamp from a map of properties

info

Returns any additional info attached to the gradient ramp (e.g., authorship notes)

invert

isDiscrete

Returns True if the gradient is using discrete interpolation, rather than smoothly interpolating between colors.

properties

rtype

Dict[str, str]

setColor1

Sets the gradient start color.

setColor2

Sets the gradient end color.

setDiscrete

Sets whether the gradient should use discrete interpolation, rather than smoothly interpolating between colors.

setInfo

Sets additional info to attach to the gradient ramp (e.g., authorship notes)

setStops

Sets the list of intermediate gradient stops for the ramp.

stops

Returns the list of intermediate gradient stops for the ramp.

type

rtype

str

value

param index

addStopsToGradient(self, gradient: QGradient, opacity: float = 1)

Copy color ramp stops to a QGradient

Parameters
  • gradient (QGradient) – gradient to copy stops into

  • opacity (float = 1) – opacity multiplier. Opacity of colors will be multiplied by this factor before adding to the gradient.

New in version 2.1.

clone(self) → QgsGradientColorRamp
Return type

QgsGradientColorRamp

color(self, value: float) → QColor
Parameters

value (float) –

Return type

QColor

color1(self) → QColor

Returns the gradient start color.

See also

setColor1()

See also

color2()

Return type

QColor

color2(self) → QColor

Returns the gradient end color.

See also

setColor2()

See also

color1()

Return type

QColor

convertToDiscrete(self, discrete: bool)

Converts a gradient with existing color stops to or from discrete interpolation.

Parameters

discrete (bool) – set to True to convert the gradient stops to discrete, or False to convert them to smooth interpolation

See also

isDiscrete()

count(self) → int
Return type

int

create(properties: Dict[str, str] = {}) → QgsColorRamp

Creates a new QgsColorRamp from a map of properties

Parameters

properties (Dict[str) –

Return type

QgsColorRamp

info(self) → Dict[str, str]

Returns any additional info attached to the gradient ramp (e.g., authorship notes)

See also

setInfo()

Return type

Dict[str, str]

invert(self)
isDiscrete(self) → bool

Returns True if the gradient is using discrete interpolation, rather than smoothly interpolating between colors.

See also

setDiscrete()

Return type

bool

properties(self) → Dict[str, str]
Return type

Dict[str, str]

setColor1(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the gradient start color.

Parameters

color (Union[QColor) – start color

See also

color1()

See also

setColor2()

setColor2(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the gradient end color.

Parameters

color (Union[QColor) – end color

See also

color2()

See also

setColor1()

setDiscrete(self, discrete: bool)

Sets whether the gradient should use discrete interpolation, rather than smoothly interpolating between colors.

Parameters

discrete (bool) – set to True to use discrete interpolation

See also

isDiscrete()

setInfo(self, info: Dict[str, str])

Sets additional info to attach to the gradient ramp (e.g., authorship notes)

Parameters

info (Dict[str) – map of string info to attach

See also

info()

setStops(self, stops: Iterable[QgsGradientStop])

Sets the list of intermediate gradient stops for the ramp.

Parameters

stops (Iterable[QgsGradientStop]) – list of stops. Any existing color stops will be replaced. The stop list will be automatically reordered so that stops are listed in ascending offset order.

See also

stops()

stops(self) → List[QgsGradientStop]

Returns the list of intermediate gradient stops for the ramp.

See also

setStops()

Return type

List[QgsGradientStop]

type(self) → str
Return type

str

value(self, index: int) → float
Parameters

index (int) –

Return type

float