Skip to content

DOC: Add axis sharing section to subplot_mosaic guide #31720

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

Open
Atharva2012 wants to merge 1 commit into
base: main
Choose a base branch
from
+56 −0
Open

DOC: Add axis sharing section to subplot_mosaic guide #31720

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
56 changes: 56 additions & 0 deletions galleries/users_explain/axes/mosaic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,3 +390,59 @@ def identify_axes(ax_dict, fontsize=48):
empty_sentinel=0,
)
identify_axes(axd)


# %%
# Axis sharing
# ============
#
# `.Figure.subplot_mosaic` supports *sharex* and *sharey* as does
# `.Figure.subplots`. When ``True``, all Axes in the mosaic share
# the same x-axis or y-axis, which is useful for directly comparing
# data across panels.

fig = plt.figure(layout="constrained")
axd = fig.subplot_mosaic("AC;BC", sharex=True)
axd["A"].set_title("Axes A")
axd["B"].set_title("Axes B")
axd["C"].set_title("Axes C")
for ax in axd.values():
ax.plot([1, 2, 3, 4], [1, 4, 2, 3])
identify_axes(axd)

# %%
# Note that when using ``sharex=True`` only the bottom row of Axes shows
# x-axis tick labels, and when using ``sharey=True`` only the left column
# shows y-axis tick labels. This is identical to the behavior of
# `.Figure.subplots`.
#
# Interaction with empty sentinels
# ---------------------------------
#
# When the mosaic layout has blank spaces (empty sentinels), axis sharing
# can produce unexpected results. In the following example, the top-left
# cell is empty and ``sharey=True`` is used:

fig, axd = plt.subplot_mosaic(".A;BC", sharey=True, layout="constrained")
for ax in axd.values():
ax.plot([1, 2, 3, 4], [1, 4, 2, 3])
identify_axes(axd)

# %%
# Because the left column's topmost Axes is blank, Axes ``"B"`` would
# normally be the leftmost visible Axes in its row, but axis sharing has
# already removed its y-axis tick labels (since it is not the first column
# in the grid). As a result, *none* of the Axes in the top row display
# y-axis tick labels, which is usually not what you want.
#
# The fix is to manually re-enable tick labels on the Axes that should
# display them using `.Axes.tick_params`:

fig, axd = plt.subplot_mosaic(".A;BC", sharey=True, layout="constrained")
for ax in axd.values():
ax.plot([1, 2, 3, 4], [1, 4, 2, 3])

# Re-enable y-axis tick labels on Axes "B"
axd["B"].tick_params(labelleft=True)

identify_axes(axd)
Loading