Skip to content

DOC : added warning to doc of get_window_extent #3184

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
dmcdougall merged 2 commits into from
Jul 11, 2014
Merged

DOC : added warning to doc of get_window_extent #3184

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
244dd18
DOC : added warning to doc of get_window_extent
tacaswell Jul 4, 2014
b0c4bb0
DOC : added crucial 'un' to docstring
tacaswell Jul 11, 2014
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
10 changes: 9 additions & 1 deletion lib/matplotlib/artist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,14 @@ def get_window_extent(self, renderer):
Subclasses should override for inclusion in the bounding box
"tight" calculation. Default is to return an empty bounding
box at 0, 0.

Be careful when using this function, the results will not update
if the artist window extent of the artist changes. The extent
can change due to any changes in the transform stack, such as
changing the axes limits, the figure size, or the canvas used
(as is done when saving a figure). This can lead to unexpected
behavior where interactive figures will look fine on the screen,
but will save incorrectly.
"""
return Bbox([[0, 0], [0, 0]])

Expand Down Expand Up @@ -644,7 +652,7 @@ def set_clip_on(self, b):
"""
Set whether artist uses clipping.

When False artists will be visible out side of the axes which
When False artists will be visible out side of the axes which
can lead to unexpected results.

ACCEPTS: [True | False]
Expand Down