Class: QgsLineSymbolLayer¶
-
class
qgis.core.
QgsLineSymbolLayer
(locked: bool = False)¶ Bases:
QgsSymbolLayer
- Parameters
locked –
-
AllRings
= 0¶
-
ExteriorRingOnly
= 1¶
-
InteriorRingsOnly
= 2¶
-
class
RenderRingFilter
¶ Bases:
int
-
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.
-
drawPreviewIcon
(self, context: QgsSymbolRenderContext, size: QSize)¶ - Parameters
context (QgsSymbolRenderContext) –
size (QSize) –
-
dxfWidth
(self, e: QgsDxfExport, context: QgsSymbolRenderContext) → float¶ - Parameters
e (QgsDxfExport) –
context (QgsSymbolRenderContext) –
- Return type
float
-
mapUnitScale
(self) → QgsMapUnitScale¶ - Return type
-
offset
(self) → float¶ Returns the line’s offset.
Offset units can be retrieved by calling
offsetUnit()
.See also
See also
See also
- Return type
float
-
offsetMapUnitScale
(self) → QgsMapUnitScale¶ Returns the map unit scale for the line’s offset.
See also
See also
See also
- Return type
-
offsetUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units for the line’s offset.
See also
See also
See also
- Return type
-
outputUnit
(self) → QgsUnitTypes.RenderUnit¶ - Return type
-
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 therings
argument.See also
- Parameters
points (QPolygonF) –
rings (Iterable[QPolygonF]) –
context (QgsSymbolRenderContext) –
-
renderPolyline
(self, points: QPolygonF, context: QgsSymbolRenderContext)¶ Renders the line symbol layer along the line joining
points
, using the given rendercontext
.See also
- Parameters
points (QPolygonF) –
context (QgsSymbolRenderContext) –
-
restoreOldDataDefinedProperties
(self, stringMap: Dict[str, str])¶ Restores older data defined properties from string map.
New in version 3.0.
-
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
New in version 3.6.
- Return type
-
setMapUnitScale
(self, scale: QgsMapUnitScale)¶ - Parameters
scale (QgsMapUnitScale) –
-
setOffset
(self, offset: float)¶ Sets the line’s
offset
.Offset units are set via
setOffsetUnit()
.See also
See also
See also
- Parameters
offset (float) –
-
setOffsetMapUnitScale
(self, scale: QgsMapUnitScale)¶ Sets the map unit
scale
for the line’s offset.See also
See also
See also
- Parameters
scale (QgsMapUnitScale) –
-
setOffsetUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ Sets the
unit
for the line’s offset.See also
See also
See also
- Parameters
unit (QgsUnitTypes.RenderUnit) –
-
setOutputUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ QgsLineSymbolLayer
cannot be copied- Parameters
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
New in version 3.6.
- Parameters
filter (QgsLineSymbolLayer.RenderRingFilter) –
-
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
Warning
Since the width units vary, this method is useful for changing the relative width of a line symbol layer only.
- Parameters
width (float) –
-
setWidthMapUnitScale
(self, scale: QgsMapUnitScale)¶ - Parameters
scale (QgsMapUnitScale) –
-
setWidthUnit
(self, unit: QgsUnitTypes.RenderUnit)¶ Sets the units for the line’s width.
- Parameters
unit (QgsUnitTypes.RenderUnit) – width units
See also
-
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
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
New in version 3.4.5.
- Return type
float
-
widthMapUnitScale
(self) → QgsMapUnitScale¶ - Return type
-
widthUnit
(self) → QgsUnitTypes.RenderUnit¶ Returns the units for the line’s width.
See also
- Return type