Skip to content

Fix get_tightbbox to include axis labels in 3D axes #31573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sathush504 wants to merge 2 commits into
base: main
Choose a base branch
from
+37 −1
Open

Fix get_tightbbox to include axis labels in 3D axes #31573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bad900
Fix get_tightbbox to include axis labels in 3D axes
Sathush504 Apr 26, 2026
18ae59d
Fix linting
Sathush504 Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion lib/mpl_toolkits/mplot3d/axes3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4155,7 +4155,7 @@ def _digout_minmax(err_arr, coord_label):
return errlines, caplines, limmarks

def get_tightbbox(self, renderer=None, *, call_axes_locator=True,
bbox_extra_artists=None, for_layout_only=False):
bbox_extra_artists=None, for_layout_only=False):
ret = super().get_tightbbox(renderer,
call_axes_locator=call_axes_locator,
bbox_extra_artists=bbox_extra_artists,
Expand All @@ -4168,6 +4168,10 @@ def get_tightbbox(self, renderer=None, *, call_axes_locator=True,
axis, renderer)
if axis_bb:
batch.append(axis_bb)
if not for_layout_only and axis.label.get_visible():
label_bb = axis.label.get_window_extent(renderer)
if label_bb.width > 0 or label_bb.height > 0:
batch.append(label_bb)
return mtransforms.Bbox.union(batch)

@_preprocess_data()
Expand Down
32 changes: 32 additions & 0 deletions lib/mpl_toolkits/mplot3d/tests/test_axes3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3176,3 +3176,35 @@ def test_scale3d_calc_coord():
# Pane coordinate should match axis limit (y-pane at max)
assert pane_idx == 1
assert point[pane_idx] == pytest.approx(ax.get_ylim()[1])


def test_tightbbox_3d_labels_not_clipped():
# Regression test for GH#31568 - zlabel and xlabel were excluded from
# get_tightbbox(), causing them to be clipped by savefig(bbox_inches='tight')
fig = plt.figure(figsize=(3, 3))
ax = fig.add_subplot(projection='3d')
ax.plot([0, 1], [0, 1], [0, 1])
ax.set_zlabel("Z axis label")
ax.set_xlabel("X axis label")

fig.canvas.draw()
renderer = fig.canvas.get_renderer()

tightbbox = ax.get_tightbbox(renderer)

for axis in [ax.xaxis, ax.zaxis]:
if axis.label.get_visible():
label_bb = axis.label.get_window_extent(renderer)
if label_bb.width > 0 or label_bb.height > 0:
assert tightbbox.x0 <= label_bb.x0 + 1e-6, (
f"{axis.axis_name}label left edge outside tightbbox: "
f"{label_bb.x0:.1f} > {tightbbox.x0:.1f}"
)
assert tightbbox.x1 >= label_bb.x1 - 1e-6, (
f"{axis.axis_name}label right edge outside tightbbox: "
f"{label_bb.x1:.1f} > {tightbbox.x1:.1f}"
)
assert tightbbox.y0 <= label_bb.y0 + 1e-6, (
f"{axis.axis_name}label bottom edge outside tightbbox: "
f"{label_bb.y0:.1f} < {tightbbox.y0:.1f}"
)
Loading