Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Backport PR #12164 on branch v3.0.x (Fix Annotation.contains.) #12194

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
Sep 21, 2018
Merged

Backport PR #12164 on branch v3.0.x (Fix Annotation.contains.) #12194

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
74 changes: 41 additions & 33 deletions lib/matplotlib/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -890,25 +890,26 @@ def get_verticalalignment(self):
return self._verticalalignment

def get_window_extent(self, renderer=None, dpi=None):
'''
Return a `~matplotlib.transforms.Bbox` object bounding
the text, in display units.
"""
Return the `Bbox` bounding the text, in display units.

In addition to being used internally, this is useful for
specifying clickable regions in a png file on a web page.
In addition to being used internally, this is useful for specifying
clickable regions in a png file on a web page.

*renderer* defaults to the _renderer attribute of the text
object. This is not assigned until the first execution of
:meth:`draw`, so you must use this kwarg if you want
to call `.get_window_extent` prior to the first `draw`. For
getting web page regions, it is simpler to call the method after
saving the figure.

*dpi* defaults to self.figure.dpi; the renderer dpi is
irrelevant. For the web application, if figure.dpi is not
the value used when saving the figure, then the value that
was used must be specified as the *dpi* argument.
'''
Parameters
----------
renderer : Renderer, optional
A renderer is needed to compute the bounding box. If the artist
has already been drawn, the renderer is cached; thus, it is only
necessary to pass this argument when calling `get_window_extent`
before the first `draw`. In practice, it is usually easier to
trigger a draw first (e.g. by saving the figure).

dpi : float, optional
The dpi value for computing the bbox, defaults to
``self.figure.dpi`` (*not* the renderer dpi); should be set e.g. if
to match regions with a figure saved with a custom dpi value.
"""
#return _unit_box
if not self.get_visible():
return Bbox.unit()
Expand Down Expand Up @@ -2343,29 +2344,36 @@ def draw(self, renderer):
Text.draw(self, renderer)

def get_window_extent(self, renderer=None):
'''
Return a :class:`~matplotlib.transforms.Bbox` object bounding
the text and arrow annotation, in display units.
"""
Return the `Bbox` bounding the text and arrow, in display units.

*renderer* defaults to the _renderer attribute of the text
object. This is not assigned until the first execution of
:meth:`draw`, so you must use this kwarg if you want
to call :meth:`get_window_extent` prior to the first
:meth:`draw`. For getting web page regions, it is
simpler to call the method after saving the figure. The
*dpi* used defaults to self.figure.dpi; the renderer dpi is
irrelevant.
'''
self.update_positions(renderer)
Parameters
----------
renderer : Renderer, optional
A renderer is needed to compute the bounding box. If the artist
has already been drawn, the renderer is cached; thus, it is only
necessary to pass this argument when calling `get_window_extent`
before the first `draw`. In practice, it is usually easier to
trigger a draw first (e.g. by saving the figure).
"""
# This block is the same as in Text.get_window_extent, but we need to
# set the renderer before calling update_positions().
if not self.get_visible():
return Bbox.unit()
if renderer is not None:
self._renderer = renderer
if self._renderer is None:
self._renderer = self.figure._cachedRenderer
if self._renderer is None:
raise RuntimeError('Cannot get window extent w/o renderer')

self.update_positions(self._renderer)

text_bbox = Text.get_window_extent(self, renderer=renderer)
text_bbox = Text.get_window_extent(self)
bboxes = [text_bbox]

if self.arrow_patch is not None:
bboxes.append(
self.arrow_patch.get_window_extent(renderer=renderer))
bboxes.append(self.arrow_patch.get_window_extent())

return Bbox.union(bboxes)

Expand Down