Class: QgsLegendStyle

class qgis.core.QgsLegendStyle

Bases: sip.wrapper

Composer legend components style

Methods

font

The font for this style.

margin

param side

readXml

param elem

setFont

The font for this style.

setMargin

setMargin(self, margin: float) Sets all margins

styleFromName

Gets style from name, used in project file

styleLabel

Gets style label, translated, used in UI

styleName

Gets name for style, used in project file

writeXml

param name

Attributes

Bottom

Group

Hidden

Left

Right

Subgroup

Symbol

SymbolLabel

Title

Top

Undefined

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
font(self) → QFont

The font for this style.

Return type

QFont

margin(self, side: QgsLegendStyle.Side) → float
Parameters

side (QgsLegendStyle.Side) –

Return type

float

readXml(self, elem: QDomElement, doc: QDomDocument)
Parameters
  • elem (QDomElement) –

  • doc (QDomDocument) –

setFont(self, font: QFont)

The font for this style.

Parameters

font (QFont) –

setMargin(self, side: QgsLegendStyle.Side, margin: float)

setMargin(self, margin: float) Sets all margins

Parameters
styleFromName(styleName: str) → QgsLegendStyle.Style

Gets style from name, used in project file

Parameters

styleName (str) –

Return type

QgsLegendStyle.Style

styleLabel(s: QgsLegendStyle.Style) → str

Gets style label, translated, used in UI

Parameters

s (QgsLegendStyle.Style) –

Return type

str

styleName(s: QgsLegendStyle.Style) → str

Gets name for style, used in project file

Parameters

s (QgsLegendStyle.Style) –

Return type

str

writeXml(self, name: str, elem: QDomElement, doc: QDomDocument)
Parameters
  • name (str) –

  • elem (QDomElement) –

  • doc (QDomDocument) –