Class: QgsTextBufferSettings¶
-
class
qgis.core.
QgsTextBufferSettings
¶ Bases:
sip.wrapper
QgsTextBufferSettings(other:
QgsTextBufferSettings
) Copy constructor.- Parameters
other – source settings
Container for settings relating to a text buffer.
Note
QgsTextBufferSettings
objects are implicitly shared.Methods
Returns the blending mode used for drawing the buffer.
Returns the color of the buffer.
Returns whether the buffer is enabled.
Returns whether the interior of the buffer will be filled in.
Returns the buffer join style.
Returns the buffer opacity.
Returns the current paint effect for the buffer.
Reads settings from a layer’s custom properties (for QGIS 2.x projects).
Read settings from a DOM element.
Returns all field names referenced by the configuration (e.g.
Sets the blending mode used for drawing the buffer.
Sets the color for the buffer.
Sets whether the text buffer will be drawn.
Sets whether the interior of the buffer will be filled in.
Sets the join style used for drawing the buffer.
Sets the buffer opacity.
Sets the current paint
effect
for the buffer.Sets the size of the buffer.
Sets the map unit scale object for the buffer size.
Sets the units used for the buffer size.
Returns the size of the buffer.
Returns the map unit scale object for the buffer size.
Returns the units for the buffer size.
Updates the format by evaluating current values of data defined properties.
Write settings into a DOM element.
-
blendMode
(self) → QPainter.CompositionMode¶ Returns the blending mode used for drawing the buffer.
See also
- Return type
QPainter.CompositionMode
-
color
(self) → QColor¶ Returns the color of the buffer.
See also
- Return type
QColor
-
enabled
(self) → bool¶ Returns whether the buffer is enabled.
See also
- Return type
bool
-
fillBufferInterior
(self) → bool¶ Returns whether the interior of the buffer will be filled in. If
False
, only the stroke of the text will be drawn as the buffer. The effect of this setting is only visible for semi-transparent text.See also
- Return type
bool
-
joinStyle
(self) → Qt.PenJoinStyle¶ Returns the buffer join style.
See also
- Return type
Qt.PenJoinStyle
-
opacity
(self) → float¶ Returns the buffer 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 buffer.
- Return type
- Returns
paint effect
See also
-
readFromLayer
(self, layer: QgsVectorLayer)¶ Reads settings from a layer’s custom properties (for QGIS 2.x projects).
- Parameters
layer (QgsVectorLayer) – source vector layer
-
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]
-
setBlendMode
(self, mode: QPainter.CompositionMode)¶ Sets the blending mode used for drawing the buffer.
- Parameters
mode (QPainter.CompositionMode) – blending mode
See also
-
setColor
(self, color: Union[QColor, Qt.GlobalColor])¶ Sets the color for the buffer.
- Parameters
color (Union[QColor) – buffer color
See also
-
setEnabled
(self, enabled: bool)¶ Sets whether the text buffer will be drawn.
- Parameters
enabled (bool) – set to
True
to draw buffer
See also
-
setFillBufferInterior
(self, fill: bool)¶ Sets whether the interior of the buffer will be filled in.
- Parameters
fill (bool) – set to
False
to drawn only the stroke of the text as the buffer, orTrue
to also shade the area inside the text. The effect of this setting is only visible for semi-transparent text.
See also
-
setJoinStyle
(self, style: Qt.PenJoinStyle)¶ Sets the join style used for drawing the buffer.
- Parameters
style (Qt.PenJoinStyle) – join style
See also
-
setOpacity
(self, opacity: float)¶ Sets the buffer 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 buffer.- Parameters
effect (QgsPaintEffect) – paint effect. Ownership is transferred to the buffer 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
-
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
-
updateDataDefinedProperties
(self, context: QgsRenderContext, properties: QgsPropertyCollection)¶ Updates the format by evaluating current values of data defined properties.
New in version 3.10.
- Parameters
context (QgsRenderContext) –
properties (QgsPropertyCollection) –