DOC: add pad discussion [ci doc]

jklymak · jklymak · commit 1115c7fe7d74 · 2023-09-25T12:29:12.000-07:00
diff --git a/galleries/users_explain/axes/colorbar_placement.py b/galleries/users_explain/axes/colorbar_placement.py
@@ -55,6 +55,31 @@
 fig.colorbar(pcm, ax=axs[1:, :], location='right', shrink=0.6)
 fig.colorbar(pcm, ax=[axs[2, 1]], location='left')
 
+# %%
+# Adjusting the spacing between colorbars and parent axes
+# =======================================================
+#
+# The distance a colorbar is from the parent axes can be adjusted with the
+# *pad* keyword argument.  This is in units of fraction of the parent axes
+# width, and the default for a vertical axes is 0.05 (or 0.15 for a horizontal
+# axes).
+
+fig, axs = plt.subplots(3, 1, layout='constrained', figsize=(5, 5))
+for ax, pad in zip(axs, [0.025, 0.05, 0.1]):
+    pcm = ax.pcolormesh(np.random.randn(20, 20), cmap='viridis')
+    fig.colorbar(pcm, ax=ax, pad=pad, label=f'pad: {pad}')
+fig.suptitle("layout='constrained'")
+
+# %%
+# Note that if you do not use constrained layout, the pad command makes the
+# parent axes shrink:
+
+fig, axs = plt.subplots(3, 1, figsize=(5, 5))
+for ax, pad in zip(axs, [0.025, 0.05, 0.1]):
+    pcm = ax.pcolormesh(np.random.randn(20, 20), cmap='viridis')
+    fig.colorbar(pcm, ax=ax, pad=pad, label=f'pad: {pad}')
+fig.suptitle("No layout manager")
+
 # %%
 # Colorbars with fixed-aspect-ratio axes
 # ======================================
@@ -99,7 +124,6 @@
             cax = ax.inset_axes([1.04, 0.2, 0.05, 0.6])
             fig.colorbar(pcm, cax=cax)
 
-
 # %%
 # Manually placing colorbars
 # ==========================
@@ -111,21 +135,21 @@
 # relative to the parent axes.  Here we add a colorbar centered near the bottom
 # of the parent axes.
 
-fig, ax = plt.subplots(layout='constrained')
+fig, ax = plt.subplots(layout='constrained', figsize=(4, 4))
 pcm = ax.pcolormesh(np.random.randn(20, 20), cmap='viridis')
 ax.set_ylim([-4, 20])
-cax = ax.inset_axes([0.3, 0.06, 0.4, 0.04])
+cax = ax.inset_axes([0.3, 0.07, 0.4, 0.04])
 fig.colorbar(pcm, cax=cax, orientation='horizontal')
 
 # %%
 # `.Axes.inset_axes` can also specify its position in data coordinates
 # using the *transform* keyword argument if you want your axes at a
 # certain data position on the graph:
 
-fig, ax = plt.subplots(layout='constrained')
+fig, ax = plt.subplots(layout='constrained', figsize=(4, 4))
 pcm = ax.pcolormesh(np.random.randn(20, 20), cmap='viridis')
 ax.set_ylim([-4, 20])
-cax = ax.inset_axes([7.5, -2, 5, 1.2], transform=ax.transData)
+cax = ax.inset_axes([7.5, -1.7, 5, 1.2], transform=ax.transData)
 fig.colorbar(pcm, cax=cax, orientation='horizontal')
 
 plt.show()
