Class: QgsSVGFillSymbolLayer¶

class qgis.core.QgsSVGFillSymbolLayer¶

Bases: QgsImageFillSymbolLayer

A class for filling symbols with a repeated SVG file.

QgsSVGFillSymbolLayer(svgFilePath: str, width: float = 20, rotation: float = 0) Constructor for QgsSVGFillSymbolLayer, using the SVG picture at the specified absolute file path.

QgsSVGFillSymbolLayer(svgData: Union[QByteArray, bytes, bytearray], width: float = 20, rotation: float = 0) Constructor for QgsSVGFillSymbolLayer, using the specified SVG picture data.

Methods

applyBrushTransformFromContext

Returns True if the image brush should be transformed using the render context's texture origin.

applyDataDefinedSettings

param context:

clone

rtype:

QgsSVGFillSymbolLayer

copyDataDefinedProperties

Copies all data defined properties of this layer to another symbol layer.

copyPaintEffect

Copies paint effect of this layer to another symbol layer

create

Creates a new QgsSVGFillSymbolLayer from a properties map.

createFromSld

Creates a new QgsSVGFillSymbolLayer from a SLD element.

dxfColor

param context:

estimateMaxBleed

param context:

hasDataDefinedProperties

rtype:

bool

layerType

rtype:

str

mapUnitScale

rtype:

QgsMapUnitScale

outputUnit

rtype:

QgsUnitTypes.RenderUnit

parameters

Returns the dynamic SVG parameters

patternWidth

Returns the width of the rendered SVG content within the fill (i.e.

patternWidthMapUnitScale

Returns the map unit scale for the pattern's width.

patternWidthUnit

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

properties

rtype:

Dict[str, Any]

renderPolygon

param points:

resolvePaths

Turns relative paths in properties map to absolute when reading and vice versa when writing.

restoreOldDataDefinedProperties

Restores older data defined properties from string map.

setMapUnitScale

param scale:

setOutputUnit

param unit:

setParameters

Sets the dynamic SVG parameters

setPatternWidth

Sets the width to render the SVG content as within the fill (i.e.

setPatternWidthMapUnitScale

Sets the map unit scale for the pattern's width.

setPatternWidthUnit

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

setSubSymbol

param symbol:

setSvgFilePath

Sets the path to the SVG file to render in the fill.

setSvgFillColor

Sets the fill color used for rendering the SVG content.

setSvgStrokeColor

Sets the stroke color used for rendering the SVG content.

setSvgStrokeWidth

Sets the stroke width used for rendering the SVG content.

setSvgStrokeWidthMapUnitScale

Sets the map unit scale for the pattern's stroke.

setSvgStrokeWidthUnit

Sets the unit for the stroke width.

startRender

param context:

stopRender

param context:

subSymbol

rtype:

QgsSymbol

svgFilePath

Returns the path to the SVG file used to render the fill.

svgFillColor

Returns the fill color used for rendering the SVG content.

svgStrokeColor

Returns the stroke color used for rendering the SVG content.

svgStrokeWidth

Returns the stroke width used for rendering the SVG content.

svgStrokeWidthMapUnitScale

Returns the map unit scale for the pattern's stroke.

svgStrokeWidthUnit

Returns the units for the stroke width.

toSld

param doc:

usedAttributes

param context:

usesMapUnits

rtype:

bool

applyBrushTransformFromContext(self, context: QgsSymbolRenderContext = None) → bool¶: Returns True if the image brush should be transformed using the render context’s texture origin.

New in version 3.16.

applyDataDefinedSettings(self, context: QgsSymbolRenderContext)¶

Parameters:: context (QgsSymbolRenderContext) –

clone(self) → QgsSVGFillSymbolLayer¶

Return type:: QgsSVGFillSymbolLayer

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 QgsSVGFillSymbolLayer from a properties map. The caller takes ownership of the returned object.

Parameters:: properties (Dict[str) –
Return type:: QgsSymbolLayer

createFromSld(element: QDomElement) → QgsSymbolLayer¶

Creates a new QgsSVGFillSymbolLayer from a SLD element. The caller takes ownership of the returned object.

Parameters:: element (QDomElement) –
Return type:: QgsSymbolLayer

dxfColor(self, context: QgsSymbolRenderContext) → QColor¶

Parameters:: context (QgsSymbolRenderContext) –
Return type:: QColor

estimateMaxBleed(self, context: QgsRenderContext) → float¶

Parameters:: context (QgsRenderContext) –
Return type:: float

hasDataDefinedProperties(self) → bool¶

Return type:: bool

layerType(self) → str¶

Return type:: str

mapUnitScale(self) → QgsMapUnitScale¶

Return type:: QgsMapUnitScale

outputUnit(self) → QgsUnitTypes.RenderUnit¶

Return type:: QgsUnitTypes.RenderUnit

parameters(self) → Dict[str, QgsProperty]¶

Returns the dynamic SVG parameters

New in version 3.18.

Return type:: Dict[str, QgsProperty]

patternWidth(self) → float¶

Returns the width of the rendered SVG content within the fill (i.e. the pattern repeat/tile size).

Units are retrieved by patternWidthUnit()

See also

setPatternWidth()

See also

patternWidthUnit()

See also

patternWidthMapUnitScale()

Return type:: float

patternWidthMapUnitScale(self) → QgsMapUnitScale¶

Returns the map unit scale for the pattern’s width.

See also

setPatternWidthMapUnitScale()

See also

patternWidth()

See also

patternWidthUnit()

Return type:: QgsMapUnitScale

patternWidthUnit(self) → QgsUnitTypes.RenderUnit¶

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

See also

setPatternWidthUnit()

See also

patternWidth()

See also

patternWidthMapUnitScale()

Return type:: QgsUnitTypes.RenderUnit

properties(self) → Dict[str, Any]¶

Return type:: Dict[str, Any]

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

Parameters:

points (QPolygonF) –
rings (Iterable[QPolygonF]) –
context (QgsSymbolRenderContext) –

resolvePaths(properties: Dict[str, Any], 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.

Parameters:

properties (Dict[str) –
pathResolver (QgsPathResolver) –
saving (bool) –

restoreOldDataDefinedProperties(self, stringMap: Dict[str, Any])¶: Restores older data defined properties from string map.

New in version 3.0.