Class: QgsSimpleLineSymbolLayer¶
- class qgis.core.QgsSimpleLineSymbolLayer¶
Bases:
QgsLineSymbolLayer
A simple line symbol layer, which renders lines using a line in a variety of styles (e.g. solid, dotted, dashed).
QgsSimpleLineSymbolLayer(color: Union[QColor, Qt.GlobalColor, QGradient] = DEFAULT_SIMPLELINE_COLOR, width: float = DEFAULT_SIMPLELINE_WIDTH, penStyle: Qt.PenStyle = DEFAULT_SIMPLELINE_PENSTYLE) Constructor for
QgsSimpleLineSymbolLayer
. Creates a simple line symbol in the specifiedcolor
,width
(in millimeters) andpenStyle
.Methods
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.- rtype:
bool
- rtype:
QgsSimpleLineSymbolLayer
Copies all data defined properties of this layer to another symbol layer.
Copies paint effect of this layer to another symbol layer
Creates a new
QgsSimpleLineSymbolLayer
, using the settings serialized in theproperties
map (corresponding to the output fromQgsSimpleLineSymbolLayer.properties()
).Creates a new
QgsSimpleLineSymbolLayer
from an SLD XML DOMelement
.Returns the map unit scale for lengths used in the custom dash pattern.
Returns the units for lengths used in the custom dash pattern.
Returns the custom dash vector, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern.
Returns the dash pattern offset, which dictates how far along the dash pattern the pattern should start rendering at.
Returns the map unit scale for the dash pattern offset value.
Returns the units for the dash pattern offset.
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.- param context:
- rtype:
Tuple[List[float], QgsUnitTypes.RenderUnit]
- param e:
- rtype:
Qt.PenStyle
- param e:
- param context:
- rtype:
str
- rtype:
QgsMapUnitScale
- param mmScaleFactor:
- rtype:
QgsUnitTypes.RenderUnit
Returns the pen cap style used to render the line (e.g.
Returns the pen join style used to render the line (e.g.
Returns the pen style used to render the line (e.g.
- rtype:
Dict[str, Any]
- param points:
- param points:
Restores older data defined properties from string map.
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.
Sets the map unit
scale
for lengths used in the custom dash pattern.Sets the
unit
for lengths used in the custom dash pattern.Sets the custom dash
vector
, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern.Sets the dash pattern
offset
, which dictates how far along the dash pattern the pattern should start rendering at.Sets the map unit
scale
for the dash pattern offset.Sets the
unit
for the dash pattern offset.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.
- param scale:
- param unit:
Sets the pen cap
style
used to render the line (e.g.Sets the pen join
style
used to render the line (e.g.Sets the pen
style
used to render the line (e.g.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.Sets the map unit
scale
for the trim distance for the end of the line.Sets the
unit
for the trim distance for the end of the line.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.Sets the map unit
scale
for the trim distance for the start of the line.Sets the
unit
for the trim distance for the start of the line.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.
Sets whether the line uses a custom dash pattern.
- param context:
- param context:
- param doc:
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.
Returns the map unit scale for the trim distance for the end of the line.
Returns the unit for the trim distance for the end of the line.
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.
Returns the map unit scale for the trim distance for the start of the line.
Returns the unit for the trim distance for the start of the line.
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.Returns
True
if the line uses a custom dash pattern.- rtype:
bool
- 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
See also
New in version 3.16.
- Return type:
bool
- canCauseArtifactsBetweenAdjacentTiles(self) bool ¶
- Return type:
bool
- clone(self) QgsSimpleLineSymbolLayer ¶
- Return type:
- 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.
- create(properties: Dict[str, Any] = {}) QgsSymbolLayer ¶
Creates a new
QgsSimpleLineSymbolLayer
, using the settings serialized in theproperties
map (corresponding to the output fromQgsSimpleLineSymbolLayer.properties()
).- Parameters:
properties (Dict[str) –
- Return type:
- createFromSld(element: QDomElement) QgsSymbolLayer ¶
Creates a new
QgsSimpleLineSymbolLayer
from an SLD XML DOMelement
.- Parameters:
element (QDomElement) –
- Return type:
- customDashPatternMapUnitScale(self) QgsMapUnitScale ¶
Returns the map unit scale for lengths used in the custom dash pattern.
See also
- Return type:
- customDashPatternUnit(self) QgsUnitTypes.RenderUnit ¶
Returns the units for lengths used in the custom dash pattern.
See also
- Return type:
- 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()
returnsTrue
.See also
See also
See also
- 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
See also
See also
New in version 3.16.
- Return type:
float
- dashPatternOffsetMapUnitScale(self) QgsMapUnitScale ¶
Returns the map unit scale for the dash pattern offset value.
See also
See also
See also
New in version 3.16.
- Return type:
- dashPatternOffsetUnit(self) QgsUnitTypes.RenderUnit ¶
Returns the units for the dash pattern offset.
See also
See also
See also
New in version 3.16.
- Return type:
- 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
- Return type:
bool
- dxfColor(self, context: QgsSymbolRenderContext) QColor ¶
- Parameters:
context (QgsSymbolRenderContext) –
- Return type:
QColor
- dxfCustomDashPattern(self) Tuple[List[float], QgsUnitTypes.RenderUnit] ¶
- Return type:
Tuple[List[float], QgsUnitTypes.RenderUnit]
- dxfOffset(self, e: QgsDxfExport, context: QgsSymbolRenderContext) float ¶
- Parameters:
e (QgsDxfExport) –
context (QgsSymbolRenderContext) –
- Return type:
float
- dxfPenStyle(self) Qt.PenStyle ¶
- Return type:
Qt.PenStyle
- dxfWidth(self, e: QgsDxfExport, context: QgsSymbolRenderContext) float ¶
- Parameters:
e (QgsDxfExport) –
context (QgsSymbolRenderContext) –
- Return type:
float
- estimateMaxBleed(self, context: QgsRenderContext) float ¶
- Parameters:
context (QgsRenderContext) –
- Return type:
float
- layerType(self) str ¶
- Return type:
str
- mapUnitScale(self) QgsMapUnitScale ¶
- Return type:
- ogrFeatureStyle(self, mmScaleFactor: float, mapUnitScaleFactor: float) str ¶
- Parameters:
mmScaleFactor (float) –
mapUnitScaleFactor (float) –
- Return type:
str
- outputUnit(self) QgsUnitTypes.RenderUnit ¶
- Return type:
- penCapStyle(self) Qt.PenCapStyle ¶
Returns the pen cap style used to render the line (e.g. flat, square, round, etc).
See also
- 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
- Return type:
Qt.PenJoinStyle
- penStyle(self) Qt.PenStyle ¶
Returns the pen style used to render the line (e.g. solid, dashed, etc).
See also
- Return type:
Qt.PenStyle
- properties(self) Dict[str, Any] ¶
- Return type:
Dict[str, Any]
- renderPolygonStroke(self, points: QPolygonF, rings: Iterable[QPolygonF], context: QgsSymbolRenderContext)¶
- Parameters:
points (QPolygonF) –
rings (Iterable[QPolygonF]) –
context (QgsSymbolRenderContext) –
- renderPolyline(self, points: QPolygonF, context: QgsSymbolRenderContext)¶
- Parameters:
points (QPolygonF) –
context (QgsSymbolRenderContext) –
- restoreOldDataDefinedProperties(self, stringMap: Dict[str, Any])¶
Restores older data defined properties from string map.
New in version 3.0.
- 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
See also
New 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
- Parameters:
scale (QgsMapUnitScale) –
- setCustomDashPatternUnit(self, unit: QgsUnitTypes.RenderUnit)¶
Sets the
unit
for lengths used in the custom dash pattern.See also
- Parameters:
unit (QgsUnitTypes.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()
returnsTrue
.See also
See also
See also
- 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
See also
See also
New in version 3.16.
- Parameters:
offset (float) –
- setDashPatternOffsetMapUnitScale(self, scale: QgsMapUnitScale)¶
Sets the map unit
scale
for the dash pattern offset.See also
See also
See also
New in version 3.16.
- Parameters:
scale (QgsMapUnitScale) –
- setDashPatternOffsetUnit(self, unit: QgsUnitTypes.RenderUnit)¶
Sets the
unit
for the dash pattern offset.See also
See also
See also
New in version 3.16.
- Parameters:
unit (QgsUnitTypes.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
- Parameters:
drawInsidePolygon (bool) –
- setMapUnitScale(self, scale: QgsMapUnitScale)¶
- Parameters:
scale (QgsMapUnitScale) –
- setOutputUnit(self, unit: QgsUnitTypes.RenderUnit)¶
- Parameters:
unit (QgsUnitTypes.RenderUnit) –
- setPenCapStyle(self, style: Qt.PenCapStyle)¶
Sets the pen cap
style
used to render the line (e.g. flat, square, round, etc).See also
- 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
- 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
- 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
See also
See also
See also
New 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
See also
See also
See also
New in version 3.20.
- Parameters:
scale (QgsMapUnitScale) –
- setTrimDistanceEndUnit(self, unit: QgsUnitTypes.RenderUnit)¶
Sets the
unit
for the trim distance for the end of the line.See also
See also
See also
See also
New in version 3.20.
- Parameters:
unit (QgsUnitTypes.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
See also
See also
See also
New 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
See also
See also
See also
New in version 3.20.
- Parameters:
scale (QgsMapUnitScale) –
- setTrimDistanceStartUnit(self, unit: QgsUnitTypes.RenderUnit)¶
Sets the
unit
for the trim distance for the start of the line.See also
See also
See also
See also
New in version 3.20.
- Parameters:
unit (QgsUnitTypes.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()
isTrue
.See also
See also
New in version 3.16.
- Parameters:
enabled (bool) –
- setUseCustomDashPattern(self, b: bool)¶
Sets whether the line uses a custom dash pattern.
See also
See also
See also
- Parameters:
b (bool) –
- startRender(self, context: QgsSymbolRenderContext)¶
- Parameters:
context (QgsSymbolRenderContext) –
- stopRender(self, context: QgsSymbolRenderContext)¶
- Parameters:
context (QgsSymbolRenderContext) –
- toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, Any])¶
- Parameters:
doc (QDomDocument) –
element (QDomElement) –
props (Dict[str) –
- 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
See also
See also
See also
New 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
See also
See also
See also
New in version 3.20.
- Return type:
- trimDistanceEndUnit(self) QgsUnitTypes.RenderUnit ¶
Returns the unit for the trim distance for the end of the line.
See also
See also
See also
See also
New in version 3.20.
- Return type:
- 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
See also
See also
See also
New 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
See also
See also
See also
New in version 3.20.
- Return type:
- trimDistanceStartUnit(self) QgsUnitTypes.RenderUnit ¶
Returns the unit for the trim distance for the start of the line.
See also
See also
See also
See also
New in version 3.20.
- Return type:
- 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()
isTrue
.See also
See also
New in version 3.16.
- Return type:
bool
- useCustomDashPattern(self) bool ¶
Returns
True
if the line uses a custom dash pattern.See also
See also
See also
- Return type:
bool
- usesMapUnits(self) bool ¶
- Return type:
bool