Class: QgsTextMaskSettings¶
- class qgis.core.QgsTextMaskSettings¶
Bases:
sip.wrapper
QgsTextMaskSettings(other:
QgsTextMaskSettings
) Copy constructor.- Parameters
other – source settings
Container for settings relating to a selective masking around a text. A selective masking only makes sense in contexts where the text is rendered over some other map layers, especially for labeling.
Note
QgsTextMaskSettings
objects are implicitly shared.Methods
Returns whether the mask is enabled.
Returns the buffer join style.
Returns a list of references to symbol layers that are masked by this buffer.
Returns the mask’s opacity.
Returns the current paint effect for the mask.
Read settings from a DOM element.
Returns all field names referenced by the configuration (e.g.
Returns whether the mask is enabled.
Sets the join style used for drawing the buffer.
Sets the symbol layers that will be masked by this buffer.
Sets the mask’s opacity.
Sets the current paint
effect
for the mask.Sets the size of the buffer.
Sets the map unit scale object for the buffer size.
Sets the units used for the buffer size.
Sets the type of mask shape.
Returns the size of the buffer.
Returns the map unit scale object for the buffer size.
Returns the units for the buffer size.
Returns the type of mask shape.
Updates the format by evaluating current values of data defined properties.
Write settings into a DOM element.
Attributes
- MaskBuffer = 0¶
- class MaskType¶
Bases:
int
- enabled(self) → bool¶
Returns whether the mask is enabled.
- Return type
bool
- joinStyle(self) → Qt.PenJoinStyle¶
Returns the buffer join style.
See also
- Return type
Qt.PenJoinStyle
- maskedSymbolLayers(self) → List[QgsSymbolLayerReference]¶
Returns a list of references to symbol layers that are masked by this buffer.
- Return type
List[QgsSymbolLayerReference]
- Returns
a list of references to masked symbol layers
See also
- opacity(self) → float¶
Returns the mask’s opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally opaque).
See also
- Return type
float
- paintEffect(self) → QgsPaintEffect¶
Returns the current paint effect for the mask.
- Return type
- Returns
paint effect
See also
- readXml(self, elem: QDomElement)¶
Read settings from a DOM element.
See also
- Parameters
elem (QDomElement) –
- referencedFields(self, context: QgsRenderContext) → Set[str]¶
Returns all field names referenced by the configuration (e.g. from data defined properties).
New in version 3.14.
- Parameters
context (QgsRenderContext) –
- Return type
Set[str]
- setEnabled(self, bool)¶
Returns whether the mask is enabled.
- setJoinStyle(self, style: Qt.PenJoinStyle)¶
Sets the join style used for drawing the buffer.
- Parameters
style (Qt.PenJoinStyle) – join style
See also
- setMaskedSymbolLayers(self, maskedLayers: Iterable[QgsSymbolLayerReference])¶
Sets the symbol layers that will be masked by this buffer.
- Parameters
maskedLayers (Iterable[QgsSymbolLayerReference]) – list of references to symbol layers
See also
- setOpacity(self, opacity: float)¶
Sets the mask’s opacity.
- Parameters
opacity (float) – opacity as a double value between 0 (fully transparent) and 1 (totally opaque)
See also
- setPaintEffect(self, effect: QgsPaintEffect)¶
Sets the current paint
effect
for the mask.- Parameters
effect (QgsPaintEffect) – paint effect. Ownership is transferred to the mask settings.
See also
- setSize(self, size: float)¶
Sets the size of the buffer. The size units are specified using
setSizeUnit()
.- Parameters
size (float) – buffer size
See also
See also
- setSizeMapUnitScale(self, scale: QgsMapUnitScale)¶
Sets the map unit scale object for the buffer size. This is only used if the buffer size is set to
QgsUnitTypes
.RenderMapUnit.- Parameters
scale (QgsMapUnitScale) – scale for buffer size
See also
See also
- setSizeUnit(self, unit: QgsUnitTypes.RenderUnit)¶
Sets the units used for the buffer size.
- Parameters
unit (QgsUnitTypes.RenderUnit) – size unit
See also
See also
- setType(self, type: QgsTextMaskSettings.MaskType)¶
Sets the type of mask shape.
- Parameters
type (QgsTextMaskSettings.MaskType) – shape type
See also
- size(self) → float¶
Returns the size of the buffer.
See also
See also
- Return type
float
- sizeMapUnitScale(self) → QgsMapUnitScale¶
Returns the map unit scale object for the buffer size. This is only used if the buffer size is set to
QgsUnitTypes
.RenderMapUnit.See also
See also
- Return type
- sizeUnit(self) → QgsUnitTypes.RenderUnit¶
Returns the units for the buffer size.
See also
See also
- Return type
- type(self) → QgsTextMaskSettings.MaskType¶
Returns the type of mask shape.
See also
- Return type
- updateDataDefinedProperties(self, context: QgsRenderContext, properties: QgsPropertyCollection)¶
Updates the format by evaluating current values of data defined properties.
- Parameters
context (QgsRenderContext) –
properties (QgsPropertyCollection) –