Class: QgsPointPatternFillSymbolLayer

A fill symbol layer which fills polygon shapes with repeating marker symbols.

Class Hierarchy

Base classes

QgsImageFillSymbolLayer	Base class for fill symbol layers which fill polygons with a repeated image.
QgsFillSymbolLayer	Abstract base class for fill symbol layers.
QgsSymbolLayer	Abstract base class for symbol layers.

Methods

clipMode	Returns the marker clipping mode, which defines how markers are clipped at the edges of shapes.
displacementX	Returns the horizontal displacement for odd numbered rows in the pattern.
displacementXMapUnitScale	Returns the map unit scale for the horizontal displacement between odd numbered rows in the pattern.
displacementXUnit	Returns the units for the horizontal displacement between rows in the pattern.
displacementY	Returns the vertical displacement for odd numbered columns in the pattern.
displacementYMapUnitScale	Returns the map unit scale for the vertical displacement between odd numbered columns in the pattern.
displacementYUnit	Returns the units for the vertical displacement between rows in the pattern.
distanceX	Returns the horizontal distance between rendered markers in the fill.
distanceXMapUnitScale	Returns the map unit scale for the horizontal distance between points in the pattern.
distanceXUnit	Returns the units for the horizontal distance between points in the pattern.
distanceY	Returns the vertical distance between rendered markers in the fill.
distanceYMapUnitScale	Returns the map unit scale for the vertical distance between points in the pattern.
distanceYUnit	Returns the units for the vertical distance between points in the pattern.
maximumRandomDeviationX	Returns the maximum horizontal random deviation of points in the pattern.
maximumRandomDeviationY	Returns the maximum vertical random deviation of points in the pattern.
offsetX	Returns the horizontal offset values for points in the pattern.
offsetXMapUnitScale	Returns the unit scale for the horizontal offset for rows in the pattern.
offsetXUnit	Returns the units for the horizontal offset for rows in the pattern.
offsetY	Returns the vertical offset values for points in the pattern.
offsetYMapUnitScale	Returns the unit scale for the vertical offset between rows in the pattern.
offsetYUnit	Returns the units for the vertical offset for rows in the pattern.
randomDeviationXMapUnitScale	Returns the unit scale for the horizontal random deviation of points in the pattern.
randomDeviationXUnit	Returns the units for the horizontal random deviation of points in the pattern.
randomDeviationYMapUnitScale	Returns the unit scale for the vertical random deviation of points in the pattern.
randomDeviationYUnit	Returns the units for the vertical random deviation of points in the pattern.
seed	Returns the random number seed to use when randomly shifting points, or 0 if a truly random sequence will be used (causing points to appear in different locations with every map refresh).
setClipMode	Sets the marker clipping mode, which defines how markers are clipped at the edges of shapes.
setDisplacementX	Sets the horizontal displacement for odd numbered rows in the pattern.
setDisplacementXMapUnitScale	Sets the map unit scale for the horizontal displacement between odd numbered rows in the pattern.
setDisplacementXUnit	Sets the units for the horizontal displacement between rows in the pattern.
setDisplacementY	Sets the vertical displacement for odd numbered columns in the pattern.
setDisplacementYMapUnitScale	Sets the map unit scale for the vertical displacement between odd numbered columns in the pattern.
setDisplacementYUnit	Sets the units for the vertical displacement between rows in the pattern.
setDistanceX	Sets the horizontal distance between rendered markers in the fill.
setDistanceXMapUnitScale	Sets the map unit scale for the horizontal distance between points in the pattern.
setDistanceXUnit	Sets the unit for the horizontal distance between points in the pattern.
setDistanceY	Sets the vertical distance between rendered markers in the fill.
setDistanceYMapUnitScale	Sets the map unit scale for the vertical distance between points in the pattern.
setDistanceYUnit	Sets the unit for the vertical distance between points in the pattern.
setMaximumRandomDeviationX	Sets the maximum horizontal random deviation of points in the pattern.
setMaximumRandomDeviationY	Sets the maximum vertical random deviation of points in the pattern.
setOffsetX	Sets the horizontal offset values for points in the pattern.
setOffsetXMapUnitScale	Sets the unit scale for the horizontal offset for rows in the pattern.
setOffsetXUnit	Sets the units for the horizontal offset between rows in the pattern.
setOffsetY	Sets the vertical offset values for points in the pattern.
setOffsetYMapUnitScale	Sets the unit scale for the vertical offset for rows in the pattern.
setOffsetYUnit	Sets the units for the vertical offset for rows in the pattern.
setRandomDeviationXMapUnitScale	Sets the unit scale for the horizontal random deviation of points in the pattern.
setRandomDeviationXUnit	Sets the unit for the horizontal random deviation of points in the pattern.
setRandomDeviationYMapUnitScale	Sets the unit scale for the vertical random deviation of points in the pattern.
setRandomDeviationYUnit	Sets the unit for the vertical random deviation of points in the pattern.
setSeed	Sets the random number seed to use when randomly shifting points, or 0 if a truly random sequence will be used on every rendering (causing points to appear in different locations with every map refresh).

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsPointPatternFillSymbolLayer. See the FAQ for more details.

applyBrushTransformFromContext
applyDataDefinedSettings

Static Methods

create	Creates a new QgsPointPatternFillSymbolLayer using the specified properties map containing symbol properties (see properties()).
createFromSld

class qgis.core.QgsPointPatternFillSymbolLayer

Bases: QgsImageFillSymbolLayer

virtual applyBrushTransformFromContext()

virtual applyDataDefinedSettings(self, context: QgsSymbolRenderContext)

Parameters:

context (QgsSymbolRenderContext)

clipMode(self) → Qgis.MarkerClipMode

Returns the marker clipping mode, which defines how markers are clipped at the edges of shapes.

See also

setClipMode()

Added in version 3.24.

Return type:

Qgis.MarkerClipMode

static create(properties: Dict[str, Any] = {}) → QgsSymbolLayer | None

Creates a new QgsPointPatternFillSymbolLayer using the specified properties map containing symbol properties (see properties()).

Caller takes ownership of the returned symbol layer.

Parameters:

properties (Dict[str, Any] = {})

Return type:

Optional[QgsSymbolLayer]

static createFromSld(element: QDomElement) → QgsSymbolLayer | None

Parameters:

element (QDomElement)

Return type:

Optional[QgsSymbolLayer]

displacementX(self) → float

Returns the horizontal displacement for odd numbered rows in the pattern.

Units are retrieved via displacementXUnit().

See also

setDisplacementX()

See also

displacementXUnit()

See also

displacementXMapUnitScale()

Return type:

float

displacementXMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the horizontal displacement between odd numbered rows in the pattern.

See also

setDisplacementXMapUnitScale()

See also

displacementX()

Return type:

QgsMapUnitScale

displacementXUnit(self) → Qgis.RenderUnit

Returns the units for the horizontal displacement between rows in the pattern.

See also

setDisplacementXUnit()

See also

displacementYUnit()

Return type:

Qgis.RenderUnit

displacementY(self) → float

Returns the vertical displacement for odd numbered columns in the pattern.

Units are retrieved via displacementYUnit().

See also

setDisplacementY()

See also

displacementYUnit()

See also

displacementYMapUnitScale()

Return type:

float

displacementYMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the vertical displacement between odd numbered columns in the pattern.

See also

setDisplacementYMapUnitScale()

See also

displacementY()

Return type:

QgsMapUnitScale

displacementYUnit(self) → Qgis.RenderUnit

Returns the units for the vertical displacement between rows in the pattern.

See also

setDisplacementYUnit()

See also

displacementXUnit()

Return type:

Qgis.RenderUnit

distanceX(self) → float

Returns the horizontal distance between rendered markers in the fill.

Units are retrieved via distanceXUnit().

See also

setDistanceX()

See also

distanceXUnit()

See also

distanceXMapUnitScale()

Return type:

float

distanceXMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the horizontal distance between points in the pattern.

See also

setDistanceXMapUnitScale()

See also

distanceX()

Return type:

QgsMapUnitScale

distanceXUnit(self) → Qgis.RenderUnit

Returns the units for the horizontal distance between points in the pattern.

See also

setDistanceXUnit()

See also

distanceYUnit()

Return type:

Qgis.RenderUnit

distanceY(self) → float

Returns the vertical distance between rendered markers in the fill.

Units are retrieved via distanceYUnit().

See also

setDistanceY()

See also

distanceYUnit()

See also

distanceYMapUnitScale()

Return type:

float

distanceYMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the vertical distance between points in the pattern.

See also

setDistanceYMapUnitScale()

See also

distanceY()

Return type:

QgsMapUnitScale

distanceYUnit(self) → Qgis.RenderUnit

Returns the units for the vertical distance between points in the pattern.

See also

setDistanceYUnit()

See also

distanceXUnit()

Return type:

Qgis.RenderUnit

maximumRandomDeviationX(self) → float

Returns the maximum horizontal random deviation of points in the pattern.

Units are retrieved via maximumRandomDeviationXUnit().

See also

setMaximumRandomDeviationX()

See also

maximumRandomDeviationY()

Added in version 3.24.

Return type:

float

maximumRandomDeviationY(self) → float

Returns the maximum vertical random deviation of points in the pattern.

Units are retrieved via maximumRandomDeviationYUnit().

See also

setMaximumRandomDeviationY()

See also

maximumRandomDeviationX()

Added in version 3.24.

Return type:

float

offsetX(self) → float

Returns the horizontal offset values for points in the pattern.

See also

setOffsetX()

See also

offsetY()

Added in version 3.8.

Return type:

float

offsetXMapUnitScale(self) → QgsMapUnitScale

Returns the unit scale for the horizontal offset for rows in the pattern.

See also

setOffsetXMapUnitScale()

See also

offsetYMapUnitScale()

Added in version 3.8.

Return type:

QgsMapUnitScale

offsetXUnit(self) → Qgis.RenderUnit

Returns the units for the horizontal offset for rows in the pattern.

See also

setOffsetXUnit()

See also

offsetYUnit()

Added in version 3.8.

Return type:

Qgis.RenderUnit

offsetY(self) → float

Returns the vertical offset values for points in the pattern.

See also

setOffsetY()

See also

offsetX()

Added in version 3.8.

Return type:

float

offsetYMapUnitScale(self) → QgsMapUnitScale

Returns the unit scale for the vertical offset between rows in the pattern.

See also

setOffsetYMapUnitScale()

See also

offsetXMapUnitScale()

Added in version 3.8.

Return type:

QgsMapUnitScale

offsetYUnit(self) → Qgis.RenderUnit

Returns the units for the vertical offset for rows in the pattern.

See also

setOffsetYUnit()

See also

offsetXUnit()

Added in version 3.8.

Return type:

Qgis.RenderUnit

randomDeviationXMapUnitScale(self) → QgsMapUnitScale

Returns the unit scale for the horizontal random deviation of points in the pattern.

See also

setRandomDeviationXMapUnitScale()

See also

randomDeviationYMapUnitScale()

Added in version 3.24.

Return type:

QgsMapUnitScale

randomDeviationXUnit(self) → Qgis.RenderUnit

Returns the units for the horizontal random deviation of points in the pattern.

See also

setRandomDeviationXUnit()

See also

randomDeviationYUnit()

Added in version 3.24.

Return type:

Qgis.RenderUnit

randomDeviationYMapUnitScale(self) → QgsMapUnitScale

Returns the unit scale for the vertical random deviation of points in the pattern.

See also

setRandomDeviationXMapUnitScale()

See also

randomDeviationXMapUnitScale()

Added in version 3.24.

Return type:

QgsMapUnitScale

randomDeviationYUnit(self) → Qgis.RenderUnit

Returns the units for the vertical random deviation of points in the pattern.

See also

setRandomDeviationYUnit()

See also

randomDeviationXUnit()

Added in version 3.24.

Return type:

Qgis.RenderUnit

seed(self) → int

Returns the random number seed to use when randomly shifting points, or 0 if a truly random sequence will be used (causing points to appear in different locations with every map refresh).

See also

setSeed()

Added in version 3.24.

Return type:

int

setClipMode(self, mode: Qgis.MarkerClipMode)

Sets the marker clipping mode, which defines how markers are clipped at the edges of shapes.

See also

clipMode()

Added in version 3.24.

Parameters:

mode (Qgis.MarkerClipMode)

setDisplacementX(self, d: float)

Sets the horizontal displacement for odd numbered rows in the pattern.

Units are set via setDisplacementXUnit().

See also

displacementX()

See also

setDisplacementXUnit()

See also

setDisplacementXMapUnitScale()

Parameters:

d (float)

setDisplacementXMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the horizontal displacement between odd numbered rows in the pattern.

See also

displacementXMapUnitScale()

See also

setDisplacementX()

Parameters:

scale (QgsMapUnitScale)

setDisplacementXUnit(self, unit: Qgis.RenderUnit)

Sets the units for the horizontal displacement between rows in the pattern.

Parameters:

unit (Qgis.RenderUnit) – displacement units

See also

displacementXUnit()

See also

setDisplacementYUnit()

setDisplacementY(self, d: float)

Sets the vertical displacement for odd numbered columns in the pattern.

Units are set via setDisplacementYUnit().

See also

displacementY()

See also

setDisplacementYUnit()

See also

setDisplacementYMapUnitScale()

Parameters:

d (float)

setDisplacementYMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the vertical displacement between odd numbered columns in the pattern.

See also

displacementYMapUnitScale()

See also

setDisplacementY()

Parameters:

scale (QgsMapUnitScale)

setDisplacementYUnit(self, unit: Qgis.RenderUnit)

Sets the units for the vertical displacement between rows in the pattern.

Parameters:

unit (Qgis.RenderUnit) – displacement units

See also

displacementYUnit()

See also

setDisplacementXUnit()

setDistanceX(self, d: float)

Sets the horizontal distance between rendered markers in the fill.

Units are set via setDistanceXUnit().

See also

distanceX()

See also

setDistanceXUnit()

See also

setDistanceXMapUnitScale()

Parameters:

d (float)

setDistanceXMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the horizontal distance between points in the pattern.

See also

distanceXMapUnitScale()

See also

setDistanceX()

Parameters:

scale (QgsMapUnitScale)

setDistanceXUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the horizontal distance between points in the pattern.

Parameters:

unit (Qgis.RenderUnit) – distance units

See also

distanceXUnit()

See also

setDistanceYUnit()

setDistanceY(self, d: float)

Sets the vertical distance between rendered markers in the fill.

Units are set via setDistanceYUnit().

See also

distanceY()

See also

setDistanceYUnit()

See also

setDistanceYMapUnitScale()

Parameters:

d (float)

setDistanceYMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the vertical distance between points in the pattern.

See also

distanceYMapUnitScale()

See also

setDistanceY()

Parameters:

scale (QgsMapUnitScale)

setDistanceYUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the vertical distance between points in the pattern.

Parameters:

unit (Qgis.RenderUnit) – distance units

See also

distanceYUnit()

See also

setDistanceXUnit()

setMaximumRandomDeviationX(self, deviation: float)

Sets the maximum horizontal random deviation of points in the pattern.

Units are set via setMaximumRandomDeviationXUnit().

See also

maximumRandomDeviationX()

See also

setMaximumRandomDeviationY()

Added in version 3.24.

Parameters:

deviation (float)

setMaximumRandomDeviationY(self, deviation: float)

Sets the maximum vertical random deviation of points in the pattern.

Units are set via setMaximumRandomDeviationYUnit().

See also

maximumRandomDeviationY()

See also

setMaximumRandomDeviationX()

Added in version 3.24.

Parameters:

deviation (float)

setOffsetX(self, offset: float)

Sets the horizontal offset values for points in the pattern.

Parameters:

offset (float) – offset value

See also

offsetX()

See also

setOffsetY()

Added in version 3.8.

setOffsetXMapUnitScale(self, scale: QgsMapUnitScale)

Sets the unit scale for the horizontal offset for rows in the pattern.

Parameters:

scale (QgsMapUnitScale) – offset unit scale

See also

offsetXMapUnitScale()

See also

setOffsetYMapUnitScale()

Added in version 3.8.

setOffsetXUnit(self, unit: Qgis.RenderUnit)

Sets the units for the horizontal offset between rows in the pattern.

Parameters:

unit (Qgis.RenderUnit) – offset units

See also

offsetXUnit()

See also

setOffsetYUnit()

Added in version 3.8.

setOffsetY(self, offset: float)

Sets the vertical offset values for points in the pattern.

Parameters:

offset (float) – offset value

See also

offsetY()

See also

setOffsetX()

Added in version 3.8.

setOffsetYMapUnitScale(self, scale: QgsMapUnitScale)

Sets the unit scale for the vertical offset for rows in the pattern.

Parameters:

scale (QgsMapUnitScale) – offset unit scale

See also

offsetYMapUnitScale()

See also

setOffsetXMapUnitScale()

Added in version 3.8.

setOffsetYUnit(self, unit: Qgis.RenderUnit)

Sets the units for the vertical offset for rows in the pattern.

Parameters:

unit (Qgis.RenderUnit) – offset units

See also

offsetYUnit()

See also

setOffsetXUnit()

Added in version 3.8.

setRandomDeviationXMapUnitScale(self, scale: QgsMapUnitScale)

Sets the unit scale for the horizontal random deviation of points in the pattern.

See also

randomDeviationXMapUnitScale()

See also

setRandomDeviationYMapUnitScale()

Added in version 3.24.

Parameters:

scale (QgsMapUnitScale)

setRandomDeviationXUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the horizontal random deviation of points in the pattern.

See also

randomDeviationXUnit()

See also

setRandomDeviationYUnit()

Added in version 3.24.

Parameters:

unit (Qgis.RenderUnit)

setRandomDeviationYMapUnitScale(self, scale: QgsMapUnitScale)

Sets the unit scale for the vertical random deviation of points in the pattern.

See also

randomDeviationYMapUnitScale()

See also

setRandomDeviationXMapUnitScale()

Added in version 3.24.

Parameters:

scale (QgsMapUnitScale)

setRandomDeviationYUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the vertical random deviation of points in the pattern.

See also

randomDeviationYUnit()

See also

setRandomDeviationXUnit()

Added in version 3.24.

Parameters:

unit (Qgis.RenderUnit)

setSeed(self, seed: int)

Sets the random number seed to use when randomly shifting points, or 0 if a truly random sequence will be used on every rendering (causing points to appear in different locations with every map refresh).

See also

seed()

Added in version 3.24.

Parameters:

seed (int)