Class: QgsVectorLabelLegendNode

class qgis.core.QgsVectorLabelLegendNode

Bases: QgsLayerTreeModelLegendNode

Produces legend node for a labeling text symbol

Added in version 3.20.

QgsVectorLabelLegendNode(nodeLayer: Optional[QgsLayerTreeLayer], labelSettings: QgsPalLayerSettings, parent: Optional[QObject] = None) QgsVectorLabelLegendNode

Parameters:

• nodeLayer – the parent node

• labelSettings – setting of the label class

• parent –

  the parent object

  Methods

  childEvent
  connectNotify
  createTemporaryRenderContext	Returns a temporary context or None if legendMapViewData are not valid
  customEvent
  data	data Returns data associated with the item
  disconnectNotify
  drawSymbol	type settings: QgsLegendSettings
  exportSymbolToJson	type settings: QgsLegendSettings
  isSignalConnected
  receivers
  sender
  senderSignalIndex
  timerEvent

childEvent(self, a0: QChildEvent | None)

connectNotify(self, signal: QMetaMethod)

createTemporaryRenderContext(self) → QgsRenderContext | None

Returns a temporary context or None if legendMapViewData are not valid

customEvent(self, a0: QEvent | None)

data(self, role: int) → Any

data Returns data associated with the item

Parameters:

role (int) – the data role

Return type:

Any

Returns:

variant containing the data for the role

disconnectNotify(self, signal: QMetaMethod)

drawSymbol(self, settings: QgsLegendSettings, ctx: QgsLayerTreeModelLegendNode.ItemContext | None, itemHeight: float) → QSizeF

drawSymbol(None) → None

Parameters:

• settings (QgsLegendSettings) – the legend settings

• ctx (Optional[QgsLayerTreeModelLegendNode.ItemContext]) – context for the item

• itemHeight (float) – the height of the item

Return type:

QSizeF

Returns:

size of the item

exportSymbolToJson(self, settings: QgsLegendSettings, context: QgsRenderContext) → Dict[str, QJsonValue]

exportSymbolToJson(None) → None

Parameters:

• settings (QgsLegendSettings) – the legend settings

• context (QgsRenderContext) – the item context

Return type:

Dict[str, QJsonValue]

Returns:

the json object

isSignalConnected(self, signal: QMetaMethod) → bool

receivers(self, signal: PYQT_SIGNAL) → int

sender(self) → QObject | None

senderSignalIndex(self) → int

timerEvent(self, a0: QTimerEvent | None)