Subgroup: Line

Class: QgsLineSymbolLayer¶

class qgis.core.QgsLineSymbolLayer(locked: bool = False)¶

Bases: qgis._core.QgsSymbolLayer

QgsLineSymbolLayer(QgsLineSymbolLayer)

Methods

clone Shall be reimplemented by subclasses to create a deep copy of the instance.

color The fill color.

copyDataDefinedProperties

copyPaintEffect

dataDefinedProperties Returns a reference to the symbol layer’s property collection, used for data defined overrides.

drawPreviewIcon

dxfAngle get angle

dxfBrushColor get brush/fill color

dxfBrushStyle get brush/fill style

dxfColor get color

dxfCustomDashPattern get dash pattern

dxfOffset get offset

dxfPenStyle get pen style

dxfWidth

enabled Returns true if symbol layer is enabled and will be drawn.

estimateMaxBleed Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context.

fillColor Get fill color.

isCompatibleWithSymbol Returns if the layer can be used below the specified symbol

isLocked

layerType Returns a string that represents this layer type.

mapUnitScale

offset

offsetMapUnitScale

offsetUnit Returns the units for the line’s offset.

ogrFeatureStyle

outputUnit

paintEffect Returns the current paint effect for the layer.

prepareExpressions Prepares all data defined property expressions for evaluation.

properties Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

propertyDefinitions Returns the symbol layer property definitions.

renderPolygonStroke

renderPolyline

renderingPass

restoreOldDataDefinedProperties

setColor The fill color.

setDataDefinedProperties Sets the symbol layer’s property collection, used for data defined overrides.

setDataDefinedProperty Sets a data defined property for the layer.

setEnabled Sets whether symbol layer is enabled and should be drawn.

setFillColor Set fill color.

setLocked

setMapUnitScale

setOffset

setOffsetMapUnitScale

setOffsetUnit Sets the units for the line’s offset.

setOutputUnit

setPaintEffect Sets the current paint effect for the layer.

setRenderingPass

setStrokeColor Set stroke color.

setSubSymbol set layer’s subsymbol. takes ownership of the passed symbol

setWidth

setWidthMapUnitScale

setWidthUnit Sets the units for the line’s width.

startRender

stopRender

strokeColor Get stroke color.

subSymbol Returns the symbol’s sub symbol, if present.

toSld

type

usedAttributes Returns the set of attributes referenced by the layer.

width

widthMapUnitScale

widthUnit Returns the units for the line’s width.

writeDxf write as DXF

Attributes

PropertyAngle

PropertyArrowHeadLength

PropertyArrowHeadThickness

PropertyArrowHeadType

PropertyArrowStartWidth

PropertyArrowType

PropertyArrowWidth

PropertyBlurRadius

PropertyCapStyle

PropertyCharacter

PropertyCoordinateMode

PropertyCustomDash

PropertyDisplacementX

PropertyDisplacementY

PropertyDistanceX

PropertyDistanceY

PropertyFile

PropertyFillColor

PropertyFillStyle

PropertyGradientReference1IsCentroid

PropertyGradientReference1X

PropertyGradientReference1Y

PropertyGradientReference2IsCentroid

PropertyGradientReference2X

PropertyGradientReference2Y

PropertyGradientSpread

PropertyGradientType

PropertyHeight

PropertyHorizontalAnchor

PropertyInterval

PropertyJoinStyle

PropertyLayerEnabled

PropertyLineAngle

PropertyLineDistance

PropertyName

PropertyOffset

PropertyOffsetAlongLine

PropertyOpacity

PropertyPlacement

PropertyPreserveAspectRatio

PropertySecondaryColor

PropertyShapeburstIgnoreRings

PropertyShapeburstMaxDistance

PropertyShapeburstUseWholeShape

PropertySize

PropertyStrokeColor

PropertyStrokeStyle

PropertyStrokeWidth

PropertyVerticalAnchor

PropertyWidth

copyDataDefinedProperties()¶

copyPaintEffect()¶

drawPreviewIcon(self, context: QgsSymbolRenderContext, size: QSize)¶

dxfWidth(self, e: QgsDxfExport, context: QgsSymbolRenderContext) → float¶

mapUnitScale(self) → QgsMapUnitScale¶

offset(self) → float¶

offsetMapUnitScale(self) → QgsMapUnitScale¶

offsetUnit(self) → QgsUnitTypes.RenderUnit¶: Returns the units for the line’s offset.

See also

setOffsetUnit()

outputUnit(self) → QgsUnitTypes.RenderUnit¶

renderPolygonStroke(self, points: QPolygonF, rings: Iterable[QPolygonF], context: QgsSymbolRenderContext)¶

renderPolyline(self, points: QPolygonF, context: QgsSymbolRenderContext)¶

restoreOldDataDefinedProperties()¶

setMapUnitScale(self, scale: QgsMapUnitScale)¶

setOffset(self, offset: float)¶

setOffsetMapUnitScale(self, scale: QgsMapUnitScale)¶

setOffsetUnit(self, unit: QgsUnitTypes.RenderUnit)¶

Sets the units for the line’s offset.

Parameters:	unit – offset units