plotly / plotly/plotly.py

Bug Report: Template updatemenus and annotations not transferred to figures

Đang mở
#5,037 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Python
Star
18.8k
Fork
2.8k
Merge trung bình
16 giờ 26 phút
Pull request đã merge (30 ngày)
21

Mô tả

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.updatemenus and fig.layout.annotations are created (not None)
  • 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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với ví dụ tối thiểu có thể tái hiện trong issue và theo dõi cách fig.update_layout(template="my_template") áp dụng các thuộc tính layout. So sánh template với các updatemenus và annotations của figure, sau đó thêm phạm vi kiểm thử hồi quy cho thấy nội dung của chúng được chuyển sang trong khi paper_bgcolor vẫn giữ nguyên chính xác.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
data-visualization
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.