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

Skip to content

Doc fixed aspect colorbar #29945

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 3 commits into from
Apr 18, 2025
Merged

Doc fixed aspect colorbar #29945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b0ebaca
DOC: add layout=compressed to colorbar placement doc
jklymak Apr 18, 2025
92b2297
DOC: update constrainedlayout_guide with info on colorbars in compres…
jklymak Apr 18, 2025
4149f8d
DOC: add layout=compressed to colorbar placement doc
jklymak Apr 18, 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
70 changes: 37 additions & 33 deletions galleries/users_explain/axes/colorbar_placement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,43 +143,47 @@
# Colorbars attached to fixed-aspect-ratio Axes
# ---------------------------------------------
#
# Placing colorbars for Axes with a fixed aspect ratio pose a particular
# challenge as the parent Axes changes size depending on the data view.
# Axes with a fixed aspect ratio may shrink in height to preserve the aspect
# ratio of the underlying data. This can result in the colorbar becoming taller
# than the associated Axes, as demonstrated in the following example.

fig, axs = plt.subplots(2, 2, layout='constrained')
cmaps = ['RdBu_r', 'viridis']
for col in range(2):
for row in range(2):
ax = axs[row, col]
pcm = ax.pcolormesh(np.random.random((20, 20)) * (col + 1),
cmap=cmaps[col])
if col == 0:
ax.set_aspect(2)
else:
ax.set_aspect(1/2)
if row == 1:
fig.colorbar(pcm, ax=ax, shrink=0.6)
fig, ax = plt.subplots(layout='constrained', figsize=(4, 4))
pcm = ax.imshow(np.random.randn(10, 10), cmap='viridis')
fig.colorbar(pcm, ax=ax)

# %%
# We solve this problem using `.Axes.inset_axes` to locate the Axes in "axes
# coordinates" (see :ref:`transforms_tutorial`). Note that if you zoom in on
# the parent Axes, and thus change the shape of it, the colorbar will also
# change position.
# To automatically adjust the colorbar size to match the parent Axes, we can
# use ``layout='compressed'``. This ensures that as the figure is resized or
# the fixed-aspect-ratio Axes is zoomed in or out, the colorbar dynamically
# resizes to align with the parent Axes.

fig, axs = plt.subplots(2, 2, layout='constrained')
cmaps = ['RdBu_r', 'viridis']
for col in range(2):
for row in range(2):
ax = axs[row, col]
pcm = ax.pcolormesh(np.random.random((20, 20)) * (col + 1),
cmap=cmaps[col])
if col == 0:
ax.set_aspect(2)
else:
ax.set_aspect(1/2)
if row == 1:
cax = ax.inset_axes([1.04, 0.2, 0.05, 0.6])
fig.colorbar(pcm, cax=cax)
fig, ax = plt.subplots(layout='compressed', figsize=(4, 4))
pcm = ax.imshow(np.random.randn(10, 10), cmap='viridis')
ax.set_title("Colorbar with layout='compressed'", fontsize='medium')
fig.colorbar(pcm, ax=ax)

# %%
# Alternatively, we can manually position the colorbar using `.Axes.inset_axes`
# with axes-relative coordinates. This approach provides precise control over
# the colorbar's placement. However, without a layout engine, the colorbar
# might be clipped if it extends beyond the figure boundaries.

fig, ax = plt.subplots(layout='constrained', figsize=(4, 4))
pcm = ax.imshow(np.random.randn(10, 10), cmap='viridis')
cax = ax.inset_axes([1.04, 0.0, 0.05, 1.0]) # Positioning the colorbar
ax.set_title('Colorbar with inset_axes', fontsize='medium')
fig.colorbar(pcm, cax=cax)

# %%
# We can also do this manually using an `.Axes.inset_axes` using axes-relative
# coordinates (see :ref:`transforms_tutorial`). Note that if we do not use a
# layout engine, the colorbar will be clipped off the right side of the figure.

fig, ax = plt.subplots(layout='constrained', figsize=(4, 4))
pcm = ax.imshow(np.random.randn(10, 10), cmap='viridis')
cax = ax.inset_axes([1.04, 0.0, 0.05, 1.0])
ax.set_title('Colorbar with inset_axes', fontsize='medium')
fig.colorbar(pcm, cax=cax)

# %%
# .. seealso::
Expand Down
29 changes: 29 additions & 0 deletions galleries/users_explain/axes/constrainedlayout_guide.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,35 @@ def example_plot(ax, fontsize=12, hide_labels=False):
ax.imshow(arr)
fig.suptitle("fixed-aspect plots, layout='compressed'")

# %%
# Compressed layout will also attempt to size colorbars to match the size of the
# fixed-aspect-ratio parent Axes as the figure is resized or the aspect ratio changes.
# In the following figure, the colorbar is taller than its parent Axes:

fig, ax = plt.subplots(layout='constrained', figsize=(3, 3))
pcm = ax.imshow(np.random.randn(10, 10), cmap='viridis')
ax.set_title("Colorbar with layout='constrained'", fontsize='medium')
fig.colorbar(pcm, ax=ax)

# %%
# Compressed layout ensures that the height of the colorbar matches the height
# of its parent Axes, maintaining a consistent appearance:

fig, ax = plt.subplots(layout='compressed', figsize=(3, 3))
pcm = ax.imshow(np.random.randn(10, 10), cmap='viridis')
ax.set_title("Colorbar with layout='compressed'", fontsize='medium')
fig.colorbar(pcm, ax=ax)

# %%
# If the Axes is zoomed in or out, or the figure is resized, the colorbar will
# dynamically resize to match the parent Axes. Whether this behavior is desired
# depends on the specific application:

fig, ax = plt.subplots(layout='compressed', figsize=(3, 3))
pcm = ax.imshow(np.random.randn(10, 10), cmap='viridis')
ax.set_ylim([4, 8])
ax.set_title("Layout='compressed' with zoom", fontsize='medium')
fig.colorbar(pcm, ax=ax)

# %%
# Manually turning off *constrained layout*
Expand Down