Class: QgsRasterSymbolLegendNode

class qgis.core.QgsRasterSymbolLegendNode

Bases: QgsLayerTreeModelLegendNode

Implementation of legend node interface for displaying raster legend entries

QgsRasterSymbolLegendNode(nodeLayer: Optional[QgsLayerTreeLayer], color: Union[QColor, Qt.GlobalColor], label: Optional[str], parent: Optional[QObject] = None, isCheckable: bool = False, ruleKey: Optional[str] = ‘’) Constructor for QgsRasterSymbolLegendNode.

Parameters:

• nodeLayer – layer node

• color – color

• label – label

• parent – attach a parent QObject to the legend node.

• isCheckable – set to True to enable the checkbox for the node (since QGIS 3.18)

• ruleKey –

  optional identifier to allow a unique ID to be assigned to the node by a renderer (since QGIS 3.18)

  Methods

  childEvent
  connectNotify
  createTemporaryRenderContext	Returns a temporary context or None if legendMapViewData are not valid
  customEvent
  data	param role:
  disconnectNotify
  drawSymbol	param settings:
  exportSymbolToJson	param settings:
  flags	rtype: Qt.ItemFlags
  isCheckable	Returns whether the item is user-checkable - whether renderer supports enabling/disabling it.
  isSignalConnected
  receivers
  ruleKey	Returns the unique identifier of node for identification of the item within renderer.
  sender
  senderSignalIndex
  setData	param value:
  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

Parameters:

role (int)

Return type:

Any

disconnectNotify(self, signal: QMetaMethod)

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

Parameters:

• settings (QgsLegendSettings)

• ctx (Optional[QgsLayerTreeModelLegendNode.ItemContext])

• itemHeight (float)

Return type:

QSizeF

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

Parameters:

• settings (QgsLegendSettings)

• context (QgsRenderContext)

Return type:

Dict[str, QJsonValue]

flags(self) → Qt.ItemFlags

Return type:

Qt.ItemFlags

isCheckable(self) → bool

Returns whether the item is user-checkable - whether renderer supports enabling/disabling it.

Added in version 3.18.

Return type:

bool

isSignalConnected(self, signal: QMetaMethod) → bool

receivers(self, signal: PYQT_SIGNAL) → int

ruleKey(self) → str

Returns the unique identifier of node for identification of the item within renderer.

Added in version 3.18.

Return type:

str

sender(self) → QObject | None

senderSignalIndex(self) → int

setData(self, value: Any, role: int) → bool

Parameters:

• value (Any)

• role (int)

Return type:

bool

timerEvent(self, a0: QTimerEvent | None)