8000 Document mpl_toolkits.axes_grid1.anchored_artists by sargas · Pull Request #4874 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Document mpl_toolkits.axes_grid1.anchored_artists #4874

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 9 commits into from
Dec 26, 2015
Merged

Document mpl_toolkits.axes_grid1.anchored_artists #4874

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
efb3f5a
Cleanup axes_grid1.anchored_artists
sargas Aug 5, 2015
c27633c
Add documentation to axes_grid1.anchored_artists.AnchoredSizeBar
sargas Aug 6, 2015
e8579de
Add documentation to axes_grid1.anchored_artists.AnchoredEllipse
sargas Aug 6, 2015
8ee8707
Add attributes doc for AnchoredSizeBar and AnchoredEllipse in axes_grid1
sargas Aug 6, 2015
c574197
Add documentation for axes_grid1's AnchoredAuxTransformBox
sargas Aug 6, 2015
ba12801
Add documentation for axes_grid1's AnchoredDrawingArea
sargas Aug 6, 2015
abed7b6
Change incorrect import in simple_anchored_artists example
sargas Dec 16, 2015
52e7549
Build documentation for axes_grid1.anchored_artists
sargas Dec 16, 2015
34d1937
Readd six import in axes_grid1.anchored_artists for consistency
sargas Dec 16, 2015
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
Prev Previous commit
Next Next commit
Add documentation for axes_grid1's AnchoredAuxTransformBox
  • Loading branch information
@sargas
sargas committed Dec 16, 2015
commit c574197b64fb4d8a50fe90aaccafede493d83f36
60 changes: 60 additions & 0 deletions lib/mpl_toolkits/axes_grid1/anchored_artists.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,68 @@ def __init__(self, width, height, xdescent, ydescent,


class AnchoredAuxTransformBox(AnchoredOffsetbox):
@docstring.dedent
def __init__(self, transform, loc,
pad=0.4, borderpad=0.5, prop=None, frameon=True, **kwargs):
"""
An anchored container with transformed coordinates.

Artists added to the *drawing_area* are scaled according to the
coordinates of the transformation used. The dimensions of this artist
will scale to contain the artists added.

Parameters
----------
transform : `matplotlib.transforms.Transform`
The transformation object for the coordinate system in use, i.e.,
:attr:`matplotlib.axes.Axes.transData`.

loc : int
Location of this artist. Valid location codes are::

'upper right' : 1,
'upper left' : 2,
'lower left' : 3,
'lower right' : 4,
'right' : 5,
'center left' : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center' : 10

pad : int or float, optional
Padding around the child objects, in fraction of the font
size. Defaults to 0.4.

borderpad : int or float, optional
Border padding, in fraction of the font size.
Defaults to 0.5.

prop : `matplotlib.font_manager.FontProperties`, optional
Font property used as a reference for paddings.

frameon : bool, optional
If True, draw a box around this artists. Defaults to True.

**kwargs :
Keyworded arguments to pass to
:class:`matplotlib.offsetbox.AnchoredOffsetbox`.

Attributes
----------
drawing_area : `matplotlib.offsetbox.AuxTransformBox`

Examples
--------
To display an ellipse in the upper left, with a width of 0.1 and
height of 0.4 in data coordinates:

>>> box = AnchoredAuxTransformBox(ax.transData, loc=2)
>>> el = Ellipse((0,0), width=0.1, height=0.4, angle=30)
>>> box.drawing_area.add_artist(el)
>>> ax.add_artist(box)
"""
self.drawing_area = AuxTransformBox(transform)

AnchoredOffsetbox.__init__(self, loc, pad=pad, borderpad=borderpad,
Expand Down
0