Skip to content

[mpl_toolkits] Allow "figure" kwarg for host functions in parasite_axes #4863

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 5 commits into from
Nov 5, 2015
Merged

[mpl_toolkits] Allow "figure" kwarg for host functions in parasite_axes #4863

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b9ed974
Allow "figure" kwarg for host functions in parasite_axes.
Aug 4, 2015
172893d
Probably better this way.
Aug 4, 2015
0e77b80
Don't do equality comparison to None.
Aug 4, 2015
9c24887
Added doc strings.
Aug 5, 2015
25105cf
Slightly more elegant.
Aug 5, 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
32 changes: 30 additions & 2 deletions lib/mpl_toolkits/axes_grid1/parasite_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,20 +484,48 @@ def host_subplot_class_factory(axes_class):


def host_axes(*args, **kwargs):
"""
Create axes that can act as a hosts to parasitic axes.

Parameters
----------
figure : `matplotlib.figure.Figure`
Figure to which the axes will be added. Defaults to the current figure
`pyplot.gcf()`.

*args, **kwargs :
Will be passed on to the underlying ``Axes`` object creation.
"""
import matplotlib.pyplot as plt
axes_class = kwargs.pop("axes_class", None)
host_axes_class = host_axes_class_factory(axes_class)
fig = plt.gcf()
fig = kwargs.get("figure", None)
if fig is None:
fig = plt.gcf()
ax = host_axes_class(fig, *args, **kwargs)
fig.add_axes(ax)
plt.draw_if_interactive()
return ax

def host_subplot(*args, **kwargs):
"""
Create a subplot that can act as a host to parasitic axes.

Parameters
----------
figure : `matplotlib.figure.Figure`
Figure to which the subplot will be added. Defaults to the current
figure `pyplot.gcf()`.

*args, **kwargs :
Will be passed on to the underlying ``Axes`` object creation.
"""
import matplotlib.pyplot as plt
axes_class = kwargs.pop("axes_class", None)
host_subplot_class = host_subplot_class_factory(axes_class)
fig = plt.gcf()
fig = kwargs.get("figure", None)
if fig is None:
fig = plt.gcf()
ax = host_subplot_class(fig, *args, **kwargs)
fig.add_subplot(ax)
plt.draw_if_interactive()
Expand Down