Class: QgsSimpleLineSymbolLayer¶
-
class
qgis.core.
QgsSimpleLineSymbolLayer
(color: Union[QColor, Qt.GlobalColor] = DEFAULT_SIMPLELINE_COLOR, width: float = DEFAULT_SIMPLELINE_WIDTH, penStyle: Qt.PenStyle = DEFAULT_SIMPLELINE_PENSTYLE)¶ Bases:
QgsLineSymbolLayer
Constructor for
QgsSimpleLineSymbolLayer
. Creates a simple line symbol in the specifiedcolor
,width
(in millimeters) andpenStyle
.A simple line symbol layer, which renders lines using a line in a variety of styles (e.g. solid, dotted, dashed).
- Parameters
color (Union[QColor) –
width (float = DEFAULT_SIMPLELINE_WIDTH) –
penStyle –
-
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, str] = {}) → QgsSymbolLayer¶ Creates a new
QgsSimpleLineSymbolLayer
, using the settings serialized in theproperties
map (corresponding to the output from QgsSimpleLineSymbolLayer.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() returns
True
.See also
See also
See also
- Return type
List[float]
-
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, str]¶ - Return type
Dict[str, str]
-
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, str])¶ Restores older data defined properties from string map.
New in version 3.0.
-
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() returns
True
.See also
See also
See also
- Parameters
vector (Iterable[float]) –
-
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) –
-
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, str])¶ - Parameters
doc (QDomDocument) –
element (QDomElement) –
props (Dict[str) –
-
useCustomDashPattern
(self) → bool¶ Returns
True
if the line uses a custom dash pattern.See also
See also
See also
- Return type
bool