plotly / plotly/plotly.py

`groupclick="toggleitem"` Does Not Work Consistently Across Subplots in Plotly

Offen
#4,946 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug P3
Vorherrschende Sprache
Python
Sterne
18.8k
Forks
2.8k
Ø Merge
16 Std. 26 Min.
Gemergte PRs (30 T.)
21

Beschreibung

Description

When using the groupclick="toggleitem" parameter in Plotly with subplots, the toggling behavior for legend items only applies to traces in the first subplot. Traces in other subplots are not affected as expected, even when the legendgroup attribute is set consistently for all relevant traces.

This issue breaks the intended behavior of groupclick="toggleitem" for figures with subplots, where users would expect the toggling of a legend item to apply uniformly across all traces in the same legendgroup, regardless of their subplot.

Expected Behavior

Clicking a legend item with groupclick="toggleitem" should toggle the visibility of all traces in the corresponding legendgroup, including traces in subplots other than the first.

Observed Behavior

When clicking a legend item:

  • The visibility of traces is toggled only in the first subplot.

  • Traces in other subplots within the same legendgroup remain unaffected.

Minimal Reproducible Example
import plotly.graph_objects as go
from plotly.subplots import make_subplots

# Create a subplot figure
fig = make_subplots(rows=3, cols=1)

# Add traces to the first subplot
fig.add_trace(go.Scatter(x=[1, 2, 3], y=[1, 4, 9], name="Group A", legendgroup="group_a"), row=1, col=1)
fig.add_trace(go.Scatter(x=[1, 2, 3], y=[2, 4, 8], name="Group B", legendgroup="group_b"), row=1, col=1)

# Add traces to the second subplot
fig.add_trace(go.Scatter(x=[1, 2, 3], y=[1, 3, 6], name="Group A", legendgroup="group_a", showlegend=False), row=2, col=1)
fig.add_trace(go.Scatter(x=[1, 2, 3], y=[2, 5, 7], name="Group B", legendgroup="group_b", showlegend=False), row=2, col=1)

# Add traces to the third subplot
fig.add_trace(go.Scatter(x=[1, 2, 3], y=[1, 2, 3], name="Group A", legendgroup="group_a", showlegend=False), row=3, col=1)
fig.add_trace(go.Scatter(x=[1, 2, 3], y=[3, 5, 9], name="Group B", legendgroup="group_b", showlegend=False), row=3, col=1)

# Update layout with groupclick parameter
fig.update_layout(
    legend=dict(groupclick="toggleitem")
)

fig.show()

Steps to Reproduce
  1. Run the provided example code.

  2. Click on a legend item for "Group A" or "Group B."

  3. Observe that the traces in the first subplot toggle visibility as expected.

  4. Notice that traces in other subplots do not toggle visibility.

### Environment

Plotly Version: 5.24.1
Python Version: 3.11.9
Operating System: Windows 11
Browser: Edge 131.0.2903.86

Additional Notes

The issue does not occur when the groupclick parameter is omitted. The default behavior works as expected, where clicking a legend item toggles all traces in the same legendgroup across all subplots.

However, groupclick="toggleitem" is necessary for more granular control of legend interactions, and it should work consistently across subplots.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das bereitgestellte minimale reproduzierbare Python-Beispiel mit Plotly 5.24.1 auszuführen, und überprüfe das Verhalten der Legende in allen drei Subplots. Verfolge den Einstiegspunkt der Legendeninteraktion im Repository oder in seiner Plotly.js-Integration und füge anschließend eine Abdeckung für groupclick="toggleitem" mit gemeinsam genutzten Legendengruppen hinzu. Als erledigt gilt die Aufgabe, wenn das Klicken auf ein Legendenelement konsistent die erwartete Sichtbarkeitsänderung in jedem Subplot anwendet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
data-visualization
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
52/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.