Class: QgsMapLayerLegendUtils

class qgis.core.QgsMapLayerLegendUtils

Bases: sip.wrapper

Miscellaneous utility functions for handling of map layer legend

Methods

applyLayerNodeProperties

update according to layer node’s custom properties (order of items, user labels for items)

hasLegendNodeOrder

param nodeLayer

hasLegendNodeUserLabel

param nodeLayer

legendNodeOrder

param nodeLayer

legendNodeUserLabel

param nodeLayer

setLegendNodeOrder

param nodeLayer

setLegendNodeUserLabel

param nodeLayer

applyLayerNodeProperties(nodeLayer: QgsLayerTreeLayer, nodes: Iterable[QgsLayerTreeModelLegendNode])

update according to layer node’s custom properties (order of items, user labels for items)

Parameters
hasLegendNodeOrder(nodeLayer: QgsLayerTreeLayer) → bool
Parameters

nodeLayer (QgsLayerTreeLayer) –

Return type

bool

hasLegendNodeUserLabel(nodeLayer: QgsLayerTreeLayer, originalIndex: int) → bool
Parameters
Return type

bool

legendNodeOrder(nodeLayer: QgsLayerTreeLayer) → List[int]
Parameters

nodeLayer (QgsLayerTreeLayer) –

Return type

List[int]

legendNodeUserLabel(nodeLayer: QgsLayerTreeLayer, originalIndex: int) → str
Parameters
Return type

str

setLegendNodeOrder(nodeLayer: QgsLayerTreeLayer, order: Iterable[int])
Parameters
setLegendNodeUserLabel(nodeLayer: QgsLayerTreeLayer, originalIndex: int, newLabel: str)
Parameters