Skip to content

Backport PR #30029 on branch v3.10.x (Update diagram in subplots_adjust documentation to clarify parameters) #30033

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 2 commits into from
May 9, 2025
Merged

Backport PR #30029 on branch v3.10.x (Update diagram in subplots_adjust documentation to clarify parameters) #30033

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ceb901c
Backport PR #30029: Update diagram in subplots_adjust documentation t…
timhoffm May 9, 2025
35d90f3
Update doc/_embedded_plots/figure_subplots_adjust.py
timhoffm May 9, 2025
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
38 changes: 22 additions & 16 deletions doc/_embedded_plots/figure_subplots_adjust.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,34 @@
import matplotlib.pyplot as plt


def arrow(p1, p2, **props):
axs[0, 0].annotate(
"", p1, p2, xycoords='figure fraction',
arrowprops=dict(arrowstyle="<->", shrinkA=0, shrinkB=0, **props))


fig, axs = plt.subplots(2, 2, figsize=(6.5, 4))
fig.set_facecolor('lightblue')
fig.subplots_adjust(0.1, 0.1, 0.9, 0.9, 0.4, 0.4)

overlay = fig.add_axes([0, 0, 1, 1], zorder=100)
overlay.axis("off")
xycoords = 'figure fraction'
arrowprops = dict(arrowstyle="<->", shrinkA=0, shrinkB=0)

for ax in axs.flat:
ax.set(xticks=[], yticks=[])

arrow((0, 0.75), (0.1, 0.75)) # left
arrow((0.435, 0.75), (0.565, 0.75)) # wspace
arrow((0.9, 0.75), (1, 0.75)) # right
overlay.annotate("", (0, 0.75), (0.1, 0.75),
xycoords=xycoords, arrowprops=arrowprops) # left
overlay.annotate("", (0.435, 0.25), (0.565, 0.25),
xycoords=xycoords, arrowprops=arrowprops) # wspace
overlay.annotate("", (0, 0.8), (0.9, 0.8),
xycoords=xycoords, arrowprops=arrowprops) # right
fig.text(0.05, 0.7, "left", ha="center")
fig.text(0.5, 0.7, "wspace", ha="center")
fig.text(0.95, 0.7, "right", ha="center")
fig.text(0.5, 0.3, "wspace", ha="center")
fig.text(0.05, 0.83, "right", ha="center")

arrow((0.25, 0), (0.25, 0.1)) # bottom
arrow((0.25, 0.435), (0.25, 0.565)) # hspace
arrow((0.25, 0.9), (0.25, 1)) # top
fig.text(0.28, 0.05, "bottom", va="center")
overlay.annotate("", (0.75, 0), (0.75, 0.1),
xycoords=xycoords, arrowprops=arrowprops) # bottom
overlay.annotate("", (0.25, 0.435), (0.25, 0.565),
xycoords=xycoords, arrowprops=arrowprops) # hspace
overlay.annotate("", (0.8, 0), (0.8, 0.9),
xycoords=xycoords, arrowprops=arrowprops) # top
fig.text(0.65, 0.05, "bottom", va="center")
fig.text(0.28, 0.5, "hspace", va="center")
fig.text(0.28, 0.95, "top", va="center")
fig.text(0.82, 0.05, "top", va="center")