Class: QgsMapLayerLegendUtils¶
-
class
qgis.core.
QgsMapLayerLegendUtils
¶ Bases:
sip.wrapper
Miscellaneous utility functions for handling of map layer legend
Methods
update according to layer node’s custom properties (order of items, user labels for items)
- param nodeLayer
- param nodeLayer
- param nodeLayer
- param nodeLayer
- param nodeLayer
- param nodeLayer
-
applyLayerNodeProperties
(nodeLayer: QgsLayerTreeLayer, nodes: Iterable[QgsLayerTreeModelLegendNode])¶ update according to layer node’s custom properties (order of items, user labels for items)
- Parameters
nodeLayer (QgsLayerTreeLayer) –
nodes (Iterable[QgsLayerTreeModelLegendNode]) –
-
hasLegendNodeOrder
(nodeLayer: QgsLayerTreeLayer) → bool¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
- Return type
bool
-
hasLegendNodeUserLabel
(nodeLayer: QgsLayerTreeLayer, originalIndex: int) → bool¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
- Return type
bool
-
legendNodeOrder
(nodeLayer: QgsLayerTreeLayer) → List[int]¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
- Return type
List[int]
-
legendNodeUserLabel
(nodeLayer: QgsLayerTreeLayer, originalIndex: int) → str¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
- Return type
str
-
setLegendNodeOrder
(nodeLayer: QgsLayerTreeLayer, order: Iterable[int])¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
order (Iterable[int]) –
-
setLegendNodeUserLabel
(nodeLayer: QgsLayerTreeLayer, originalIndex: int, newLabel: str)¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
newLabel (str) –