QLegend#

The QLegend class displays the legend of a chart. More…

Synopsis#

Properties#

alignment - How the legend is aligned with the chart
backgroundVisible - Whether the legend background is visible
borderColor - Line color of the legend
color - Background (brush) color of the legend
font - Of the markers used by the legend
labelColor - Color of the brush used to draw labels
markerShape
reverseMarkers - Whether reverse order is used for the markers in the legend
showToolTips - Whether tooltips are shown when the text is truncated

Functions#

def alignment ()
def attachToChart ()
def borderColor ()
def brush ()
def color ()
def detachFromChart ()
def isAttachedToChart ()
def isBackgroundVisible ()
def isInteractive ()
def labelBrush ()
def labelColor ()
def markerShape ()
def markers ([series=None])
def pen ()
def reverseMarkers ()
def setAlignment (alignment)
def setBackgroundVisible ([visible=true])
def setBorderColor (color)
def setBrush (brush)
def setColor (color)
def setInteractive (interactive)
def setLabelBrush (brush)
def setLabelColor (color)
def setMarkerShape (shape)
def setPen (pen)
def setReverseMarkers ([reverseMarkers=true])
def setShowToolTips (show)
def showToolTips ()

Signals#

def attachedToChartChanged (attachedToChart)
def backgroundVisibleChanged (visible)
def borderColorChanged (color)
def colorChanged (color)
def fontChanged (font)
def interactiveChanged (interactive)
def labelColorChanged (color)
def markerShapeChanged (shape)
def reverseMarkersChanged (reverseMarkers)
def showToolTipsChanged (showToolTips)

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

A legend is a graphical object that displays the legend of a chart. The legend state is updated by QChart when series change. By default, the legend is attached to the chart, but it can be detached to make it independent of chart layout. Legend objects cannot be created or deleted, but they can be referenced via the QChart class.

See also

QChart

class PySide6.QtCharts.QLegend#

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property PᅟySide6.QtCharts.QLegend.alignment: Alignment#

This property holds How the legend is aligned with the chart..

Can be AlignTop , AlignBottom , AlignLeft , AlignRight . If you set more than one flag, the result is undefined.

Access functions:

alignment ()
setAlignment (alignment)

property PᅟySide6.QtCharts.QLegend.backgroundVisible: bool#

This property holds Whether the legend background is visible..

Access functions:

isBackgroundVisible ()
setBackgroundVisible ([visible=true])
Signal backgroundVisibleChanged (visible)

property PᅟySide6.QtCharts.QLegend.borderColor: PySide6.QtGui.QColor#

This property holds The line color of the legend..

Access functions:

borderColor ()
setBorderColor (color)
Signal borderColorChanged (color)

property PᅟySide6.QtCharts.QLegend.color: PySide6.QtGui.QColor#

This property holds The background (brush) color of the legend..

If you change the color of the legend, the style of the legend brush is set to SolidPattern .

Access functions:

color ()
setColor (color)
Signal colorChanged (color)

property PᅟySide6.QtCharts.QLegend.font: PySide6.QtGui.QFont#

This property holds The font of the markers used by the legend..

Access functions:

Signal fontChanged (font)

property PᅟySide6.QtCharts.QLegend.labelColor: PySide6.QtGui.QColor#

This property holds The color of the brush used to draw labels..

Access functions:

labelColor ()
setLabelColor (color)
Signal labelColorChanged (color)

property PᅟySide6.QtCharts.QLegend.markerShape: MarkerShape#

The default shape of the legend markers. The default value is MarkerShapeRectangle.

Access functions:

markerShape ()
setMarkerShape (shape)
Signal markerShapeChanged (shape)

property PᅟySide6.QtCharts.QLegend.reverseMarkers: bool#

This property holds Whether reverse order is used for the markers in the legend..

This property is false by default.

Access functions:

reverseMarkers ()
setReverseMarkers ([reverseMarkers=true])
Signal reverseMarkersChanged (reverseMarkers)

property PᅟySide6.QtCharts.QLegend.showToolTips: bool#

This property holds Whether tooltips are shown when the text is truncated..

This property is false by default.

Access functions:

showToolTips ()
setShowToolTips (show)
Signal showToolTipsChanged (showToolTips)

PySide6.QtCharts.QLegend.MarkerShape#

This enum describes the shape used when rendering legend marker items.

Constant

Description

QLegend.MarkerShapeDefault

Default shape determined by QLegend is used for the marker. This value is supported only for individual QLegendMarker items.

QLegend.MarkerShapeRectangle

Rectangular markers are used. Marker size is determined by font size.

QLegend.MarkerShapeCircle

Circular markers are used. Marker size is determined by font size.

QLegend.MarkerShapeRotatedRectangle

Rotated rectangle shaped markers are used. Marker size is determined by font size.

QLegend.MarkerShapeTriangle

Triangular markers are used. Marker size is determined by font size.

QLegend.MarkerShapeStar

Star shaped markers are used. Marker size is determined by font size.

QLegend.MarkerShapePentagon

Pentagon shaped markers are used. Marker size is determined by font size.

QLegend.MarkerShapeFromSeries

The marker shape is determined by the series. In case of a scatter series, the legend marker looks like a scatter dot and is the same size as the dot. In case of a line or spline series, the legend marker looks like a small segment of the line. For other series types, rectangular markers are shown. If a lightMarker is specified for a series, the lightMarker will be shown and its size will be determined by the series marker size.

See also

markerShape

Constant	Description
QLegend.MarkerShapeDefault	Default shape determined by `QLegend` is used for the marker. This value is supported only for individual `QLegendMarker` items.
QLegend.MarkerShapeRectangle	Rectangular markers are used. Marker size is determined by font size.
QLegend.MarkerShapeCircle	Circular markers are used. Marker size is determined by font size.
QLegend.MarkerShapeRotatedRectangle	Rotated rectangle shaped markers are used. Marker size is determined by font size.
QLegend.MarkerShapeTriangle	Triangular markers are used. Marker size is determined by font size.
QLegend.MarkerShapeStar	Star shaped markers are used. Marker size is determined by font size.
QLegend.MarkerShapePentagon	Pentagon shaped markers are used. Marker size is determined by font size.
QLegend.MarkerShapeFromSeries	The marker shape is determined by the series. In case of a scatter series, the legend marker looks like a scatter dot and is the same size as the dot. In case of a line or spline series, the legend marker looks like a small segment of the line. For other series types, rectangular markers are shown. If a `lightMarker` is specified for a series, the `lightMarker` will be shown and its size will be determined by the series marker size.

PySide6.QtCharts.QLegend.alignment()#

Return type:: Alignment

See also

setAlignment()

Getter of property alignment .

PySide6.QtCharts.QLegend.attachToChart()#

Attaches the legend to a chart. The chart may adjust the layout of the legend.

PySide6.QtCharts.QLegend.attachedToChartChanged(attachedToChart)#

Parameters:: attachedToChart – bool

This signal is emitted when the legend is attached to or detached from the chart.

PySide6.QtCharts.QLegend.backgroundVisibleChanged(visible)#

Parameters:: visible – bool

This signal is emitted when the visibility of the legend background changes to visible.

Notification signal of property backgroundVisible .

PySide6.QtCharts.QLegend.borderColor()#

Return type:: PySide6.QtGui.QColor

See also

setBorderColor()

Getter of property borderColor .

PySide6.QtCharts.QLegend.borderColorChanged(color)#

Parameters:: color – PySide6.QtGui.QColor

This signal is emitted when the border color of the legend background changes to color.

Notification signal of property borderColor .

PySide6.QtCharts.QLegend.brush()#

Return type:: PySide6.QtGui.QBrush

Returns the brush used by the legend.

See also

setBrush()

PySide6.QtCharts.QLegend.color()#

Return type:: PySide6.QtGui.QColor

See also

setColor()

Getter of property color .

PySide6.QtCharts.QLegend.colorChanged(color)#

Parameters:: color – PySide6.QtGui.QColor

This signal is emitted when the color of the legend background changes to color.

Notification signal of property color .

PySide6.QtCharts.QLegend.detachFromChart()#

Detaches the legend from the chart. The chart will no longer adjust the layout of the legend.

PySide6.QtCharts.QLegend.fontChanged(font)#

Parameters:: font – PySide6.QtGui.QFont

This signal is emitted when the font of the markers of the legend changes to font.

Notification signal of property font .

PySide6.QtCharts.QLegend.interactiveChanged(interactive)#

Parameters:: interactive – bool

PySide6.QtCharts.QLegend.isAttachedToChart()#

Return type:: bool

Returns true, if the legend is attached to a chart.

PySide6.QtCharts.QLegend.isBackgroundVisible()#

Return type:: bool

Returns the visibility of the legend background.

Getter of property backgroundVisible .

PySide6.QtCharts.QLegend.isInteractive()#

Return type:: bool

Returns whether the legend can be dragged or resized using a mouse when it is detached.

See also

setInteractive()

PySide6.QtCharts.QLegend.labelBrush()#

Return type:: PySide6.QtGui.QBrush

Returns the brush used to draw labels.

See also

setLabelBrush()

PySide6.QtCharts.QLegend.labelColor()#

Return type:: PySide6.QtGui.QColor

See also

setLabelColor()

Getter of property labelColor .

PySide6.QtCharts.QLegend.labelColorChanged(color)#

Parameters:: color – PySide6.QtGui.QColor

This signal is emitted when the color of the brush used to draw the legend labels changes to color.

Notification signal of property labelColor .

PySide6.QtCharts.QLegend.markerShape()#

Return type:: MarkerShape

See also

setMarkerShape()

Getter of property markerShape .

PySide6.QtCharts.QLegend.markerShapeChanged(shape)#

Parameters:: shape – MarkerShape

Notification signal of property markerShape .

PySide6.QtCharts.QLegend.markers([series=None])#

Parameters:: series – PySide6.QtCharts.QAbstractSeries
Return type:

Returns the list of markers in the legend. The list can be filtered by specifying the series for which the markers are returned.

PySide6.QtCharts.QLegend.pen()#

Return type:: PySide6.QtGui.QPen

Returns the pen used by the legend.

See also

setPen()

PySide6.QtCharts.QLegend.reverseMarkers()#

Return type:: bool

See also

setReverseMarkers()

Getter of property reverseMarkers .

PySide6.QtCharts.QLegend.reverseMarkersChanged(reverseMarkers)#

Parameters:: reverseMarkers – bool

This signal is emitted when the use of reverse order for the markers in the legend is changed to reverseMarkers.

Notification signal of property reverseMarkers .

PySide6.QtCharts.QLegend.setAlignment(alignment)#

Parameters:: alignment – Alignment

See also

alignment()

Setter of property alignment .

PySide6.QtCharts.QLegend.setBackgroundVisible([visible=true])#

Parameters:: visible – bool

Sets the visibility of the legend background to visible.

See also

isBackgroundVisible()

Setter of property backgroundVisible .

PySide6.QtCharts.QLegend.setBorderColor(color)#

Parameters:: color – PySide6.QtGui.QColor

See also

borderColor()

Setter of property borderColor .

PySide6.QtCharts.QLegend.setBrush(brush)#

Parameters:: brush – PySide6.QtGui.QBrush

Sets the brush that is used to draw the background of the legend.

See also

brush()

PySide6.QtCharts.QLegend.setColor(color)#

Parameters:: color – PySide6.QtGui.QColor

See also

color()

Setter of property color .

PySide6.QtCharts.QLegend.setInteractive(interactive)#

Parameters:: interactive – bool

When interactive is true and the legend is detached, the legend is able to be moved and resized with a mouse in a similar way to a window.

The legend will automatically attach to an edge of the chart by dragging it off of that edge. Double clicking an attached legend will detach it. This is false by default.

See also

isInteractive()

PySide6.QtCharts.QLegend.setLabelBrush(brush)#

Parameters:: brush – PySide6.QtGui.QBrush

Sets the brush used to draw the legend labels to brush.

See also

labelBrush()

PySide6.QtCharts.QLegend.setLabelColor(color)#

Parameters:: color – PySide6.QtGui.QColor

See also

labelColor()

Setter of property labelColor .

PySide6.QtCharts.QLegend.setMarkerShape(shape)#

Parameters:: shape – MarkerShape

See also

markerShape()

Setter of property markerShape .

PySide6.QtCharts.QLegend.setPen(pen)#

Parameters:: pen – PySide6.QtGui.QPen

Sets the pen that is used to draw the legend borders.

See also

pen()

PySide6.QtCharts.QLegend.setReverseMarkers([reverseMarkers=true])#

Parameters:: reverseMarkers – bool

See also

reverseMarkers()

Setter of property reverseMarkers .

PySide6.QtCharts.QLegend.setShowToolTips(show)#

Parameters:: show – bool

When show is true, the legend labels will show a tooltip when the mouse hovers over them if the label itself is shown elided. This is false by default.

See also

showToolTips()

Setter of property showToolTips .

PySide6.QtCharts.QLegend.showToolTips()#

Return type:: bool

Returns whether the tooltips are shown for the legend labels when they are elided.

See also

setShowToolTips()

Getter of property showToolTips .

PySide6.QtCharts.QLegend.showToolTipsChanged(showToolTips)#

Parameters:: showToolTips – bool

This signal is emitted when the visibility of tooltips is changed to showToolTips.

Notification signal of property showToolTips .