fig.add_vrect() items do not hide when clicking on grouped legend if showlegend=False

[pcubillos]

Hi,

Here's a reproducible example below. Clicking on the legend group does not hide the second vrect (unlike for fig.add_trace(go.Scatter()) calls). I tried it on versions 5.23.0 and 5.19.0.

import plotly.graph_objects as go

fig = go.Figure()

fig.add_vrect(
    x0=1.0, x1=3.0,
    fillcolor="LightSalmon", opacity=0.3,
    layer="below", line_width=0,
    legendgrouptitle_text="Saturation",
    legendgroup='saturation',
    name='partial',
    showlegend=True,
)

fig.add_vrect(
    x0=3.5, x1=4.5,
    fillcolor="LightSalmon", opacity=0.3,
    layer="below", line_width=0,
    legendgroup='saturation',
    name='partial 2',
    showlegend=False,
)

fig.show()

[lucas-schroeder]

I got the same problem with Shapes and legendgroup. Only when all legends are set to visible they can be toggled together, otherwise only the one with showlegend=True. I'm using Pyhton 3.10.0 and Plotly 5.23.0. Here's a reproducible example:

import pandas as pd
import numpy as np
import plotly.graph_objects as go

data = {
    "Time": pd.date_range("2024-01-01", periods=20, freq="D"),
    "Value": np.random.randint(0, 100, size=20),
}
df = pd.DataFrame(data)

fig = go.Figure()
fig.add_trace(
    go.Scatter(
        x=df["Time"],
        y=df["Value"],
        name="From DataFrame",
        legendgroup="Data",
        legendgrouptitle=dict(text="Data"),
    )
)
shapes=[]

for i, idx in enumerate([1,5,6,14]):
    shapes.append(
        dict(
            type="rect",
            xref="x",
            yref="paper",
            x0=df["Time"][idx-1],
            y0=0,
            x1=df["Time"][idx+1],
            y1=1,
            line=dict(width=0),
            fillcolor="rgba(178, 222, 39, 0.3)",
            layer="below",
            name=f"Highlight {i}",
            legendgroup="Highlights",
            legendgrouptitle=dict(text="Highlights"),
            showlegend=True if i == 0 else False,
        )
    )

fig.update_layout(
	title="Highlighted data",
	xaxis_title="Time",
	yaxis_title="Value",
	shapes=shapes,
)

fig.show()

[ritsuki1227]

I’m experiencing the same issue on plotly 6.0.0.

[mhangaard]

I have the same issue with version 6.5.0

In a notebook:

import plotly.graph_objects as go
from plotly import __version__ as plotly_version
print(f"Plotly version: {plotly_version}")

fig = go.Figure()
traces = [go.Scatter(x=[1, 2, 3], y=[4, 5, 6], mode='lines', name='Line 1', legendgroup='group1'),
          go.Scatter(x=[1, 2, 3], y=[6, 5, 4], mode='lines', name='Line 2', legendgroup='group1', showlegend=False)
          ]


fig.add_shape(
    type="rect",
    x0=1.5, y0=4.5, x1=2.5, y1=5.5,
    line={'color': "RoyalBlue"},
    name="My Rectangle",
    legendgroup="shapes",
    showlegend=True
)

fig.add_shape(
    type="rect",
    x0=1, y0=1, x1=2.5, y1=5.5,
    line={'color': "Red"},
    name="My Rectangle",
    legendgroup="shapes",
    showlegend=False
)

fig.add_traces(traces)
fig

I added traces to confirm the intended behavior. I would think legendgroups for traces and shapes should work in the same way, great if they could even work while grouped together.

[emilykl]

Hi @pcubillos, apologies for the very late follow-up. This was fixed by plotly/plotly.js#7813 and first released in plotly.py v6.8.0. Shapes with showlegend=False are now hidden/shown when hiding/showing all shapes, the same as for traces.