Class: QgsColorRampLegendNode

class qgis.core.QgsColorRampLegendNode

Bases: QgsLayerTreeModelLegendNode

A legend node which renders a color ramp.

Added in version 3.18.

QgsColorRampLegendNode(nodeLayer: Optional[QgsLayerTreeLayer], ramp: Optional[QgsColorRamp], minimumLabel: Optional[str], maximumLabel: Optional[str], parent: Optional[QObject] = None) Constructor for QgsColorRampLegendNode.

Parameters:

• nodeLayer – layer node

• ramp – color ramp to render in node. Ownership is transferred to the node.

• minimumLabel – label text to render for the minimum value in the ramp

• maximumLabel – label text to render for the maximum value in the ramp

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

QgsColorRampLegendNode(nodeLayer: Optional[QgsLayerTreeLayer], ramp: Optional[QgsColorRamp], settings: QgsColorRampLegendNodeSettings, minimumValue: float, maximumValue: float, parent: Optional[QObject] = None) Constructor for QgsColorRampLegendNode.

Parameters:

• nodeLayer – layer node

• ramp – color ramp to render in node. Ownership is transferred to the node.

• settings – node settings

• minimumValue – value associated with minimum of ramp

• maximumValue – value associated with maximum of ramp

• parent –

  attach a parent QObject to the legend node.

  Methods

  childEvent
  connectNotify
  createTemporaryRenderContext	Returns a temporary context or None if legendMapViewData are not valid
  customEvent
  data	param role:
  disconnectNotify
  drawSymbol	param settings:
  drawSymbolText	param settings:
  exportSymbolToJson	param settings:
  iconSize	Returns the icon size, which is how large the ramp will render in a layer tree widget.
  isSignalConnected
  ramp	Returns the color ramp used by the node.
  receivers
  sender
  senderSignalIndex
  setIconSize	Set the icon size, which controls how large the ramp will render in a layer tree widget.
  setSettings	Sets the node's settings.
  settings	Returns the node's settings.
  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

drawSymbolText(self, settings: QgsLegendSettings, ctx: QgsLayerTreeModelLegendNode.ItemContext | None, symbolSize: QSizeF) → QSizeF

Parameters:

• settings (QgsLegendSettings)

• ctx (Optional[QgsLayerTreeModelLegendNode.ItemContext])

• symbolSize (QSizeF)

Return type:

QSizeF

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

Parameters:

• settings (QgsLegendSettings)

• context (QgsRenderContext)

Return type:

Dict[str, QJsonValue]

iconSize(self) → QSize

Returns the icon size, which is how large the ramp will render in a layer tree widget.

See also

setIconSize()

Return type:

QSize

isSignalConnected(self, signal: QMetaMethod) → bool

ramp(self) → QgsColorRamp | None

Returns the color ramp used by the node.

Return type:

Optional[QgsColorRamp]

receivers(self, signal: PYQT_SIGNAL) → int

sender(self) → QObject | None

senderSignalIndex(self) → int

setIconSize(self, size: QSize)

Set the icon size, which controls how large the ramp will render in a layer tree widget.

See also

iconSize()

Parameters:

size (QSize)

setSettings(self, settings: QgsColorRampLegendNodeSettings)

Sets the node’s settings.

See also

settings()

Parameters:

settings (QgsColorRampLegendNodeSettings)

settings(self) → QgsColorRampLegendNodeSettings

Returns the node’s settings.

See also

setSettings()

Return type:

QgsColorRampLegendNodeSettings

timerEvent(self, a0: QTimerEvent | None)