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
Returns whether a forced column break should occur before the node.
Returns the custom legend symbol for the legend node belonging to
nodeLayer
at the specifiedoriginalIndex
.- param nodeLayer
Returns the legend patch shape for the legend node belonging to
nodeLayer
at the specifiedoriginalIndex
.Returns the legend node symbol size for the legend node belonging to
nodeLayer
at the specifiedoriginalIndex
.- param nodeLayer
Sets whether a forced column break should occur before the node.
Sets a custom legend
symbol
size for the legend node belonging tonodeLayer
at the specifiedoriginalIndex
.- param nodeLayer
Sets the legend patch
shape
for the legend node belonging tonodeLayer
at the specifiedoriginalIndex
.Sets the legend symbol
size
for the legend node belonging tonodeLayer
at the specifiedoriginalIndex
.- 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
-
legendNodeColumnBreak
(nodeLayer: QgsLayerTreeLayer, originalIndex: int) → bool¶ Returns whether a forced column break should occur before the node.
See also
New in version 3.14.
- Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
- Return type
bool
-
legendNodeCustomSymbol
(nodeLayer: QgsLayerTreeLayer, originalIndex: int) → QgsSymbol¶ Returns the custom legend symbol for the legend node belonging to
nodeLayer
at the specifiedoriginalIndex
.If the symbol is non-
None
, it will be used in place of the default symbol when rendering the legend node.Caller takes ownership of the returned symbol.
See also
New in version 3.14.
- Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
- Return type
-
legendNodeOrder
(nodeLayer: QgsLayerTreeLayer) → List[int]¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
- Return type
List[int]
-
legendNodePatchShape
(nodeLayer: QgsLayerTreeLayer, originalIndex: int) → QgsLegendPatchShape¶ Returns the legend patch shape for the legend node belonging to
nodeLayer
at the specifiedoriginalIndex
.See also
New in version 3.14.
- Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
- Return type
-
legendNodeSymbolSize
(nodeLayer: QgsLayerTreeLayer, originalIndex: int) → QSizeF¶ Returns the legend node symbol size for the legend node belonging to
nodeLayer
at the specifiedoriginalIndex
.If either the width or height are non-zero, they will be used when rendering the legend node instead of the default symbol width or height from
QgsLegendSettings
.See also
New in version 3.14.
- Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
- Return type
QSizeF
-
legendNodeUserLabel
(nodeLayer: QgsLayerTreeLayer, originalIndex: int) → str¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
- Return type
str
-
setLegendNodeColumnBreak
(nodeLayer: QgsLayerTreeLayer, originalIndex: int, columnBreakBeforeNode: bool)¶ Sets whether a forced column break should occur before the node.
See also
New in version 3.14.
- Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
columnBreakBeforeNode (bool) –
-
setLegendNodeCustomSymbol
(nodeLayer: QgsLayerTreeLayer, originalIndex: int, symbol: QgsSymbol)¶ Sets a custom legend
symbol
size for the legend node belonging tonodeLayer
at the specifiedoriginalIndex
.If
symbol
is non-None
, it will be used in place of the default symbol when rendering the legend node.See also
New in version 3.14.
- Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
symbol (QgsSymbol) –
-
setLegendNodeOrder
(nodeLayer: QgsLayerTreeLayer, order: Iterable[int])¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
order (Iterable[int]) –
-
setLegendNodePatchShape
(nodeLayer: QgsLayerTreeLayer, originalIndex: int, shape: QgsLegendPatchShape)¶ Sets the legend patch
shape
for the legend node belonging tonodeLayer
at the specifiedoriginalIndex
.See also
New in version 3.14.
- Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
shape (QgsLegendPatchShape) –
-
setLegendNodeSymbolSize
(nodeLayer: QgsLayerTreeLayer, originalIndex: int, size: QSizeF)¶ Sets the legend symbol
size
for the legend node belonging tonodeLayer
at the specifiedoriginalIndex
.If either the width or height are non-zero, they will be used when rendering the legend node instead of the default symbol width or height from
QgsLegendSettings
.See also
New in version 3.14.
- Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
size (QSizeF) –
-
setLegendNodeUserLabel
(nodeLayer: QgsLayerTreeLayer, originalIndex: int, newLabel: str)¶ - Parameters
nodeLayer (QgsLayerTreeLayer) –
originalIndex (int) –
newLabel (str) –