Class: QgsHashedLineSymbolLayer

class qgis.core.QgsHashedLineSymbolLayer(rotateSymbol: bool = True, interval: float = 3)

Bases: QgsTemplatedLineSymbolLayerBase

Constructor for QgsHashedLineSymbolLayer. Creates a line with a default hash symbol, placed at the specified interval (in millimeters).

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

Line symbol layer type which draws repeating line sections along a line feature.

New in version 3.8.

Parameters
  • rotateSymbol (bool = True) –

  • interval

clone(self)QgsHashedLineSymbolLayer
Return type

QgsHashedLineSymbolLayer

color(self) → QColor
Return type

QColor

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.

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

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

Parameters

properties (Dict[str) –

Return type

QgsSymbolLayer

estimateMaxBleed(self, context: QgsRenderContext) → float
Parameters

context (QgsRenderContext) –

Return type

float

hasDataDefinedProperties(self) → bool
Return type

bool

hashAngle(self) → float

Returns the angle to use when drawing the hashed lines sections, in degrees clockwise.

See also

setHashAngle()

Return type

float

hashLength(self) → float

Returns the length of hash symbols. Units are specified through hashLengthUnits().

See also

setHashLength()

See also

hashLengthUnit()

Return type

float

hashLengthMapUnitScale(self)QgsMapUnitScale

Returns the map unit scale for the hash length.

See also

hashLengthUnit()

See also

hashLength()

Return type

QgsMapUnitScale

hashLengthUnit(self) → QgsUnitTypes.RenderUnit

Returns the units for the length of hash symbols.

See also

hashLength()

Return type

QgsUnitTypes.RenderUnit

layerType(self) → str
Return type

str

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

Dict[str, str]

renderSymbol(self, point: Union[QPointF, QPoint], feature: QgsFeature, context: QgsRenderContext, layer: int = - 1, selected: bool = False)
Parameters
  • point (Union[QPointF) –

  • feature (QgsFeature) –

  • context (QgsRenderContext) –

  • layer (int = -1) –

  • selected (bool = False) –

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

Restores older data defined properties from string map.

New in version 3.0.

setColor(self, color: Union[QColor, Qt.GlobalColor])
Parameters

color (Union[QColor) –

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

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

setDataDefinedProperty(self, key: QgsSymbolLayer.Property, property: QgsProperty)
Parameters
setHashAngle(self, angle: float)

Sets the angle to use when drawing the hashed lines sections, in degrees clockwise.

See also

hashAngle()

Parameters

angle (float) –

setHashLength(self, length: float)

Sets the length of hash symbols. Units are specified through setHashLengthUnit()

See also

hashLength()

Parameters

length (float) –

setHashLengthMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the hash length.

See also

setHashLength()

Parameters

scale (QgsMapUnitScale) –

setHashLengthUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the unit for the length of hash symbols.

See also

hashLengthUnit()

See also

setHashLength()

Parameters

unit (QgsUnitTypes.RenderUnit) –

setOutputUnit(self, unit: QgsUnitTypes.RenderUnit)
Parameters

unit (QgsUnitTypes.RenderUnit) –

setSubSymbol(self, symbol: QgsSymbol) → bool
Parameters

symbol (QgsSymbol) –

Return type

bool

setSymbolAngle(self, angle: float)
Parameters

angle (float) –

setSymbolLineAngle(self, angle: float)
Parameters

angle (float) –

setWidth(self, width: float)
Parameters

width (float) –

startRender(self, context: QgsSymbolRenderContext)
Parameters

context (QgsSymbolRenderContext) –

stopRender(self, context: QgsSymbolRenderContext)
Parameters

context (QgsSymbolRenderContext) –

subSymbol(self)QgsSymbol
Return type

QgsSymbol

symbolAngle(self) → float
Return type

float

usedAttributes(self, context: QgsRenderContext) → Set[str]
Parameters

context (QgsRenderContext) –

Return type

Set[str]

width(self) → float

width(self, context: QgsRenderContext) -> float

Return type

float