Class: QgsLinePatternFillSymbolLayer¶

class qgis.core.QgsLinePatternFillSymbolLayer¶

Bases: QgsImageFillSymbolLayer

A symbol fill consisting of repeated parallel lines.

Methods

applyBrushTransformFromContext

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

applyDataDefinedSettings

param context:

clone

rtype:

QgsLinePatternFillSymbolLayer

color

rtype:

QColor

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 QgsLinePatternFillSymbolLayer from a properties map.

createFromSld

Creates a new QgsLinePatternFillSymbolLayer from a SLD element.

distance

Returns the distance between lines in the fill pattern.

distanceMapUnitScale

Returns the map unit scale for the pattern's line distance.

distanceUnit

Returns the units for the distance between lines in the fill pattern.

estimateMaxBleed

param context:

hasDataDefinedProperties

rtype:

bool

layerType

rtype:

str

lineAngle

Returns the angle for the parallel lines used to fill the symbol.

lineWidth

Returns the width of the line subsymbol used to render the parallel lines in the fill.

lineWidthMapUnitScale

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

lineWidthUnit

Returns the units for the line's width.

mapUnitScale

rtype:

QgsMapUnitScale

offset

Returns the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position.

offsetMapUnitScale

Returns the map unit scale for the pattern's line offset.

offsetUnit

Returns the units for the line pattern's offset.

ogrFeatureStyleWidth

param widthScaleFactor:

outputUnit

rtype:

QgsUnitTypes.RenderUnit

properties

rtype:

Dict[str, Any]

restoreOldDataDefinedProperties

Restores older data defined properties from string map.

setColor

param c:

setDistance

Sets the distance between lines in the fill pattern.

setDistanceMapUnitScale

Sets the map unit scale for the pattern's line distance.

setDistanceUnit

Sets the unit for the distance between lines in the fill pattern.

setLineAngle

Sets the angle for the parallel lines used to fill the symbol.

setLineWidth

Sets the width of the line subsymbol used to render the parallel lines in the fill.

setLineWidthMapUnitScale

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

setLineWidthUnit

Sets the unit for the line's width.

setMapUnitScale

param scale:

setOffset

Sets the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position.

setOffsetMapUnitScale

Sets the map unit scale for the pattern's line offset.

setOffsetUnit

Sets the unit for the line pattern's offset.

setOutputUnit

param unit:

setSubSymbol

param symbol:

startRender

param context:

stopRender

param context:

subSymbol

rtype:

QgsSymbol

toSld

param doc:

usedAttributes

param context:

usesMapUnits

rtype:

bool

applyBrushTransformFromContext(self) → 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) → QgsLinePatternFillSymbolLayer¶

Return type:: QgsLinePatternFillSymbolLayer

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 QgsLinePatternFillSymbolLayer 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 QgsLinePatternFillSymbolLayer from a SLD element. The caller takes ownership of the returned object.

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

distance(self) → float¶

Returns the distance between lines in the fill pattern. Units are retrieved by distanceUnit().

See also

setDistance()

See also

distanceUnit()

Return type:: float

distanceMapUnitScale(self) → QgsMapUnitScale¶

Returns the map unit scale for the pattern’s line distance.

See also

setDistanceMapUnitScale()

See also

distance()

See also

distanceUnit()

Return type:: QgsMapUnitScale

distanceUnit(self) → QgsUnitTypes.RenderUnit¶

Returns the units for the distance between lines in the fill pattern.

See also

setDistanceUnit()

See also

distance()

Return type:: QgsUnitTypes.RenderUnit

estimateMaxBleed(self, context: QgsRenderContext) → float¶

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

hasDataDefinedProperties(self) → bool¶

Return type:: bool

layerType(self) → str¶

Return type:: str

lineAngle(self) → float¶

Returns the angle for the parallel lines used to fill the symbol.

Angles are in degrees, clockwise from North.

See also

setLineAngle()

Return type:: float

lineWidth(self) → float¶

Returns the width of the line subsymbol used to render the parallel lines in the fill.

See also

setLineWidth()

Return type:: float

lineWidthMapUnitScale(self) → QgsMapUnitScale¶

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

See also

setLineWidthMapUnitScale()

See also

lineWidth()

See also

lineWidthUnit()

Return type:: QgsMapUnitScale

lineWidthUnit(self) → QgsUnitTypes.RenderUnit¶

Returns the units for the line’s width.

See also

setLineWidthUnit()

Return type:: QgsUnitTypes.RenderUnit

mapUnitScale(self) → QgsMapUnitScale¶

Return type:: QgsMapUnitScale

offset(self) → float¶

Returns the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position.

Units are retrieved via offsetUnit().

See also

setOffset()

See also

offsetUnit()

See also

offsetMapUnitScale()

Return type:: float

offsetMapUnitScale(self) → QgsMapUnitScale¶

Returns the map unit scale for the pattern’s line offset.

See also

setOffsetMapUnitScale()

See also

offset()

See also

offsetUnit()

Return type:: QgsMapUnitScale

offsetUnit(self) → QgsUnitTypes.RenderUnit¶

Returns the units for the line pattern’s offset.

See also

setOffsetUnit()

Return type:: QgsUnitTypes.RenderUnit

ogrFeatureStyleWidth(self, widthScaleFactor: float) → str¶

Parameters:: widthScaleFactor (float) –
Return type:: str

outputUnit(self) → QgsUnitTypes.RenderUnit¶

Return type:: QgsUnitTypes.RenderUnit

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

Return type:: Dict[str, Any]

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

New in version 3.0.