Class: QgsLineSymbolLayer

class qgis.core.QgsLineSymbolLayer(locked: bool = False)

Bases: qgis._core.QgsSymbolLayer

QgsLineSymbolLayer(QgsLineSymbolLayer)

Enums

Methods

copyDataDefinedProperties

copyPaintEffect

drawPreviewIcon

dxfWidth

mapUnitScale

offset

Returns the line’s offset.

offsetMapUnitScale

Returns the map unit scale for the line’s offset.

offsetUnit

Returns the units for the line’s offset.

outputUnit

renderPolygonStroke

Renders the line symbol layer along the outline of polygon, using the given render context.

renderPolyline

Renders the line symbol layer along the line joining points, using the given render context.

restoreOldDataDefinedProperties

ringFilter

Returns the line symbol layer’s ring filter, which controls which rings are rendered when the line symbol is being used to draw a polygon’s rings.

setMapUnitScale

setOffset

Sets the line’s offset.

setOffsetMapUnitScale

Sets the map unit scale for the line’s offset.

setOffsetUnit

Sets the unit for the line’s offset.

setOutputUnit

setRingFilter

Sets the line symbol layer’s ring filter, which controls which rings are rendered when the line symbol is being used to draw a polygon’s rings.

setWidth

Sets the width of the line symbol layer.

setWidthMapUnitScale

setWidthUnit

Sets the units for the line’s width.

width

Returns the estimated width for the line symbol layer.

widthMapUnitScale

widthUnit

Returns the units for the line’s width.

Signals

Attributes

AllRings

ExteriorRingOnly

InteriorRingsOnly

AllRings = 0
ExteriorRingOnly = 1
InteriorRingsOnly = 2
class RenderRingFilter

Bases: int

copyDataDefinedProperties()
copyPaintEffect()
drawPreviewIcon(self, context: QgsSymbolRenderContext, size: QSize)
dxfWidth(self, e: QgsDxfExport, context: QgsSymbolRenderContext) → float
mapUnitScale(self) → QgsMapUnitScale
offset(self) → float

Returns the line’s offset.

Offset units can be retrieved by calling offsetUnit().

See also

setOffset()

See also

offsetUnit()

offsetMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the line’s offset.

See also

offset()

See also

offsetUnit()

offsetUnit(self) → QgsUnitTypes.RenderUnit

Returns the units for the line’s offset.

See also

setOffsetUnit()

See also

offset()

outputUnit(self) → QgsUnitTypes.RenderUnit
renderPolygonStroke(self, points: QPolygonF, rings: Iterable[QPolygonF], context: QgsSymbolRenderContext)

Renders the line symbol layer along the outline of polygon, using the given render context.

The exterior ring of the polygon is specified in points. Optionally, interior rings are set via the rings argument.

See also

renderPolyline()

renderPolyline(self, points: QPolygonF, context: QgsSymbolRenderContext)

Renders the line symbol layer along the line joining points, using the given render context.

restoreOldDataDefinedProperties()
ringFilter(self) → QgsLineSymbolLayer.RenderRingFilter

Returns the line symbol layer’s ring filter, which controls which rings are rendered when the line symbol is being used to draw a polygon’s rings.

This setting has no effect when the line symbol is not being rendered for a polygon.

See also

setRingFilter()

New in version 3.6.

setMapUnitScale(self, scale: QgsMapUnitScale)
setOffset(self, offset: float)

Sets the line’s offset.

Offset units are set via setOffsetUnit().

See also

offset()

See also

setOffsetUnit()

setOffsetMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the line’s offset.

See also

setOffset()

See also

setOffsetUnit()

setOffsetUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the unit for the line’s offset.

See also

offsetUnit()

See also

setOffset()

setOutputUnit(self, unit: QgsUnitTypes.RenderUnit)
setRingFilter(self, filter: QgsLineSymbolLayer.RenderRingFilter)

Sets the line symbol layer’s ring filter, which controls which rings are rendered when the line symbol is being used to draw a polygon’s rings.

This setting has no effect when the line symbol is not being rendered for a polygon.

See also

ringFilter()

New in version 3.6.

setWidth(self, width: float)

Sets the width of the line symbol layer.

Calling this method updates the width of the line symbol layer, without changing the existing width units. It has different effects depending on the line symbol layer subclass, e.g. for a simple line layer it changes the stroke width of the line, for a marker line layer it changes the size of the markers used to draw the line.

See also

width()

Warning

Since the width units vary, this method is useful for changing the relative width of a line symbol layer only.

setWidthMapUnitScale(self, scale: QgsMapUnitScale)
setWidthUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units for the line’s width.

Parameters

unit – width units

See also

widthUnit()

width(self) → float

Returns the estimated width for the line symbol layer.

Warning

This returned value is inaccurate if the symbol layer has sub-symbols with different width units. Use the overload accepting a QgsRenderContext argument instead for accurate sizes in this case.

See also

setWidth()

width(self, context: QgsRenderContext) -> float Returns the line symbol layer width, in painter units.

This method returns an accurate width by calculating the actual rendered width of the symbol layer using the provided render context.

See also

setWidth()

New in version 3.4.5.

widthMapUnitScale(self) → QgsMapUnitScale
widthUnit(self) → QgsUnitTypes.RenderUnit

Returns the units for the line’s width.

See also

setWidthUnit()