Class: QgsLegendStyle¶

Contains detailed styling information relating to how a layout legend should be rendered.

Methods

`alignment`	Returns the alignment for the legend component.
`font`	Returns the font used for rendering this legend component.
`indent`	Returns the indent (in mm) of a group or subgroup.
`margin`	Returns the margin (in mm) for the specified side of the component.
`readXml`	Reads the component's style definition from an XML element.
`setAlignment`	Sets the alignment for the legend component.
`setFont`	Sets the font used for rendering this legend component.
`setIndent`	Sets the indent (in mm) of a group or subgroup.
`setMargin`	Sets the margin (in mm) for the specified side of the component.
`setTextFormat`	Sets the text format used for rendering this legend component.
`textFormat`	Returns the text format used for rendering this legend component.
`updateDataDefinedProperties`	Updates any data-defined properties in the style, using the specified render context.
`writeXml`	Writes the component's style definition to an XML element.

Static Methods

`styleFromName`	Returns the style from name string.
`styleLabel`	Returns a translated string representing a style component, for use in UI.
`styleName`	Returns the name for a style component as a string.

Attributes

`Bottom`
`Group`
`Hidden`
`Left`
`Right`
`Subgroup`
`Symbol`
`SymbolLabel`
`Title`
`Top`
`Undefined`

class qgis.core.QgsLegendStyle[source]¶

Bases: object

Bottom = 1¶

Group = 3¶

Hidden = 1¶

Left = 2¶

Right = 3¶

class Side¶: Bases: int

class Style¶: Bases: int

Subgroup = 4¶

Symbol = 5¶

SymbolLabel = 6¶

Title = 2¶

Top = 0¶

Undefined = 0¶

alignment(self) → Qt.Alignment[source]¶

Returns the alignment for the legend component.

See also

setAlignment()

Added in version 3.10.

Return type:: Qt.Alignment

font(self) → QFont[source]¶

Returns the font used for rendering this legend component.

See also

setFont()

Deprecated since version 3.40: Use textFormat() instead.

Return type:: QFont

indent(self) → float[source]¶

Returns the indent (in mm) of a group or subgroup.

See also

indent()

Added in version 3.22.

Return type:: float

margin(self, side: QgsLegendStyle.Side) → float[source]¶

Returns the margin (in mm) for the specified side of the component.

Note

Not all legend components respect all margin side settings!

See also

setMargin()

Parameters:: side (QgsLegendStyle.Side)
Return type:: float

readXml(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext())[source]¶

Reads the component’s style definition from an XML element.

See also

writeXml()

Parameters:

elem (QDomElement)
doc (QDomDocument)
context (QgsReadWriteContext = QgsReadWriteContext())

setAlignment(self, alignment: Qt.Alignment | Qt.AlignmentFlag)[source]¶

Sets the alignment for the legend component.

See also

alignment()

Added in version 3.10.

Parameters:: alignment (Union[Qt.Alignment, Qt.AlignmentFlag])

setFont(self, font: QFont)[source]¶

Sets the font used for rendering this legend component.

See also

font()

Deprecated since version 3.40: Use setTextFormat() instead.

Parameters:: font (QFont)

setIndent(self, indent: float)[source]¶

Sets the indent (in mm) of a group or subgroup.

See also

indent()

Added in version 3.22.

Parameters:: indent (float)

setMargin(self, side: QgsLegendStyle.Side, margin: float)[source]¶

Sets the margin (in mm) for the specified side of the component.

Note

Not all legend components respect all margin side settings!

See also

margin()

Parameters:

side (QgsLegendStyle.Side)
margin (float)

setMargin(self, margin: float)[source]

Sets all margin sides to the same margin size (in mm).

See also

margin()

Parameters:: margin (float)

setTextFormat(self, format: QgsTextFormat)[source]¶

Sets the text format used for rendering this legend component.

See also

textFormat()

Added in version 3.30.

Parameters:: format (QgsTextFormat)

static styleFromName(styleName: str | None) → QgsLegendStyle.Style[source]¶

Returns the style from name string.

See also

styleName()

Parameters:: styleName (Optional[str])
Return type:: QgsLegendStyle.Style

static styleLabel(s: QgsLegendStyle.Style) → str[source]¶

Returns a translated string representing a style component, for use in UI.

See also

styleName()

Parameters:: s (QgsLegendStyle.Style)
Return type:: str

static styleName(s: QgsLegendStyle.Style) → str[source]¶

Returns the name for a style component as a string.

This is a non-localised version, for internal use.

See also

styleFromName()

See also

styleLabel()

Parameters:: s (QgsLegendStyle.Style)
Return type:: str

textFormat(self) → QgsTextFormat¶

Returns the text format used for rendering this legend component.

See also

setTextFormat()

Added in version 3.30.

Return type:: QgsTextFormat

updateDataDefinedProperties(self, context: QgsRenderContext)[source]¶

Updates any data-defined properties in the style, using the specified render context.

Added in version 3.42.

Parameters:: context (QgsRenderContext)

writeXml(self, name: str | None, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext())[source]¶

Writes the component’s style definition to an XML element.

See also

readXml()

Parameters:

name (Optional[str])
elem (QDomElement)
doc (QDomDocument)
context (QgsReadWriteContext = QgsReadWriteContext())