Class: QgsLineburstSymbolLayer

Line symbol layer type which draws a gradient pattern perpendicularly along a line.

See QgsInterpolatedLineSymbolLayer for a line symbol layer which draws gradients along the length of a line.

Added in version 3.24.

List of all members, including inherited members

Class Hierarchy

Base classes

QgsAbstractBrushedLineSymbolLayer	Base class for line symbol layer types which draws line sections using a QBrush.
QgsLineSymbolLayer	Abstract base class for line symbol layers.
QgsSymbolLayer	Abstract base class for symbol layers.

Methods

color2	Returns the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.
colorRamp	Returns the color ramp used for the gradient line.
gradientColorType	Returns the gradient color mode, which controls how gradient color stops are created.
setColor2	Sets the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.
setColorRamp	Sets the color ramp used for the gradient line.
setGradientColorType	Sets the gradient color mode, which controls how gradient color stops are created.

Static Methods

create

Creates a new QgsLineburstSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsLineburstSymbolLayer.properties() ).

class qgis.core.QgsLineburstSymbolLayer

Bases: QgsAbstractBrushedLineSymbolLayer

__init__(color: QColor | Qt.GlobalColor | int = DEFAULT_SIMPLELINE_COLOR, color2: QColor | Qt.GlobalColor | int = Qt.white)

Constructor for QgsLineburstSymbolLayer, with the specified start and end gradient colors.

Parameters:

• color (Union[QColor, Qt.GlobalColor, int] = DEFAULT_SIMPLELINE_COLOR)

• color2 (Union[QColor, Qt.GlobalColor, int] = Qt.white)

color2(self) → QColor

Returns the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.

See also

setColor2()

Return type:

QColor

colorRamp(self) → QgsColorRamp | None

Returns the color ramp used for the gradient line. This is only used if the gradient color type is set to ColorRamp.

See also

setColorRamp()

See also

gradientColorType()

Return type:

Optional[QgsColorRamp]

static create(properties: dict[str | None, Any] = {}) → QgsSymbolLayer | None

Creates a new QgsLineburstSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsLineburstSymbolLayer.properties() ).

Parameters:

properties (dict[Optional[str], Any] = {})

Return type:

Optional[QgsSymbolLayer]

gradientColorType(self) → Qgis.GradientColorSource

Returns the gradient color mode, which controls how gradient color stops are created.

See also

setGradientColorType()

Return type:

Qgis.GradientColorSource

setColor2(self, color2: QColor | Qt.GlobalColor | int)

Sets the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.

See also

color2()

Parameters:

color2 (Union[QColor, Qt.GlobalColor, int])

setColorRamp(self, ramp: QgsColorRamp | None)

Sets the color ramp used for the gradient line. This is only used if the gradient color type is set to ColorRamp.

Parameters:

ramp (Optional[QgsColorRamp]) – color ramp. Ownership is transferred.

See also

colorRamp()

See also

setGradientColorType()

setGradientColorType(self, gradientColorType: Qgis.GradientColorSource)

Sets the gradient color mode, which controls how gradient color stops are created.

See also

gradientColorType()

Parameters:

gradientColorType (Qgis.GradientColorSource)