Subgroup: Symbol

Class: QgsSymbolLegendNode

class qgis.core.QgsSymbolLegendNode(nodeLayer: QgsLayerTreeLayer, item: QgsLegendSymbolItem, parent: QObject = None)

Bases: qgis._core.QgsLayerTreeModelLegendNode

Constructor for QgsSymbolLegendNode.

Parameters:
  • nodeLayer – layer node
  • item – the legend symbol item
  • parent – attach a parent QObject to the legend node.

Implementation of legend node interface for displaying preview of vector symbols and their labels and allowing interaction with the symbol / renderer.

New in version 2.6: Methods

checkAllItems Checks all items belonging to the same layer as this node.
childEvent
connectNotify
createTemporaryRenderContext
customEvent
data
disconnectNotify
drawSymbol
flags
iconSize

New in version 2.10.

invalidateMapBasedData
isScaleOK
isSignalConnected
minimumIconSize Calculates the minimum icon size to prevent cropping.
receivers
sender
senderSignalIndex
setData
setEmbeddedInParent
setIconSize Set the icon size
setSymbol Sets the symbol to be used by the legend node.
setTextOnSymbolLabel Sets label of text to be shown on top of the symbol.
setTextOnSymbolTextFormat Sets format of text to be shown on top of the symbol.
setUserLabel
symbol Returns the symbol used by the legend node.
textOnSymbolLabel Returns label of text to be shown on top of the symbol.
textOnSymbolTextFormat Returns text format of the label to be shown on top of the symbol.
timerEvent
toggleAllItems Toggle all items belonging to the same layer as this node.
uncheckAllItems Unchecks all items belonging to the same layer as this node.

Signals

Attributes

checkAllItems(self)

Checks all items belonging to the same layer as this node.

See also

toggleAllItems()

New in version 2.14.

childEvent()
connectNotify()
createTemporaryRenderContext()
customEvent()
data(self, role: int) → Any
disconnectNotify()
drawSymbol(self, settings: QgsLegendSettings, ctx: QgsLayerTreeModelLegendNode.ItemContext, itemHeight: float) → QSizeF
flags(self) → Qt.ItemFlags
iconSize(self) → QSize

New in version 2.10.

invalidateMapBasedData(self)
isScaleOK(self, scale: float) → bool
isSignalConnected()
minimumIconSize(self) → QSize

Calculates the minimum icon size to prevent cropping. When evaluating the size for multiple icons it is more efficient to create a single render context in advance and use the variant which accepts a QgsRenderContext argument.

New in version 2.10.

minimumIconSize(self, context: QgsRenderContext) -> QSize Calculates the minimum icon size to prevent cropping. When evaluating the size for multiple icons it is more efficient to create a single render context in advance and call this method instead of minimumIconSize().

New in version 2.18.

receivers()
sender()
senderSignalIndex()
setData(self, value: Any, role: int) → bool
setEmbeddedInParent(self, embedded: bool)
setIconSize(self, sz: QSize)

Set the icon size

New in version 2.10.

setSymbol(self, symbol: QgsSymbol)

Sets the symbol to be used by the legend node. The symbol change is also propagated to the associated vector layer’s renderer.

Parameters:symbol – new symbol for node. Ownership is transferred.

See also

symbol()

New in version 2.14.

setTextOnSymbolLabel(self, label: str)

Sets label of text to be shown on top of the symbol.

New in version 3.2.

setTextOnSymbolTextFormat(self, format: QgsTextFormat)

Sets format of text to be shown on top of the symbol.

New in version 3.2.

setUserLabel(self, userLabel: str)
symbol(self) → QgsSymbol

Returns the symbol used by the legend node.

See also

setSymbol()

New in version 2.14.

textOnSymbolLabel(self) → str

Returns label of text to be shown on top of the symbol.

New in version 3.2.

textOnSymbolTextFormat(self) → QgsTextFormat

Returns text format of the label to be shown on top of the symbol.

New in version 3.2.

timerEvent()
toggleAllItems(self)

Toggle all items belonging to the same layer as this node.

See also

checkAllItems()

New in version 3.6.

uncheckAllItems(self)

Unchecks all items belonging to the same layer as this node.

See also

checkAllItems()

See also

toggleAllItems()

New in version 2.14.