Class: QgsFilledLineSymbolLayer¶
- class qgis.core.QgsFilledLineSymbolLayer¶
Bases:
QgsLineSymbolLayer
A line symbol layer type which fills a stroked line with a
QgsFillSymbol
.New in version 3.36.
QgsFilledLineSymbolLayer(width: float = DEFAULT_SIMPLELINE_WIDTH, fillSymbol:
QgsFillSymbol
= None) Constructor for QgsFilledLineSymbolLayer.If a
fillSymbol
is specified, it will be transferred to the symbol layer and used to fill the inside of the stroked line. If nofillSymbol
is specified then a default symbol will be used.Methods
- rtype:
QgsFilledLineSymbolLayer
- rtype:
QColor
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
QgsFilledLineSymbolLayer
, using the settings serialized in theproperties
map (corresponding to the output fromQgsFilledLineSymbolLayer.properties()
).- param context:
- rtype:
bool
When rendering, install masks on
context
painter ifrecursive
isTrue
masks are installed recursively for all children symbol layers- rtype:
str
- rtype:
QgsMapUnitScale
- rtype:
Qgis.RenderUnit
Returns the pen cap style used to render the line (e.g. flat, square, round, etc).
Returns the pen join style used to render the line (e.g. miter, bevel, round, etc).
- rtype:
Dict[str, Any]
When rendering, remove previously installed masks from
context
painter ifrecursive
isTrue
masks are removed recursively for all children symbol layers- param points:
Restores older data defined properties from string map.
- param c:
- param scale:
- param unit:
Sets the pen cap
style
used to render the line (e.g. flat, square, round, etc).Sets the pen join
style
used to render the line (e.g. miter, bevel, round, etc).- param symbol:
Returns
True
if the symbol layer should be rendered using the selection color from the render context.- param context:
- param context:
- rtype:
QgsSymbol
- param context:
- rtype:
bool
- clone(self) QgsFilledLineSymbolLayer ¶
- Return type:
- color(self) QColor ¶
- Return type:
QColor
- 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
QgsFilledLineSymbolLayer
, using the settings serialized in theproperties
map (corresponding to the output fromQgsFilledLineSymbolLayer.properties()
).- Parameters:
properties (Dict[str) –
- Return type:
- estimateMaxBleed(self, context: QgsRenderContext) float ¶
- Parameters:
context (QgsRenderContext) –
- Return type:
float
- hasDataDefinedProperties(self) bool ¶
- Return type:
bool
- installMasks(self, context: QgsRenderContext, recursive: bool)¶
When rendering, install masks on
context
painter ifrecursive
isTrue
masks are installed recursively for all children symbol layersSee also
prepareMasks()
See also
New in version 3.30.
- layerType(self) str ¶
- Return type:
str
- mapUnitScale(self) QgsMapUnitScale ¶
- Return type:
- outputUnit(self) Qgis.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
- properties(self) Dict[str, Any] ¶
- Return type:
Dict[str, Any]
- removeMasks(self, context: QgsRenderContext, recursive: bool)¶
When rendering, remove previously installed masks from
context
painter ifrecursive
isTrue
masks are removed recursively for all children symbol layersSee also
prepareMasks()
See also
New in version 3.30.
- 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.
- setColor(self, c: QColor | Qt.GlobalColor)¶
- Parameters:
c (Union[QColor) –
- setMapUnitScale(self, scale: QgsMapUnitScale)¶
- Parameters:
scale (QgsMapUnitScale) –
- setOutputUnit(self, unit: Qgis.RenderUnit)¶
- Parameters:
unit (Qgis.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) –
- shouldRenderUsingSelectionColor(self, context: QgsSymbolRenderContext) bool ¶
Returns
True
if the symbol layer should be rendered using the selection color from the render context.New in version 3.34.
- startRender(self, context: QgsSymbolRenderContext)¶
- Parameters:
context (QgsSymbolRenderContext) –
- stopRender(self, context: QgsSymbolRenderContext)¶
- Parameters:
context (QgsSymbolRenderContext) –
- usedAttributes(self, context: QgsRenderContext) Set[str] ¶
- Parameters:
context (QgsRenderContext) –
- Return type:
Set[str]
- usesMapUnits(self) bool ¶
- Return type:
bool