[FEATURE]: get_subplot_geometry()
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- javascript, jupyter-notebook, python
- Lĩnh vực
- api, data-visualization, frontend
Hướng nghiên cứu
Bắt đầu bằng cách xác định các entry point của Figure và FigureWidget, cùng với phần xử lý layout hoặc hình học hiện có phía sau chúng. So sánh đường dẫn live graph-div được đề xuất với đường dẫn Kaleido tĩnh, sau đó xác định các bài kiểm thử cho kích thước subplot và figure được trả về, việc lọc và việc bao gồm nhãn trục. Được coi là hoàn tất khi một interface nhất quán hoạt động cho cả hai backend với các tọa độ pixel được ghi lại.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
[FEATURE]: get_subplot_geometry() — Expose Computed Subplot Cell Pixel Positions
Summary
When building dashboards or figures with custom overlays, users frequently need to know
the exact pixel position and dimensions of each subplot cell. Plotly computes these
internally but never surfaces them. This issue proposes a new method
get_subplot_geometry() that returns the computed pixel boundaries of every subplot
in a figure for production use.
Problem Statement
There is currently no reliable way to answer the question:
"Where exactly, in pixels, does subplot
xystart and how wide and tall is it?"
Users who need this information are forced to either:
- Hardcode pixel values based on trial and error (breaks on resize or data change)
- Reverse-engineer Plotly's internal domain-to-pixel calculations (brittle, undocumented)
- Call
full_figure_for_development(), which is explicitly not for production use, slow,
and returns normalizeddomainvalues (0–1) rather than actual pixels
This is a recurring pain point for users building:
- Dashboards where external HTML elements must align with specific subplot axes
- Stacked figures that need pixel-perfect y-axis alignment across separate charts
- Custom annotation layers that anchor to subplot cell boundaries
- Accessibility tools that need to describe where each chart lives on screen
Proposed Solution
A new method on Figure and FigureWidget:
geometry = fig.get_subplot_geometry()
Example Return Structure
{
"subplots": {
"xy": {
"x": 80,
"y": 60,
"width": 400,
"height": 300,
"x2": 480,
"y2": 360
},
"x2y2": {
"x": 520,
"y": 60,
"width": 400,
"height": 300,
"x2": 920,
"y2": 360
}
},
"figure": {
"total_width": 1000,
"total_height": 800
}
}
xandyare the top-left corner of the inner plotting area (inside the axes,
excluding tick labels and axis titles), measured in pixels from the top-left of
the figure.
Optional Parameters
# Include outer bounding box that covers tick labels and axis titles
fig.get_subplot_geometry(include_axis_labels=True)
# Limit results to specific subplots
fig.get_subplot_geometry(subplots=["xy", "x2y2"])
Two Backend Paths, One Interface
FigureWidgetin Jupyter: queries the live graph div directly for true
browser-rendered pixel values- Static
Figure: falls back to a scoped Kaleido render using the figure's
explicitwidthandheight
The user does not manage which path is used — the method selects automatically.
JavaScript Access
// No new method needed for JS users
gd._computedLayout.subplots["xy"].x
gd._computedLayout.subplots["xy"].width
gd._computedLayout.figure.total_width
Why Not Use full_figure_for_development()?
full_figure_for_development() exposes normalized domain values (e.g. [0.0, 0.45])
but:
- Does not return pixel positions
- Is documented as not for production use
- Is slow and returns a very large object
- Does not reflect true browser dimensions when using
FigureWidget
This feature is the production-safe, pixel-accurate alternative for layout geometry
specifically.
Prior Art
| Tool | Equivalent |
|---|---|
matplotlib |
ax.get_position(), ax.get_window_extent() |
bokeh |
plot.inner_width, plot.inner_height |
| Browser DOM | element.getBoundingClientRect() |
Backward Compatibility
This is a purely additive change. No existing figures, attributes, or workflows
are affected.
Related Issues
- Companion to:
[FEATURE]: get_computed_values()(https://github.com/plotly/plotly.py/issues/5552) - Companion to:
[FEATURE]: autorangePadding()(https://github.com/plotly/plotly.py/issues/5555) - Related to any issue requesting axis alignment across multiple figures
I'm happy to help refine the return structure, naming conventions, or scope.
The goal is to open a concrete discussion rather than a vague wish.
- Ngôn ngữ chính
- Python
- Star
- 18.8k
- Fork
- 2.8k
- Merge trung bình
- 13 giờ 41 phút
- Pull request đã merge (30 ngày)
- 21
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của plotly/plotly.py
-
P3 size: 1 task
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
P3 size: 1 task
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
bug P1
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 68/100
-
feature P3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
-
feature P3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Tất cả issue của plotly/plotly.py
Issue tương tự
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 90/100
learningequality/ricecooker#747 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
run-llama/llama_index#23199 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
KhronosGroup/glTF-Blender-IO#2769 ·