Subgroup: S

Class: QgsSVGFillSymbolLayer

class qgis.core.QgsSVGFillSymbolLayer

Bases: qgis._core.QgsImageFillSymbolLayer

A class for svg fill patterns. The class automatically scales the pattern to the appropriate pixel dimensions of the output device*

Methods

angle
applyDataDefinedSettings
clone
color The fill color.
copyDataDefinedProperties
copyPaintEffect
create
createFromSld
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
dxfCustomDashPattern get dash pattern
dxfOffset get offset
dxfPenStyle
dxfWidth
enabled Returns true if symbol layer is enabled and will be drawn.
estimateMaxBleed
fillColor Get fill color.
isCompatibleWithSymbol Returns if the layer can be used below the specified symbol
isLocked
layerType
mapUnitScale
ogrFeatureStyle
outputUnit
paintEffect Returns the current paint effect for the layer.
patternWidth
patternWidthMapUnitScale
patternWidthUnit Returns the units for the width of the SVG images in the pattern.
prepareExpressions Prepares all data defined property expressions for evaluation.
properties
propertyDefinitions Returns the symbol layer property definitions.
renderPolygon
renderingPass
resolvePaths Turns relative paths in properties map to absolute when reading and vice versa when writing.
restoreOldDataDefinedProperties
setAngle
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
setOutputUnit
setPaintEffect Sets the current paint effect for the layer.
setPatternWidth
setPatternWidthMapUnitScale
setPatternWidthUnit Sets the units for the width of the SVG images in the pattern.
setRenderingPass
setStrokeColor Set stroke color.
setStrokeWidthMapUnitScale
setStrokeWidthUnit Sets the units for the symbol’s stroke width.
setSubSymbol
setSvgFilePath
setSvgFillColor
setSvgStrokeColor
setSvgStrokeWidth
setSvgStrokeWidthMapUnitScale
setSvgStrokeWidthUnit Sets the units for the stroke width.
startRender
stopRender
strokeColor Get stroke color.
strokeWidthMapUnitScale
strokeWidthUnit Returns the units for the symbol’s stroke width.
subSymbol
svgFilePath
svgFillColor
svgStrokeColor
svgStrokeWidth
svgStrokeWidthMapUnitScale
svgStrokeWidthUnit Returns the units for the stroke width.
toSld
type
usedAttributes
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
applyDataDefinedSettings(self, context: QgsSymbolRenderContext)
clone(self) → QgsSVGFillSymbolLayer
copyDataDefinedProperties()
copyPaintEffect()
create(properties: Dict[str, str] = {}) → QgsSymbolLayer
createFromSld(element: QDomElement) → QgsSymbolLayer
layerType(self) → str
mapUnitScale(self) → QgsMapUnitScale
outputUnit(self) → QgsUnitTypes.RenderUnit
patternWidth(self) → float
patternWidthMapUnitScale(self) → QgsMapUnitScale
patternWidthUnit(self) → QgsUnitTypes.RenderUnit

Returns the units for the width of the SVG images in the pattern.

properties(self) → Dict[str, str]
resolvePaths(properties: Dict[str, str], pathResolver: QgsPathResolver, saving: bool)

Turns relative paths in properties map to absolute when reading and vice versa when writing. Used internally when reading/writing symbols.

New in version 3.0.

restoreOldDataDefinedProperties()
setMapUnitScale(self, scale: QgsMapUnitScale)
setOutputUnit(self, unit: QgsUnitTypes.RenderUnit)
setPatternWidth(self, width: float)
setPatternWidthMapUnitScale(self, scale: QgsMapUnitScale)
setPatternWidthUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units for the width of the SVG images in the pattern.

Parameters:unit – width units
setSvgFilePath(self, svgPath: str)
setSvgFillColor(self, c: Union[QColor, Qt.GlobalColor])
setSvgStrokeColor(self, c: Union[QColor, Qt.GlobalColor])
setSvgStrokeWidth(self, w: float)
setSvgStrokeWidthMapUnitScale(self, scale: QgsMapUnitScale)
setSvgStrokeWidthUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the units for the stroke width.

Parameters:unit – width units
startRender(self, context: QgsSymbolRenderContext)
stopRender(self, context: QgsSymbolRenderContext)
svgFilePath(self) → str
svgFillColor(self) → QColor
svgStrokeColor(self) → QColor
svgStrokeWidth(self) → float
svgStrokeWidthMapUnitScale(self) → QgsMapUnitScale
svgStrokeWidthUnit(self) → QgsUnitTypes.RenderUnit

Returns the units for the stroke width.

toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str])