Class: QgsInterpolatedLineRenderer

class qgis.core.QgsInterpolatedLineRenderer

Bases: sip.wrapper

Represents a simple line renderer with width and color varying depending on values.

New in version 3.14:

Methods

interpolatedColor

Returns the stroke color used to render

interpolatedLineWidth

Returns the stroke width used to render

render

Renders a line in the context between point1 and point2 with color and width that vary depending on value1 and value2

renderInDeviceCoordinates

Renders a line in the context between point1 and point2 in device (painter) coordinates with color that varies depending on valueColor1 and valueColor2 and and width that varies between valueWidth1 and valueWidth2.

setInterpolatedColor

Sets the stroke color used to render

setInterpolatedWidth

Sets the stroke width used to render

setSelected

Sets if the rendering must be done as the element is selected

setWidthUnit

Sets the unit of the stroke width

widthUnit

Returns the unit of the stroke width

interpolatedColor(self) QgsInterpolatedLineColor

Returns the stroke color used to render

New in version 3.20.

Return type:

QgsInterpolatedLineColor

interpolatedLineWidth(self) QgsInterpolatedLineWidth

Returns the stroke width used to render

New in version 3.20.

Return type:

QgsInterpolatedLineWidth

render(self, value1: float, value2: float, point1: QgsPointXY, point2: QgsPointXY, context: QgsRenderContext)

Renders a line in the context between point1 and point2 with color and width that vary depending on value1 and value2

This method assumes that point1 and point2 are in map units. See renderInDeviceCoordinates() for an equivalent method which renders lines in painter coordinates.

render(self, valueColor1: float, valueColor2: float, valueWidth1: float, valueWidth2: float, point1: QgsPointXY, point2: QgsPointXY, context: QgsRenderContext) Renders a line in the context between point1 and point2 with color that varies depending on valueColor1 and valueColor2 and and width that varies between valueWidth1 and valueWidth2

This method assumes that point1 and point2 are in map units. See renderInDeviceCoordinates() for an equivalent method which renders lines in painter coordinates.

New in version 3.20.

Parameters:
renderInDeviceCoordinates(self, valueColor1: float, valueColor2: float, valueWidth1: float, valueWidth2: float, point1: QPointF | QPoint, point2: QPointF | QPoint, context: QgsRenderContext)

Renders a line in the context between point1 and point2 in device (painter) coordinates with color that varies depending on valueColor1 and valueColor2 and and width that varies between valueWidth1 and valueWidth2.

New in version 3.22.

Parameters:
  • valueColor1 (float) –

  • valueColor2 (float) –

  • valueWidth1 (float) –

  • valueWidth2 (float) –

  • point1 (Union[QPointF) –

  • point2 (Union[QPointF) –

  • context (QgsRenderContext) –

setInterpolatedColor(self, strokeColoring: QgsInterpolatedLineColor)

Sets the stroke color used to render

Parameters:

strokeColoring (QgsInterpolatedLineColor) –

setInterpolatedWidth(self, strokeWidth: QgsInterpolatedLineWidth)

Sets the stroke width used to render

Parameters:

strokeWidth (QgsInterpolatedLineWidth) –

setSelected(self, selected: bool)

Sets if the rendering must be done as the element is selected

New in version 3.20.

Parameters:

selected (bool) –

setWidthUnit(self, strokeWidthUnit: QgsUnitTypes.RenderUnit)

Sets the unit of the stroke width

Parameters:

strokeWidthUnit (QgsUnitTypes.RenderUnit) –

widthUnit(self) QgsUnitTypes.RenderUnit

Returns the unit of the stroke width

New in version 3.20.

Return type:

QgsUnitTypes.RenderUnit