Class: QgsMaskMarkerSymbolLayer

Special symbol layer that uses its sub symbol as a selective mask

Added in version 3.12.

Class Hierarchy

Base classes

QgsMarkerSymbolLayer	Abstract base class for marker symbol layers.
QgsSymbolLayer	Constructor for QgsSymbolLayer.

Methods

clearMasks	Remove masks defined by this symbol layer.
enabled	Whether some masked symbol layers are defined
masks	Returns a list of references to symbol layers that are masked by the sub symbol's shape.
setMasks	Sets the symbol layers that will be masked by the sub symbol's shape.

Static Methods

create

Create a new QgsMaskMarkerSymbolLayer

class qgis.core.QgsMaskMarkerSymbolLayer

Bases: QgsMarkerSymbolLayer

__init__()

Simple constructor

clearMasks(self)

Remove masks defined by this symbol layer.

See also

masks()

Added in version 3.42.

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

Create a new QgsMaskMarkerSymbolLayer

Parameters:

properties (Dict[str, Any] = {}) – A property map to deserialize saved information from properties()

Return type:

Optional[QgsSymbolLayer]

Returns:

A new QgsMaskMarkerSymbolLayer

enabled(self) → bool

Whether some masked symbol layers are defined

Return type:

bool

masks(self) → List[QgsSymbolLayerReference]

Returns a list of references to symbol layers that are masked by the sub symbol’s shape.

Return type:

List[QgsSymbolLayerReference]

Returns:

a list of references to masked symbol layers

See also

setMasks()

setMasks(self, maskedLayers: Iterable[QgsSymbolLayerReference])

Sets the symbol layers that will be masked by the sub symbol’s shape.

Parameters:

maskedLayers (Iterable[QgsSymbolLayerReference]) – list of references to symbol layers

See also

masks()