Class: QgsSimpleLineSymbolLayer

A simple line symbol layer, which renders lines using a line in a variety of styles (e.g. solid, dotted, dashed).

Class Hierarchy

Base classes

QgsLineSymbolLayer	Abstract base class for line symbol layers.
QgsSymbolLayer	Abstract base class for symbol layers.

Methods

alignDashPattern	Returns True if dash patterns should be aligned to the start and end of lines, by applying subtle tweaks to the pattern sizing in order to ensure that the end of a line is represented by a complete dash element.
customDashPatternMapUnitScale	Returns the map unit scale for lengths used in the custom dash pattern.
customDashPatternUnit	Returns the units for lengths used in the custom dash pattern.
customDashVector	Returns the custom dash vector, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern.
dashPatternOffset	Returns the dash pattern offset, which dictates how far along the dash pattern the pattern should start rendering at.
dashPatternOffsetMapUnitScale	Returns the map unit scale for the dash pattern offset value.
dashPatternOffsetUnit	Returns the units for the dash pattern offset.
drawInsidePolygon	Returns True if the line should only be drawn inside polygons, and any portion of the line which falls outside the polygon should be clipped away.
penCapStyle	Returns the pen cap style used to render the line (e.g. flat, square, round, etc).
penJoinStyle	Returns the pen join style used to render the line (e.g. miter, bevel, round, etc).
penStyle	Returns the pen style used to render the line (e.g. solid, dashed, etc).
setAlignDashPattern	Sets whether dash patterns should be aligned to the start and end of lines, by applying subtle tweaks to the pattern sizing in order to ensure that the end of a line is represented by a complete dash element.
setCustomDashPatternMapUnitScale	Sets the map unit scale for lengths used in the custom dash pattern.
setCustomDashPatternUnit	Sets the unit for lengths used in the custom dash pattern.
setCustomDashVector	Sets the custom dash vector, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern.
setDashPatternOffset	Sets the dash pattern offset, which dictates how far along the dash pattern the pattern should start rendering at.
setDashPatternOffsetMapUnitScale	Sets the map unit scale for the dash pattern offset.
setDashPatternOffsetUnit	Sets the unit for the dash pattern offset.
setDrawInsidePolygon	Sets whether the line should only be drawn inside polygons, and any portion of the line which falls outside the polygon should be clipped away.
setPenCapStyle	Sets the pen cap style used to render the line (e.g. flat, square, round, etc).
setPenJoinStyle	Sets the pen join style used to render the line (e.g. miter, bevel, round, etc).
setPenStyle	Sets the pen style used to render the line (e.g. solid, dashed, etc).
setTrimDistanceEnd	Sets the trim distance for the end of the line, which dictates a length from the end of the line at which the actual rendering should end.
setTrimDistanceEndMapUnitScale	Sets the map unit scale for the trim distance for the end of the line.
setTrimDistanceEndUnit	Sets the unit for the trim distance for the end of the line.
setTrimDistanceStart	Sets the trim distance for the start of the line, which dictates a length from the start of the line at which the actual rendering should start.
setTrimDistanceStartMapUnitScale	Sets the map unit scale for the trim distance for the start of the line.
setTrimDistanceStartUnit	Sets the unit for the trim distance for the start of the line.
setTweakDashPatternOnCorners	Sets whether dash patterns tweaks should be applied on sharp corners, to ensure that a double-length dash is drawn running into and out of the corner.
setUseCustomDashPattern	Sets whether the line uses a custom dash pattern.
trimDistanceEnd	Returns the trim distance for the end of the line, which dictates a length from the end of the line at which the actual rendering should end.
trimDistanceEndMapUnitScale	Returns the map unit scale for the trim distance for the end of the line.
trimDistanceEndUnit	Returns the unit for the trim distance for the end of the line.
trimDistanceStart	Returns the trim distance for the start of the line, which dictates a length from the start of the line at which the actual rendering should start.
trimDistanceStartMapUnitScale	Returns the map unit scale for the trim distance for the start of the line.
trimDistanceStartUnit	Returns the unit for the trim distance for the start of the line.
tweakDashPatternOnCorners	Returns True if dash patterns tweaks should be applied on sharp corners, to ensure that a double-length dash is drawn running into and out of the corner.
useCustomDashPattern	Returns True if the line uses a custom dash pattern.

Static Methods

create	Creates a new QgsSimpleLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsSimpleLineSymbolLayer.properties() ).
createFromSld	Creates a new QgsSimpleLineSymbolLayer from an SLD XML DOM element.

class qgis.core.QgsSimpleLineSymbolLayer

Bases: QgsLineSymbolLayer

__init__(color: QColor | Qt.GlobalColor = DEFAULT_SIMPLELINE_COLOR, width: float = DEFAULT_SIMPLELINE_WIDTH, penStyle: Qt.PenStyle = DEFAULT_SIMPLELINE_PENSTYLE)

Constructor for QgsSimpleLineSymbolLayer. Creates a simple line symbol in the specified color, width (in millimeters) and penStyle.

Parameters:

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

• width (float = DEFAULT_SIMPLELINE_WIDTH)

• penStyle (Qt.PenStyle = DEFAULT_SIMPLELINE_PENSTYLE)

alignDashPattern(self) → bool

Returns True if dash patterns should be aligned to the start and end of lines, by applying subtle tweaks to the pattern sizing in order to ensure that the end of a line is represented by a complete dash element.

See also

setAlignDashPattern()

See also

tweakDashPatternOnCorners()

Added in version 3.16.

Return type:

bool

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

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

Parameters:

properties (Dict[str, Any] = {})

Return type:

Optional[QgsSymbolLayer]

static createFromSld(element: QDomElement) → QgsSymbolLayer | None

Creates a new QgsSimpleLineSymbolLayer from an SLD XML DOM element.

Parameters:

element (QDomElement)

Return type:

Optional[QgsSymbolLayer]

customDashPatternMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for lengths used in the custom dash pattern.

See also

setCustomDashPatternMapUnitScale()

Return type:

QgsMapUnitScale

customDashPatternUnit(self) → Qgis.RenderUnit

Returns the units for lengths used in the custom dash pattern.

See also

setCustomDashPatternUnit()

Return type:

Qgis.RenderUnit

customDashVector(self) → List[float]

Returns the custom dash vector, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern.

Units for the vector are specified by customDashPatternUnit()

This setting is only used when useCustomDashPattern() returns True.

See also

setCustomDashVector()

See also

customDashPatternUnit()

See also

useCustomDashPattern()

Return type:

List[float]

dashPatternOffset(self) → float

Returns the dash pattern offset, which dictates how far along the dash pattern the pattern should start rendering at.

Offset units can be retrieved by calling dashPatternOffsetUnit().

See also

setDashPatternOffset()

See also

dashPatternOffsetUnit()

See also

dashPatternOffsetMapUnitScale()

Added in version 3.16.

Return type:

float

dashPatternOffsetMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the dash pattern offset value.

See also

setDashPatternOffsetMapUnitScale()

See also

dashPatternOffsetUnit()

See also

dashPatternOffset()

Added in version 3.16.

Return type:

QgsMapUnitScale

dashPatternOffsetUnit(self) → Qgis.RenderUnit

Returns the units for the dash pattern offset.

See also

setDashPatternOffsetUnit()

See also

dashPatternOffset()

See also

dashPatternOffsetMapUnitScale()

Added in version 3.16.

Return type:

Qgis.RenderUnit

drawInsidePolygon(self) → bool

Returns True if the line should only be drawn inside polygons, and any portion of the line which falls outside the polygon should be clipped away.

This setting only has an effect when the line symbol is being used to render polygon rings.

See also

setDrawInsidePolygon()

Return type:

bool

penCapStyle(self) → Qt.PenCapStyle

Returns the pen cap style used to render the line (e.g. flat, square, round, etc).

See also

setPenCapStyle()

Return type:

Qt.PenCapStyle

penJoinStyle(self) → Qt.PenJoinStyle

Returns the pen join style used to render the line (e.g. miter, bevel, round, etc).

See also

setPenJoinStyle()

Return type:

Qt.PenJoinStyle

penStyle(self) → Qt.PenStyle

Returns the pen style used to render the line (e.g. solid, dashed, etc).

See also

setPenStyle()

Return type:

Qt.PenStyle

setAlignDashPattern(self, enabled: bool)

Sets whether dash patterns should be aligned to the start and end of lines, by applying subtle tweaks to the pattern sizing in order to ensure that the end of a line is represented by a complete dash element.

See also

alignDashPattern()

See also

setTweakDashPatternOnCorners()

Added in version 3.16.

Parameters:

enabled (bool)

setCustomDashPatternMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for lengths used in the custom dash pattern.

See also

customDashPatternMapUnitScale()

Parameters:

scale (QgsMapUnitScale)

setCustomDashPatternUnit(self, unit: Qgis.RenderUnit)

Sets the unit for lengths used in the custom dash pattern.

See also

customDashPatternUnit()

Parameters:

unit (Qgis.RenderUnit)

setCustomDashVector(self, vector: Iterable[float])

Sets the custom dash vector, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern.

Units for the vector are specified by customDashPatternUnit()

This setting is only used when useCustomDashPattern() returns True.

See also

customDashVector()

See also

setCustomDashPatternUnit()

See also

setUseCustomDashPattern()

Parameters:

vector (Iterable[float])

setDashPatternOffset(self, offset: float)

Sets the dash pattern offset, which dictates how far along the dash pattern the pattern should start rendering at.

Offset units are set via setDashPatternOffsetUnit().

See also

dashPatternOffset()

See also

setDashPatternOffsetUnit()

See also

setDashPatternOffsetMapUnitScale()

Added in version 3.16.

Parameters:

offset (float)

setDashPatternOffsetMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the dash pattern offset.

See also

dashPatternOffsetMapUnitScale()

See also

setDashPatternOffset()

See also

setDashPatternOffsetUnit()

Added in version 3.16.

Parameters:

scale (QgsMapUnitScale)

setDashPatternOffsetUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the dash pattern offset.

See also

dashPatternOffsetUnit()

See also

setDashPatternOffset()

See also

setDashPatternOffsetMapUnitScale()

Added in version 3.16.

Parameters:

unit (Qgis.RenderUnit)

setDrawInsidePolygon(self, drawInsidePolygon: bool)

Sets whether the line should only be drawn inside polygons, and any portion of the line which falls outside the polygon should be clipped away.

This setting only has an effect when the line symbol is being used to render polygon rings.

See also

drawInsidePolygon()

Parameters:

drawInsidePolygon (bool)

setPenCapStyle(self, style: Qt.PenCapStyle)

Sets the pen cap style used to render the line (e.g. flat, square, round, etc).

See also

penCapStyle()

Parameters:

style (Qt.PenCapStyle)

setPenJoinStyle(self, style: Qt.PenJoinStyle)

Sets the pen join style used to render the line (e.g. miter, bevel, round, etc).

See also

penJoinStyle()

Parameters:

style (Qt.PenJoinStyle)

setPenStyle(self, style: Qt.PenStyle)

Sets the pen style used to render the line (e.g. solid, dashed, etc).

See also

penStyle()

Parameters:

style (Qt.PenStyle)

setTrimDistanceEnd(self, distance: float)

Sets the trim distance for the end of the line, which dictates a length from the end of the line at which the actual rendering should end.

Trim units can be set by calling setTrimDistanceEndUnit().

See also

trimDistanceEnd()

See also

setTrimDistanceStart()

See also

setTrimDistanceEndUnit()

See also

setTrimDistanceEndMapUnitScale()

Added in version 3.20.

Parameters:

distance (float)

setTrimDistanceEndMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the trim distance for the end of the line.

See also

trimDistanceEndMapUnitScale()

See also

setTrimDistanceStartMapUnitScale()

See also

setTrimDistanceEnd()

See also

setTrimDistanceEndUnit()

Added in version 3.20.

Parameters:

scale (QgsMapUnitScale)

setTrimDistanceEndUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the trim distance for the end of the line.

See also

trimDistanceEndUnit()

See also

setTrimDistanceStartUnit()

See also

setTrimDistanceEnd()

See also

setTrimDistanceEndMapUnitScale()

Added in version 3.20.

Parameters:

unit (Qgis.RenderUnit)

setTrimDistanceStart(self, distance: float)

Sets the trim distance for the start of the line, which dictates a length from the start of the line at which the actual rendering should start.

Trim units can be set by calling setTrimDistanceStartUnit().

See also

trimDistanceStart()

See also

setTrimDistanceEnd()

See also

setTrimDistanceStartUnit()

See also

setTrimDistanceStartMapUnitScale()

Added in version 3.20.

Parameters:

distance (float)

setTrimDistanceStartMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the trim distance for the start of the line.

See also

trimDistanceStartMapUnitScale()

See also

setTrimDistanceEndMapUnitScale()

See also

setTrimDistanceStart()

See also

setTrimDistanceStartUnit()

Added in version 3.20.

Parameters:

scale (QgsMapUnitScale)

setTrimDistanceStartUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the trim distance for the start of the line.

See also

trimDistanceStartUnit()

See also

setTrimDistanceEndUnit()

See also

setTrimDistanceStart()

See also

setTrimDistanceStartMapUnitScale()

Added in version 3.20.

Parameters:

unit (Qgis.RenderUnit)

setTweakDashPatternOnCorners(self, enabled: bool)

Sets whether dash patterns tweaks should be applied on sharp corners, to ensure that a double-length dash is drawn running into and out of the corner.

Note

This setting is only applied if alignDashPattern() is True.

See also

tweakDashPatternOnCorners()

See also

setAlignDashPattern()

Added in version 3.16.

Parameters:

enabled (bool)

setUseCustomDashPattern(self, b: bool)

Sets whether the line uses a custom dash pattern.

See also

useCustomDashPattern()

See also

setCustomDashPatternUnit()

See also

setCustomDashVector()

Parameters:

b (bool)

trimDistanceEnd(self) → float

Returns the trim distance for the end of the line, which dictates a length from the end of the line at which the actual rendering should end.

Trim units can be retrieved by calling trimDistanceEndUnit().

See also

setTrimDistanceEnd()

See also

trimDistanceStart()

See also

trimDistanceEndUnit()

See also

trimDistanceEndMapUnitScale()

Added in version 3.20.

Return type:

float

trimDistanceEndMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the trim distance for the end of the line.

See also

setTrimDistanceEndMapUnitScale()

See also

trimDistanceStartMapUnitScale()

See also

trimDistanceEnd()

See also

trimDistanceEndUnit()

Added in version 3.20.

Return type:

QgsMapUnitScale

trimDistanceEndUnit(self) → Qgis.RenderUnit

Returns the unit for the trim distance for the end of the line.

See also

setTrimDistanceEndUnit()

See also

trimDistanceStartUnit()

See also

trimDistanceEnd()

See also

trimDistanceEndMapUnitScale()

Added in version 3.20.

Return type:

Qgis.RenderUnit

trimDistanceStart(self) → float

Returns the trim distance for the start of the line, which dictates a length from the start of the line at which the actual rendering should start.

Trim units can be retrieved by calling trimDistanceStartUnit().

See also

setTrimDistanceStart()

See also

trimDistanceEnd()

See also

trimDistanceStartUnit()

See also

trimDistanceStartMapUnitScale()

Added in version 3.20.

Return type:

float

trimDistanceStartMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the trim distance for the start of the line.

See also

setTrimDistanceStartMapUnitScale()

See also

trimDistanceEndMapUnitScale()

See also

trimDistanceStart()

See also

trimDistanceStartUnit()

Added in version 3.20.

Return type:

QgsMapUnitScale

trimDistanceStartUnit(self) → Qgis.RenderUnit

Returns the unit for the trim distance for the start of the line.

See also

setTrimDistanceStartUnit()

See also

trimDistanceEndUnit()

See also

trimDistanceStart()

See also

trimDistanceStartMapUnitScale()

Added in version 3.20.

Return type:

Qgis.RenderUnit

tweakDashPatternOnCorners(self) → bool

Returns True if dash patterns tweaks should be applied on sharp corners, to ensure that a double-length dash is drawn running into and out of the corner.

Note

This setting is only applied if alignDashPattern() is True.

See also

setTweakDashPatternOnCorners()

See also

alignDashPattern()

Added in version 3.16.

Return type:

bool

useCustomDashPattern(self) → bool

Returns True if the line uses a custom dash pattern.

See also

setUseCustomDashPattern()

See also

customDashPatternUnit()

See also

customDashVector()

Return type:

bool