Class: QgsTextShadowSettings

class qgis.core.QgsTextShadowSettings

Bases: sip.wrapper

QgsTextShadowSettings(other: QgsTextShadowSettings) Copy constructor.

Parameters

other – source QgsTextShadowSettings

Container for settings relating to a text shadow.

Note

QgsTextShadowSettings objects are implicitly shared.

Methods

blendMode

Returns the blending mode used for drawing the drop shadow.

blurAlphaOnly

Returns whether only the alpha channel for the shadow will be blurred.

blurRadius

Returns the blur radius for the shadow.

blurRadiusMapUnitScale

Returns the map unit scale object for the shadow blur radius.

blurRadiusUnit

Returns the units used for the shadow’s blur radius.

color

Returns the color of the drop shadow.

enabled

Returns whether the shadow is enabled.

offsetAngle

Returns the angle for offsetting the position of the shadow from the text.

offsetDistance

Returns the distance for offsetting the position of the shadow from the text.

offsetGlobal

Returns True if the global shadow offset will be used.

offsetMapUnitScale

Returns the map unit scale object for the shadow offset distance.

offsetUnit

Returns the units used for the shadow’s offset.

opacity

Returns the shadow’s opacity.

readFromLayer

Reads settings from a layer’s custom properties (for QGIS 2.x projects).

readXml

Read settings from a DOM element.

scale

Returns the scaling used for the drop shadow (in percentage of original size).

setBlendMode

Sets the blending mode used for drawing the drop shadow.

setBlurAlphaOnly

Sets whether only the alpha channel for the shadow should be blurred.

setBlurRadius

Sets the blur radius for the shadow.

setBlurRadiusMapUnitScale

Sets the map unit scale object for the shadow blur radius.

setBlurRadiusUnit

Sets the units used for the shadow’s blur radius.

setColor

Sets the color for the drop shadow.

setEnabled

Sets whether the text shadow will be drawn.

setOffsetAngle

Sets the angle for offsetting the position of the shadow from the text.

setOffsetDistance

Sets the distance for offsetting the position of the shadow from the text.

setOffsetGlobal

Sets whether the global shadow offset should be used.

setOffsetMapUnitScale

Sets the map unit scale object for the shadow offset distance.

setOffsetUnit

Sets the units used for the shadow’s offset.

setOpacity

Sets the shadow’s opacity.

setScale

Sets the scaling used for the drop shadow (in percentage of original size).

setShadowPlacement

Sets the placement for the drop shadow.

shadowPlacement

Returns the placement for the drop shadow.

updateDataDefinedProperties

Updates the format by evaluating current values of data defined properties.

writeXml

Write settings into a DOM element.

Attributes

ShadowBuffer

ShadowLowest

ShadowShape

ShadowText

ShadowBuffer = 2
ShadowLowest = 0
class ShadowPlacement

Bases: int

ShadowShape = 3
ShadowText = 1
blendMode(self) → QPainter.CompositionMode

Returns the blending mode used for drawing the drop shadow.

See also

setBlendMode()

Return type

QPainter.CompositionMode

blurAlphaOnly(self) → bool

Returns whether only the alpha channel for the shadow will be blurred.

Return type

bool

blurRadius(self) → float

Returns the blur radius for the shadow. Radius units are retrieved via blurRadiusUnits().

See also

setBlurRadius()

See also

blurRadiusUnit()

Return type

float

blurRadiusMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale object for the shadow blur radius. This is only used if the blurRadiusUnit() is set to QgsUnitTypes.RenderMapUnit.

See also

blurRadiusUnit()

Return type

QgsMapUnitScale

blurRadiusUnit(self) → QgsUnitTypes.RenderUnit

Returns the units used for the shadow’s blur radius.

See also

blurRadius()

Return type

QgsUnitTypes.RenderUnit

color(self) → QColor

Returns the color of the drop shadow.

See also

setColor()

Return type

QColor

enabled(self) → bool

Returns whether the shadow is enabled.

See also

setEnabled()

Return type

bool

offsetAngle(self) → int

Returns the angle for offsetting the position of the shadow from the text.

See also

setOffsetAngle()

See also

offsetDistance()

Return type

int

offsetDistance(self) → float

Returns the distance for offsetting the position of the shadow from the text. Offset units are retrieved via offsetUnit().

See also

offsetUnit()

Return type

float

offsetGlobal(self) → bool

Returns True if the global shadow offset will be used.

Return type

bool

offsetMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale object for the shadow offset distance. This is only used if the offsetUnit() is set to QgsUnitTypes.RenderMapUnit.

See also

offsetUnit()

Return type

QgsMapUnitScale

offsetUnit(self) → QgsUnitTypes.RenderUnit

Returns the units used for the shadow’s offset.

See also

setOffsetUnit()

See also

offsetDistance()

Return type

QgsUnitTypes.RenderUnit

opacity(self) → float

Returns the shadow’s opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally opaque).

See also

setOpacity()

Return type

float

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

writeXml()

Parameters

elem (QDomElement) –

scale(self) → int

Returns the scaling used for the drop shadow (in percentage of original size).

See also

setScale()

Return type

int

setBlendMode(self, mode: QPainter.CompositionMode)

Sets the blending mode used for drawing the drop shadow.

Parameters

mode (QPainter.CompositionMode) – blending mode

See also

blendMode()

setBlurAlphaOnly(self, alphaOnly: bool)

Sets whether only the alpha channel for the shadow should be blurred.

Parameters

alphaOnly (bool) – set to True to blur only the alpha channel. If False, all channels (including red, green and blue channel) will be blurred.

See also

blurAlphaOnly()

setBlurRadius(self, blurRadius: float)

Sets the blur radius for the shadow. Radius units are specified via setBlurRadiusUnits().

Parameters

blurRadius (float) – blur radius

See also

blurRadius()

setBlurRadiusMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale object for the shadow blur radius. This is only used if the blurRadiusUnit() is set to QgsUnitTypes.RenderMapUnit.

Parameters

scale (QgsMapUnitScale) – scale for shadow blur radius

setBlurRadiusUnit(self, units: QgsUnitTypes.RenderUnit)

Sets the units used for the shadow’s blur radius.

Parameters

units (QgsUnitTypes.RenderUnit) – shadow blur radius units

See also

blurRadiusUnit()

See also

setBlurRadius()

setColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the color for the drop shadow.

Parameters

color (Union[QColor) – shadow color

See also

color()

setEnabled(self, enabled: bool)

Sets whether the text shadow will be drawn.

Parameters

enabled (bool) – set to True to draw shadow

See also

enabled()

setOffsetAngle(self, angle: int)

Sets the angle for offsetting the position of the shadow from the text.

Parameters

angle (int) – offset angle in degrees

See also

offsetAngle()

setOffsetDistance(self, distance: float)

Sets the distance for offsetting the position of the shadow from the text. Offset units are specified via setOffsetUnit().

Parameters

distance (float) – offset distance

See also

offsetDistance()

See also

setOffsetUnit()

setOffsetGlobal(self, global_: bool)

Sets whether the global shadow offset should be used.

Parameters
  • global (bool) – set to True to use global shadow offset.

  • global

setOffsetMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale object for the shadow offset distance. This is only used if the offsetUnit() is set to QgsUnitTypes.RenderMapUnit.

Parameters

scale (QgsMapUnitScale) – scale for shadow offset

See also

setOffsetUnit()

setOffsetUnit(self, units: QgsUnitTypes.RenderUnit)

Sets the units used for the shadow’s offset.

Parameters

units (QgsUnitTypes.RenderUnit) – shadow distance units

See also

offsetUnit()

setOpacity(self, opacity: float)

Sets the shadow’s opacity.

Parameters

opacity (float) – opacity as a double value between 0 (fully transparent) and 1 (totally opaque)

See also

opacity()

setScale(self, scale: int)

Sets the scaling used for the drop shadow (in percentage of original size).

Parameters

scale (int) – scale percent for drop shadow

See also

scale()

setShadowPlacement(self, placement: QgsTextShadowSettings.ShadowPlacement)

Sets the placement for the drop shadow. The placement determines both the z-order stacking position for the shadow and the what shape (e.g., text, background shape) is used for casting the shadow.

Parameters

placement (QgsTextShadowSettings.ShadowPlacement) – shadow placement

shadowPlacement(self) → QgsTextShadowSettings.ShadowPlacement

Returns the placement for the drop shadow. The placement determines both the z-order stacking position for the shadow and the what shape (e.g., text, background shape) is used for casting the shadow.

Return type

QgsTextShadowSettings.ShadowPlacement

updateDataDefinedProperties(self, context: QgsRenderContext, properties: QgsPropertyCollection)

Updates the format by evaluating current values of data defined properties.

New in version 3.10.

Parameters
writeXml(self, doc: QDomDocument) → QDomElement

Write settings into a DOM element.

See also

readXml()

Parameters

doc (QDomDocument) –

Return type

QDomElement