Skip to content

Tweak docstrings of get_window_extent/get_tightbbox. #30262

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

Merged
merged 1 commit into from
Jul 5, 2025
Merged

Tweak docstrings of get_window_extent/get_tightbbox. #30262

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
37 changes: 24 additions & 13 deletions lib/matplotlib/artist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,13 +321,12 @@ def stale(self, val):

def get_window_extent(self, renderer=None):
"""
Get the artist's bounding box in display space.
Get the artist's bounding box in display space, ignoring clipping.

The bounding box's width and height are non-negative.

Subclasses should override for inclusion in the bounding box
"tight" calculation. Default is to return an empty bounding
box at 0, 0.
Subclasses should override for inclusion in the bounding box "tight"
calculation. Default is to return an empty bounding box at 0, 0.

.. warning::

Expand All @@ -341,28 +340,40 @@ def get_window_extent(self, renderer=None):
screen render incorrectly when saved to file.

To get accurate results you may need to manually call
`matplotlib.figure.Figure.savefig` or
`matplotlib.figure.Figure.draw_without_rendering` to have Matplotlib
compute the rendered size.
`~.Figure.savefig` or `~.Figure.draw_without_rendering` to have
Matplotlib compute the rendered size.

Parameters
----------
renderer : `~matplotlib.backend_bases.RendererBase`, optional
Renderer used to draw the figure (i.e. ``fig.canvas.get_renderer()``).

See Also
--------
`~.Artist.get_tightbbox` :
Get the artist bounding box, taking clipping into account.
"""
return Bbox([[0, 0], [0, 0]])

def get_tightbbox(self, renderer=None):
"""
Like `.Artist.get_window_extent`, but includes any clipping.
Get the artist's bounding box in display space, taking clipping into account.

Parameters
----------
renderer : `~matplotlib.backend_bases.RendererBase` subclass, optional
renderer that will be used to draw the figures (i.e.
``fig.canvas.get_renderer()``)
renderer : `~matplotlib.backend_bases.RendererBase`, optional
Renderer used to draw the figure (i.e. ``fig.canvas.get_renderer()``).

Returns
-------
`.Bbox` or None
The enclosing bounding box (in figure pixel coordinates).
Returns None if clipping results in no intersection.
The enclosing bounding box (in figure pixel coordinates), or None
if clipping results in no intersection.

See Also
--------
`~.Artist.get_window_extent` :
Get the artist bounding box, ignoring clipping.
"""
bbox = self.get_window_extent(renderer)
if self.get_clip_on():
Expand Down
Loading