Class: QgsSelectiveMaskSource

Encapsulates a single source for selective masking (e.g. a symbol layer or label rule).

Added in version 4.0.

Methods

isValid	Returns True if the source is valid (i.e. has a non-empty layer ID).
layerId	Returns the source layer id.
setLayerId	Sets the source layer id.
setSourceId	Sets the symbol layer or label rule id.
setSourceType	Sets the source type.
sourceId	Returns the symbol layer or label rule ID.
sourceType	Returns the type of masking source.

class qgis.core.QgsSelectiveMaskSource

Bases: object

__init__()

Constructor for an invalid QgsSelectiveMaskSource.

__init__(layerId: str | None, sourceType: Qgis.SelectiveMaskSourceType, sourceId: str | None = '')

Constructor for QgsSelectiveMaskSource.

Parameters:

• layerId (Optional[str]) – source layer ID

• sourceType (Qgis.SelectiveMaskSourceType) – masking source type

• sourceId (Optional[str] = '') – optional ID for the symbol layer or label rule

__init__(a0: QgsSelectiveMaskSource)

Parameters:

a0 (QgsSelectiveMaskSource)

isValid(self) → bool

Returns True if the source is valid (i.e. has a non-empty layer ID).

Return type:

bool

layerId(self) → str

Returns the source layer id.

See also

setLayerId()

Return type:

str

setLayerId(self, id: str | None)

Sets the source layer id.

See also

layerId()

Parameters:

id (Optional[str])

setSourceId(self, id: str | None)

Sets the symbol layer or label rule id.

See also

sourceId()

Parameters:

id (Optional[str])

setSourceType(self, type: Qgis.SelectiveMaskSourceType)

Sets the source type.

See also

sourceType()

Parameters:

type (Qgis.SelectiveMaskSourceType)

sourceId(self) → str

Returns the symbol layer or label rule ID.

See also

setSourceId()

Return type:

str

sourceType(self) → Qgis.SelectiveMaskSourceType

Returns the type of masking source.

See also

setSourceType()

Return type:

Qgis.SelectiveMaskSourceType