Skip to content

Fix Axes3D.get_tightbbox to include axis labels when not for_layout_only #31571

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
Scolliq wants to merge 1 commit into
base: main
Choose a base branch
from
+36 −2
Open

Fix Axes3D.get_tightbbox to include axis labels when not for_layout_only #31571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions lib/mpl_toolkits/mplot3d/axes3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4164,8 +4164,8 @@ def get_tightbbox(self, renderer=None, *, call_axes_locator=True,
if self._axis3don:
for axis in self._axis_map.values():
if axis.get_visible():
axis_bb = martist._get_tightbbox_for_layout_only(
axis, renderer)
axis_bb = axis.get_tightbbox(
renderer, for_layout_only=for_layout_only)
if axis_bb:
batch.append(axis_bb)
return mtransforms.Bbox.union(batch)
Expand Down
34 changes: 34 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,37 @@ 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_axes3d_tightbbox_includes_axis_labels():
"""Axis labels must not be clipped when saving with bbox_inches='tight'.

Previously get_tightbbox always called _get_tightbbox_for_layout_only on
each 3D axis, which explicitly excludes labels (for_layout_only=True).
This caused zlabel/xlabel to be cut off in saved figures. GH#28117.
"""
import io
fig = plt.figure()
ax = fig.add_subplot(projection='3d')
ax.set_xlabel('X label')
ax.set_ylabel('Y label')
ax.set_zlabel('Z label')
ax.scatter([1], [1], [1])

renderer = fig.canvas.get_renderer()

# bbox without for_layout_only should include axis labels
bb_full = ax.get_tightbbox(renderer, for_layout_only=False)
# bbox with for_layout_only=True excludes labels (layout engine path)
bb_layout = ax.get_tightbbox(renderer, for_layout_only=True)

# The full bbox must be strictly larger than the layout bbox in at least
# one dimension, because axis labels are included.
assert bb_full.width > bb_layout.width or bb_full.height > bb_layout.height, (
"Full tightbbox should be strictly larger than layout-only tightbbox "
"because it includes axis labels"
)
# Sanity: saving should not crash
buf = io.BytesIO()
fig.savefig(buf, format='png', bbox_inches='tight')
assert buf.tell() > 0
Loading