X Tutup
Skip to content

BUG: Fix text appearing far outside valid axis scale range #31061

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
scottshambaugh wants to merge 5 commits into
base: main
Choose a base branch
from
+35 −0
Open

BUG: Fix text appearing far outside valid axis scale range #31061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ffb8d3
Fix text appearing outside axis scale range
scottshambaugh Feb 2, 2026
20103e7
Rename to _outside_axes_domain
scottshambaugh Feb 3, 2026
371fcb2
Update lib/matplotlib/text.py
scottshambaugh Feb 25, 2026
d1bd978
Move domain check to axes
scottshambaugh Feb 25, 2026
bb9daee
Use _axis_map
scottshambaugh Mar 10, 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
14 changes: 14 additions & 0 deletions lib/matplotlib/axes/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2443,6 +2443,20 @@ def _add_text(self, txt):
self.stale = True
return txt

def _point_in_data_domain(self, x, y):
Copy link
Member

@QuLogic QuLogic Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this not going to be used in 3D at some point (i.e., should it be passing in a tuple instead of individual coordinates)?

Copy link
Contributor Author

@scottshambaugh scottshambaugh Mar 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't currently called in any 3d path, since the rendering pipeline is so different. We might want to use it for something else, but I'm not too worried about future-proofing internal private functions beforehand.

"""
Check if the data point (x, y) is within the valid domain of the axes
scales.

Returns False if the point is outside the data range
(e.g. negative coordinates with a log scale).
"""
for val, axis in zip([x, y], self._axis_map.values()):
vmin, vmax = axis.limit_range_for_scale(val, val)
if vmin != val or vmax != val:
return False
return True

def _update_line_limits(self, line):
"""
Figures out the data limit of the given line, updating `.Axes.dataLim`.
Expand Down
12 changes: 12 additions & 0 deletions lib/matplotlib/tests/test_text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1226,3 +1226,15 @@ def test_ytick_rotation_mode():
tick.set_rotation(angle)

plt.subplots_adjust(left=0.4, right=0.6, top=.99, bottom=.01)


def test_text_tightbbox_outside_scale_domain():
# Test that text at positions outside the valid domain of axes scales
# (e.g., negative coordinates with log scale) returns a null bbox.
fig, ax = plt.subplots()
ax.set_yscale('log')
ax.set_ylim(1, 100)

invalid_text = ax.text(0, -5, 'invalid')
invalid_bbox = invalid_text.get_tightbbox(fig.canvas.get_renderer())
assert not np.isfinite(invalid_bbox.width)
9 changes: 9 additions & 0 deletions lib/matplotlib/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1060,6 +1060,15 @@ def get_window_extent(self, renderer=None, dpi=None):
bbox = bbox.translated(x, y)
return bbox

def get_tightbbox(self, renderer=None):
# Exclude text at data coordinates outside the valid domain of the axes
Copy link
Contributor Author

@scottshambaugh scottshambaugh Feb 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

        if not self.get_visible() or self.get_text() == "":
            return Bbox.null()

I had originally included these lines, but they were changing a half dozen baseline images as plots expanded to fill space where there was empty/invisible text. Removed for now, but I think that's probably the right behavior and we can discuss including it.

Copy link
Member

@QuLogic QuLogic Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you think that might be important, you can target that change to the text-overhaul branch.

Copy link
Contributor Author

@scottshambaugh scottshambaugh Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean this PR or just that change?

Copy link
Member

@QuLogic QuLogic Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The additional change, unless it's easier for you to do the whole PR.

Copy link
Contributor Author

@scottshambaugh scottshambaugh Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I'll wait for this one to merge to avoid the def get_tightbbox conflict

# scales (e.g., negative coordinates with a log scale).
if (self.axes
and self.get_transform() == self.axes.transData
and not self.axes._point_in_data_domain(*self.get_unitless_position())):
return Bbox.null()
return super().get_tightbbox(renderer)

def set_backgroundcolor(self, color):
"""
Set the background color of the text.
Expand Down
Loading
X Tutup