Class: QgsTemplatedLineSymbolLayerBase

class qgis.core.QgsTemplatedLineSymbolLayerBase

Bases: QgsLineSymbolLayer

Base class for templated line symbols, e.g. line symbols which draw markers or hash lines at intervals along the line feature.

New in version 3.8.

QgsTemplatedLineSymbolLayerBase(rotateSymbol: bool = True, interval: float = 3) Constructor for QgsTemplatedLineSymbolLayerBase. Creates a template line placed at the specified interval (in millimeters).

The rotateSymbol argument specifies whether individual symbols should be rotated to match the line segment alignment.

Enums

Placement

alias of MarkerLinePlacement

Methods

averageAngleLength

Returns the length of line over which the line's direction is averaged when calculating individual symbol angles.

averageAngleMapUnitScale

Returns the map unit scale for the length over which the line's direction is averaged when calculating individual symbol angles.

averageAngleUnit

Returns the unit for the length over which the line's direction is averaged when calculating individual symbol angles.

canCauseArtifactsBetweenAdjacentTiles

rtype:

bool

copyDataDefinedProperties

Copies all data defined properties of this layer to another symbol layer.

copyPaintEffect

Copies paint effect of this layer to another symbol layer

copyTemplateSymbolProperties

Copies all common properties of this layer to another templated symbol layer.

installMasks

When rendering, install masks on context painter if recursive is True masks are installed recursively for all children symbol layers

interval

Returns the interval between individual symbols.

intervalMapUnitScale

Returns the map unit scale for the interval between symbols.

intervalUnit

Returns the units for the interval between symbols.

mapUnitScale

rtype:

QgsMapUnitScale

offsetAlongLine

Returns the offset along the line for the symbol placement.

offsetAlongLineMapUnitScale

Returns the map unit scale used for calculating the offset in map units along line for symbols.

offsetAlongLineUnit

Returns the unit used for calculating the offset along line for symbols.

outputUnit

rtype:

Qgis.RenderUnit

placeOnEveryPart

Returns True if the placement applies for every part of multi-part feature geometries.

placement

Returns the placement of the symbols.

placements

Returns the placement of the symbols.

properties

rtype:

Dict[str, Any]

removeMasks

When rendering, remove previously installed masks from context painter if recursive is True masks are removed recursively for all children symbol layers

renderPolygonStroke

param points:

renderPolyline

param points:

renderSymbol

Renders the templated symbol at the specified point, using the given render context.

restoreOldDataDefinedProperties

Restores older data defined properties from string map.

rotateSymbols

Returns True if the repeating symbols be rotated to match their line segment orientation.

setAverageAngleLength

Sets the length of line over which the line's direction is averaged when calculating individual symbol angles.

setAverageAngleMapUnitScale

Sets the map unit scale for the length over which the line's direction is averaged when calculating individual symbol angles.

setAverageAngleUnit

Sets the unit for the length over which the line's direction is averaged when calculating individual symbol angles.

setCommonProperties

Sets all common symbol properties in the destLayer, using the settings serialized in the properties map.

setInterval

Sets the interval between individual symbols.

setIntervalMapUnitScale

Sets the map unit scale for the interval between symbols.

setIntervalUnit

Sets the units for the interval between symbols.

setMapUnitScale

param scale:

setOffsetAlongLine

Sets the the offset along the line for the symbol placement.

setOffsetAlongLineMapUnitScale

Sets the map unit scale used for calculating the offset in map units along line for symbols.

setOffsetAlongLineUnit

Sets the unit used for calculating the offset along line for symbols.

setOutputUnit

param unit:

setPlaceOnEveryPart

Sets whether the placement applies for every part of multi-part feature geometries.

setPlacement

Sets the placement of the symbols.

setPlacements

Sets the placement of the symbols.

setRotateSymbols

Sets whether the repeating symbols should be rotated to match their line segment orientation.

setSymbolAngle

Sets the symbol's angle, in degrees clockwise.

setSymbolLineAngle

Sets the line angle modification for the symbol's angle.

shouldRenderUsingSelectionColor

Returns True if the symbol layer should be rendered using the selection color from the render context.

startFeatureRender

param feature:

stopFeatureRender

param feature:

symbolAngle

Returns the symbol's current angle, in degrees clockwise.
Placement

alias of MarkerLinePlacement

averageAngleLength(self) → float

Returns the length of line over which the line’s direction is averaged when calculating individual symbol angles. Longer lengths smooth out angles from jagged lines to a greater extent.

Units are retrieved through averageAngleUnit()

See also

setAverageAngleLength()

See also

averageAngleUnit()

See also

averageAngleMapUnitScale()

Return type:

float

averageAngleMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the length over which the line’s direction is averaged when calculating individual symbol angles.

See also

setAverageAngleMapUnitScale()

See also

averageAngleLength()

See also

averageAngleUnit()

Return type:

QgsMapUnitScale

averageAngleUnit(self) → Qgis.RenderUnit

Returns the unit for the length over which the line’s direction is averaged when calculating individual symbol angles.

See also

setAverageAngleUnit()

See also

averageAngleLength()

See also

averageAngleMapUnitScale()

Return type:

Qgis.RenderUnit

canCauseArtifactsBetweenAdjacentTiles(self) → bool
Return type:

bool

copyDataDefinedProperties(self, destLayer: QgsSymbolLayer)

Copies all data defined properties of this layer to another symbol layer.

Parameters:

destLayer – destination layer

copyPaintEffect(self, destLayer: QgsSymbolLayer)

Copies paint effect of this layer to another symbol layer

Parameters:

destLayer – destination layer

New in version 2.9.

copyTemplateSymbolProperties(self, destLayer: QgsTemplatedLineSymbolLayerBase)

Copies all common properties of this layer to another templated symbol layer.

Parameters:

destLayer (QgsTemplatedLineSymbolLayerBase) –

installMasks(self, context: QgsRenderContext, recursive: bool)

When rendering, install masks on context painter if recursive is True masks are installed recursively for all children symbol layers

See also

prepareMasks()

See also

removeMasks()

New in version 3.30.

interval(self) → float

Returns the interval between individual symbols. Units are specified through intervalUnits().

See also

setInterval()

See also

intervalUnit()

Return type:

float

intervalMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the interval between symbols.

See also

setIntervalMapUnitScale()

See also

intervalUnit()

See also

interval()

Return type:

QgsMapUnitScale

intervalUnit(self) → Qgis.RenderUnit

Returns the units for the interval between symbols.

See also

setIntervalUnit()

See also

interval()

Return type:

Qgis.RenderUnit

mapUnitScale(self) → QgsMapUnitScale
Return type:

QgsMapUnitScale

offsetAlongLine(self) → float

Returns the offset along the line for the symbol placement. For Interval placements, this is the distance between the start of the line and the first symbol. For FirstVertex and LastVertex placements, this is the distance between the symbol and the start of the line or the end of the line respectively. This setting has no effect for Vertex or CentralPoint placements.

Return type:

float

Returns:

The offset along the line. The unit for the offset is retrievable via offsetAlongLineUnit.

See also

setOffsetAlongLine()

See also

offsetAlongLineUnit()

See also

placement()

offsetAlongLineMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale used for calculating the offset in map units along line for symbols.

See also

setOffsetAlongLineMapUnitScale()

Return type:

QgsMapUnitScale

offsetAlongLineUnit(self) → Qgis.RenderUnit

Returns the unit used for calculating the offset along line for symbols.

Return type:

Qgis.RenderUnit

Returns:

Offset along line unit type.

See also

setOffsetAlongLineUnit()

See also

offsetAlongLine()

outputUnit(self) → Qgis.RenderUnit
Return type:

Qgis.RenderUnit

placeOnEveryPart(self) → bool

Returns True if the placement applies for every part of multi-part feature geometries.

The default is True, which means that Qgis.MarkerLinePlacement.FirstVertex or Qgis.MarkerLinePlacement.LastVertex placements will result in a symbol on the first/last vertex of EVERY part of a multipart feature.

If False, then Qgis.MarkerLinePlacement.FirstVertex or Qgis.MarkerLinePlacement.LastVertex placements will result in a symbol on the first/last vertex of the overall multipart geometry only.

See also

setPlaceOnEveryPart()

New in version 3.24.

Return type:

bool

placement(self) → Qgis.MarkerLinePlacement

Returns the placement of the symbols.

See also

setPlacement()

Deprecated since version use: placements() instead

Return type:

Qgis.MarkerLinePlacement

placements(self) → Qgis.MarkerLinePlacements

Returns the placement of the symbols.

See also

setPlacements()

New in version 3.24.

Return type:

Qgis.MarkerLinePlacements

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

Dict[str, Any]

removeMasks(self, context: QgsRenderContext, recursive: bool)

When rendering, remove previously installed masks from context painter if recursive is True masks are removed recursively for all children symbol layers

See also

prepareMasks()

See also

installMasks()

New in version 3.30.

renderPolygonStroke(self, points: QPolygonF, rings: Iterable[QPolygonF], context: QgsSymbolRenderContext)
Parameters:
renderPolyline(self, points: QPolygonF, context: QgsSymbolRenderContext)
Parameters:
renderSymbol(self, point: QPointF | QPoint, feature: QgsFeature, context: QgsRenderContext, layer: int = -1, selected: bool = False)

Renders the templated symbol at the specified point, using the given render context.

The feature argument is used to pass the feature currently being rendered (when available).

If only a single symbol layer from the symbol should be rendered, it should be specified in the layer argument. A layer of -1 indicates that all symbol layers should be rendered.

If selected is True then the symbol will be drawn using the “selected feature” style and colors instead of the symbol’s normal style.

Parameters:

  • point (Union[QPointF) –

  • feature (QgsFeature) –

  • context (QgsRenderContext) –

  • layer (int = -1) –

  • selected (bool = False) –

restoreOldDataDefinedProperties(self, stringMap: Dict[str, Any])

Restores older data defined properties from string map.

New in version 3.0.

rotateSymbols(self) → bool

Returns True if the repeating symbols be rotated to match their line segment orientation.

See also

setRotateSymbols()

Return type:

bool

setAverageAngleLength(self, length: float)

Sets the length of line over which the line’s direction is averaged when calculating individual symbol angles. Longer lengths smooth out angles from jagged lines to a greater extent.

Units are set through setAverageAngleUnit()

See also

averageAngleLength()

See also

setAverageAngleUnit()

See also

setAverageAngleMapUnitScale()

Parameters:

length (float) –

setAverageAngleMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the length over which the line’s direction is averaged when calculating individual symbol angles.

See also

averageAngleMapUnitScale()

See also

setAverageAngleLength()

See also

setAverageAngleUnit()

Parameters:

scale (QgsMapUnitScale) –

setAverageAngleUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the length over which the line’s direction is averaged when calculating individual symbol angles.

See also

averageAngleUnit()

See also

setAverageAngleLength()

See also

setAverageAngleMapUnitScale()

Parameters:

unit (Qgis.RenderUnit) –

setCommonProperties(destLayer: QgsTemplatedLineSymbolLayerBase, properties: Dict[str, Any])

Sets all common symbol properties in the destLayer, using the settings serialized in the properties map.

Parameters:
setInterval(self, interval: float)

Sets the interval between individual symbols.

Parameters:

interval (float) – interval size. Units are specified through setIntervalUnit()

See also

interval()

See also

setIntervalUnit()

setIntervalMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the interval between symbols.

See also

intervalMapUnitScale()

See also

setIntervalUnit()

See also

setInterval()

Parameters:

scale (QgsMapUnitScale) –

setIntervalUnit(self, unit: Qgis.RenderUnit)

Sets the units for the interval between symbols.

Parameters:

unit (Qgis.RenderUnit) – interval units

See also

intervalUnit()

See also

setInterval()

setMapUnitScale(self, scale: QgsMapUnitScale)
Parameters:

scale (QgsMapUnitScale) –

setOffsetAlongLine(self, offsetAlongLine: float)

Sets the the offset along the line for the symbol placement. For Interval placements, this is the distance between the start of the line and the first symbol. For FirstVertex and LastVertex placements, this is the distance between the symbol and the start of the line or the end of the line respectively. This setting has no effect for Vertex or CentralPoint placements.

Parameters:

offsetAlongLine (float) – Distance to offset markers along the line. The offset unit is set via setOffsetAlongLineUnit.

See also

offsetAlongLine()

See also

setOffsetAlongLineUnit()

See also

setPlacement()

setOffsetAlongLineMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale used for calculating the offset in map units along line for symbols.

See also

offsetAlongLineMapUnitScale()

Parameters:

scale (QgsMapUnitScale) –

setOffsetAlongLineUnit(self, unit: Qgis.RenderUnit)

Sets the unit used for calculating the offset along line for symbols.

Parameters:

unit (Qgis.RenderUnit) – Offset along line unit type.

See also

offsetAlongLineUnit()

See also

setOffsetAlongLine()

setOutputUnit(self, unit: Qgis.RenderUnit)
Parameters:

unit (Qgis.RenderUnit) –

setPlaceOnEveryPart(self, respect: bool)

Sets whether the placement applies for every part of multi-part feature geometries.

The default is True, which means that Qgis.MarkerLinePlacement.FirstVertex or Qgis.MarkerLinePlacement.LastVertex placements will result in a symbol on the first/last vertex of EVERY part of a multipart feature.

If False, then Qgis.MarkerLinePlacement.FirstVertex or Qgis.MarkerLinePlacement.LastVertex placements will result in a symbol on the first/last vertex of the overall multipart geometry only.

See also

placeOnEveryPart()

New in version 3.24.

Parameters:

respect (bool) –

setPlacement(self, placement: Qgis.MarkerLinePlacement)

Sets the placement of the symbols.

See also

placement()

Deprecated since version use: setPlacements() instead

Parameters:

placement (Qgis.MarkerLinePlacement) –

setPlacements(self, placements: Qgis.MarkerLinePlacements | Qgis.MarkerLinePlacement)

Sets the placement of the symbols.

See also

placements()

New in version 3.24.

Parameters:

placements (Union[Qgis.MarkerLinePlacements) –

setRotateSymbols(self, rotate: bool)

Sets whether the repeating symbols should be rotated to match their line segment orientation.

See also

rotateSymbols()

Parameters:

rotate (bool) –

setSymbolAngle(self, angle: float)

Sets the symbol’s angle, in degrees clockwise.

Parameters:

angle (float) –

setSymbolLineAngle(self, angle: float)

Sets the line angle modification for the symbol’s angle. This angle is added to the symbol’s rotation and data defined rotation before rendering the symbol, and is used for orienting symbols to match the line’s angle.

Parameters:

angle (float) – Angle in degrees, valid values are between 0 and 360

shouldRenderUsingSelectionColor(self, context: QgsSymbolRenderContext) → bool

Returns True if the symbol layer should be rendered using the selection color from the render context.

New in version 3.34.

startFeatureRender(self, feature: QgsFeature, context: QgsRenderContext)
Parameters:
stopFeatureRender(self, feature: QgsFeature, context: QgsRenderContext)
Parameters:
symbolAngle(self) → float

Returns the symbol’s current angle, in degrees clockwise.

Return type:

float