Class: QgsSymbolLegendNode¶
-
class
qgis.core.
QgsSymbolLegendNode
(nodeLayer: QgsLayerTreeLayer, item: QgsLegendSymbolItem, parent: QObject = None)¶ Bases:
QgsLayerTreeModelLegendNode
Constructor for QgsSymbolLegendNode.
- Parameters
nodeLayer (QgsLayerTreeLayer) – layer node
item (QgsLegendSymbolItem) – the legend symbol item
parent (QObject = None) – 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.
Methods
Checks all items belonging to the same layer as this node.
- param role
- param settings
- rtype
Qt.ItemFlags
New in version 2.10.
- param scale
Calculates the minimum icon size to prevent cropping.
- param value
- param embedded
Set the icon size
Sets the symbol to be used by the legend node.
Sets label of text to be shown on top of the symbol.
Sets format of text to be shown on top of the symbol.
- param userLabel
Returns the symbol used by the legend node.
Returns label of text to be shown on top of the symbol.
Returns text format of the label to be shown on top of the symbol.
Unchecks all items belonging to the same layer as this node.
-
checkAllItems
(self)¶ Checks all items belonging to the same layer as this node.
See also
New in version 2.14.
-
childEvent
()¶
-
connectNotify
()¶
-
createTemporaryRenderContext
()¶
-
customEvent
()¶
-
data
(self, role: int) → Any¶ - Parameters
role (int) –
- Return type
Any
-
disconnectNotify
()¶
-
drawSymbol
(self, settings: QgsLegendSettings, ctx: QgsLayerTreeModelLegendNode.ItemContext, itemHeight: float) → QSizeF¶ - Parameters
settings (QgsLegendSettings) –
itemHeight (float) –
- Return type
QSizeF
-
flags
(self) → Qt.ItemFlags¶ - Return type
Qt.ItemFlags
-
iconSize
(self) → QSize¶ New in version 2.10.
- Return type
QSize
-
invalidateMapBasedData
(self)¶
-
isScaleOK
(self, scale: float) → bool¶ - Parameters
scale (float) –
- Return type
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.
- Return type
QSize
-
receivers
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setData
(self, value: Any, role: int) → bool¶ - Parameters
value (Any) –
role (int) –
- Return type
bool
-
setEmbeddedInParent
(self, embedded: bool)¶ - Parameters
embedded (bool) –
-
setIconSize
(self, sz: QSize)¶ Set the icon size
New in version 2.10.
- Parameters
sz (QSize) –
-
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 (QgsSymbol) – new symbol for node. Ownership is transferred.
See also
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.
- Parameters
label (str) –
-
setTextOnSymbolTextFormat
(self, format: QgsTextFormat)¶ Sets format of text to be shown on top of the symbol.
New in version 3.2.
- Parameters
format (QgsTextFormat) –
-
setUserLabel
(self, userLabel: str)¶ - Parameters
userLabel (str) –
-
symbol
(self) → QgsSymbol¶ Returns the symbol used by the legend node.
See also
New in version 2.14.
- Return type
-
textOnSymbolLabel
(self) → str¶ Returns label of text to be shown on top of the symbol.
New in version 3.2.
- Return type
str
-
textOnSymbolTextFormat
(self) → QgsTextFormat¶ Returns text format of the label to be shown on top of the symbol.
New in version 3.2.
- Return type
-
timerEvent
()¶
-
uncheckAllItems
(self)¶ Unchecks all items belonging to the same layer as this node.
See also
New in version 2.14.