Bug Report: Template updatemenus and annotations not transferred to figures
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 18.8k
- Forks
- 2.8k
- Merge moyen
- 16 h 26 min
- PR mergées (30 j)
- 21
Description
Bug Report: Template updatemenus and annotations not transferred to figures
Description
When defining updatemenus and annotations in a Plotly template, they are not properly transferred to figures that use the template. While other template properties (like colors, fonts, etc.) are transferred correctly, updatemenus and annotations are created as empty lists.
Expected Behavior
All layout properties defined in a template, including updatemenus and annotations, should be transferred to figures that use the template.
Actual Behavior
fig.layout.updatemenusandfig.layout.annotationsare created (notNone)- However, they are empty lists, losing all content defined in the template
- Other template properties (like
paper_bgcolor) are transferred correctly
Minimal Reproducible Example
import plotly.graph_objects as go
import plotly.io as pio
import numpy as np
# Create template with updatemenus and annotations
my_template = go.layout.Template(
layout=dict(
updatemenus=[
dict(
buttons=[
dict(
label="View 1",
method="relayout",
args=[{"scene.camera.eye": dict(x=1, y=1, z=1)}],
),
],
direction="down",
showactive=True,
x=0.1,
y=1.1,
),
],
annotations=[
dict(
text="Test annotation",
x=0.5,
y=1.1,
xref="paper",
yref="paper",
showarrow=False,
),
],
paper_bgcolor="rgb(240,240,240)", # This works correctly
)
)
# Register template
pio.templates["my_template"] = my_template
# Create figure with template
fig = go.Figure(
data=[go.Scatter3d(
x=np.random.normal(0, 1, 100),
y=np.random.normal(0, 1, 100),
z=np.random.normal(0, 1, 100),
mode="markers",
)]
)
fig.update_layout(template="my_template")
# Check results
print("Template updatemenus length:", len(my_template.layout.updatemenus)) # 1
print("Figure updatemenus length:", len(fig.layout.updatemenus)) # 0
print("Template annotations length:", len(my_template.layout.annotations)) # 1
print("Figure annotations length:", len(fig.layout.annotations)) # 0
Current Workaround
The only workaround is to manually apply the updatemenus and annotations after applying the template:
fig.update_layout(
updatemenus=my_template.layout.updatemenus,
annotations=my_template.layout.annotations,
)
Environment
- Python: 3.11.7
- Plotly: 5.24.1
- OS: Linux
Additional Context
This issue affects any template that tries to define interactive UI elements like buttons or annotations. The workaround requires additional code and makes templates less useful for defining reusable UI components.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par l’exemple minimal reproductible de l’issue et suivez la manière dont fig.update_layout(template="my_template") applique les propriétés de layout. Comparez le template ainsi que les updatemenus et annotations de la figure, puis ajoutez une couverture de régression montrant que leur contenu est transféré, tandis que paper_bgcolor reste correct.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- data-visualization
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100