Class: QgsMapLayerLegendUtils¶

Miscellaneous utility functions for handling of map layer legend

Static Methods

`applyLayerNodeProperties`	update according to layer node's custom properties (order of items, user labels for items)
`hasLegendNodeOrder`
`hasLegendNodeUserLabel`
`legendNodeColorRampSettings`	Returns the custom legend color ramp settings for the legend node belonging to nodeLayer at the specified originalIndex.
`legendNodeColumnBreak`	Returns whether a forced column break should occur before the node.
`legendNodeCustomSymbol`	Returns the custom legend symbol for the legend node belonging to nodeLayer at the specified originalIndex.
`legendNodeOrder`
`legendNodePatchShape`	Returns the legend patch shape for the legend node belonging to nodeLayer at the specified originalIndex.
`legendNodeSymbolSize`	Returns the legend node symbol size for the legend node belonging to nodeLayer at the specified originalIndex.
`legendNodeUserLabel`
`setLegendNodeColorRampSettings`	Sets a custom legend color ramp settings for the legend node belonging to nodeLayer at the specified originalIndex.
`setLegendNodeColumnBreak`	Sets whether a forced column break should occur before the node.
`setLegendNodeCustomSymbol`	Sets a custom legend symbol for the legend node belonging to nodeLayer at the specified originalIndex.
`setLegendNodeOrder`
`setLegendNodePatchShape`	Sets the legend patch shape for the legend node belonging to nodeLayer at the specified originalIndex.
`setLegendNodeSymbolSize`	Sets the legend symbol size for the legend node belonging to nodeLayer at the specified originalIndex.
`setLegendNodeUserLabel`

class qgis.core.QgsMapLayerLegendUtils[source]¶

Bases: object

static applyLayerNodeProperties(nodeLayer: QgsLayerTreeLayer | None, nodes: Iterable[QgsLayerTreeModelLegendNode])[source]¶

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

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
nodes (Iterable[QgsLayerTreeModelLegendNode])

static hasLegendNodeOrder(nodeLayer: QgsLayerTreeLayer | None) → bool[source]¶

Parameters:: nodeLayer (Optional[QgsLayerTreeLayer])
Return type:: bool

static hasLegendNodeUserLabel(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int) → bool[source]¶

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)

Return type:

bool

static legendNodeColorRampSettings(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int) → QgsColorRampLegendNodeSettings | None[source]¶

Returns the custom legend color ramp settings for the legend node belonging to nodeLayer at the specified originalIndex.

If the corresponding legend node is not a QgsColorRampLegendNode then calling this method will return None.

If the returned value is non-None, they will be used in place of the default settings when rendering the legend node.

Caller takes ownership of the returned settings.

See also

setLegendNodeColorRampSettings()

Added in version 3.18.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)

Return type:

Optional[QgsColorRampLegendNodeSettings]

static legendNodeColumnBreak(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int) → bool[source]¶

Returns whether a forced column break should occur before the node.

See also

setLegendNodeColumnBreak()

Added in version 3.14.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)

Return type:

bool

static legendNodeCustomSymbol(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int) → QgsSymbol | None[source]¶

Returns the custom legend symbol for the legend node belonging to nodeLayer at the specified originalIndex.

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

setLegendNodeCustomSymbol()

Added in version 3.14.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)

Return type:

Optional[QgsSymbol]

static legendNodeOrder(nodeLayer: QgsLayerTreeLayer | None) → List[int]¶

Parameters:: nodeLayer (Optional[QgsLayerTreeLayer])
Return type:: List[int]

static legendNodePatchShape(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int) → QgsLegendPatchShape[source]¶

Returns the legend patch shape for the legend node belonging to nodeLayer at the specified originalIndex.

See also

setLegendNodePatchShape()

Added in version 3.14.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)

Return type:

QgsLegendPatchShape

static legendNodeSymbolSize(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int) → QSizeF[source]¶

Returns the legend node symbol size for the legend node belonging to nodeLayer at the specified originalIndex.

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

setLegendNodeSymbolSize()

Added in version 3.14.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)

Return type:

QSizeF

static legendNodeUserLabel(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int) → str[source]¶

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)

Return type:

str

static setLegendNodeColorRampSettings(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int, settings: QgsColorRampLegendNodeSettings | None)[source]¶

Sets a custom legend color ramp settings for the legend node belonging to nodeLayer at the specified originalIndex.

If the corresponding legend node is not a QgsColorRampLegendNode then calling this method will have no effect.

If settings is non-None, they will be used in place of the default settigns when rendering the legend node.

See also

legendNodeColorRampSettings()

Added in version 3.18.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)
settings (Optional[QgsColorRampLegendNodeSettings])

static setLegendNodeColumnBreak(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int, columnBreakBeforeNode: bool)[source]¶

Sets whether a forced column break should occur before the node.

See also

legendNodeColumnBreak()

Added in version 3.14.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)
columnBreakBeforeNode (bool)

static setLegendNodeCustomSymbol(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int, symbol: QgsSymbol | None)[source]¶

Sets a custom legend symbol for the legend node belonging to nodeLayer at the specified originalIndex.

If symbol is non-None, it will be used in place of the default symbol when rendering the legend node.

See also

legendNodeCustomSymbol()

Added in version 3.14.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)
symbol (Optional[QgsSymbol])

static setLegendNodeOrder(nodeLayer: QgsLayerTreeLayer | None, order: Iterable[int])[source]¶

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
order (Iterable[int])

static setLegendNodePatchShape(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int, shape: QgsLegendPatchShape)[source]¶

Sets the legend patch shape for the legend node belonging to nodeLayer at the specified originalIndex.

See also

legendNodePatchShape()

Added in version 3.14.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)
shape (QgsLegendPatchShape)

static setLegendNodeSymbolSize(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int, size: QSizeF)[source]¶

Sets the legend symbol size for the legend node belonging to nodeLayer at the specified originalIndex.

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

legendNodeSymbolSize()

Added in version 3.14.

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)
size (QSizeF)

static setLegendNodeUserLabel(nodeLayer: QgsLayerTreeLayer | None, originalIndex: int, newLabel: str | None)[source]¶

Parameters:

nodeLayer (Optional[QgsLayerTreeLayer])
originalIndex (int)
newLabel (Optional[str])