Expand example

jklymak · jklymak · commit d1fa5ccf917c · 2020-09-29T21:59:28.000-07:00
diff --git a/examples/subplots_axes_and_figures/subfigures.py b/examples/subplots_axes_and_figures/subfigures.py
@@ -22,14 +22,13 @@
 
 
 def example_plot(ax, fontsize=12, hide_labels=False):
-    pc = ax.pcolormesh(np.random.randn(30, 30))
+    pc = ax.pcolormesh(np.random.randn(30, 30), vmin=-2.5, vmax=2.5)
     if not hide_labels:
         ax.set_xlabel('x-label', fontsize=fontsize)
         ax.set_ylabel('y-label', fontsize=fontsize)
         ax.set_title('Title', fontsize=fontsize)
     return pc
 
-
 # gridspec inside gridspec
 fig = plt.figure(constrained_layout=True, figsize=(10, 4))
 subfigs = fig.subfigures(1, 2, wspace=0.07)
@@ -43,7 +42,7 @@ def example_plot(ax, fontsize=12, hide_labels=False):
 
 axsRight = subfigs[1].subplots(3, 1, sharex=True)
 for nn, ax in enumerate(axsRight):
-    #pc = example_plot(ax, hide_labels=True)
+    pc = example_plot(ax, hide_labels=True)
     if nn == 2:
         ax.set_xlabel('xlabel')
     if nn == 1:
@@ -56,3 +55,93 @@ def example_plot(ax, fontsize=12, hide_labels=False):
 fig.suptitle('Figure suptitle', fontsize='xx-large')
 
 plt.show()
+
+##############################################################################
+# It is possible to mix subplots and subfigures using
+# `matplotlib.figure.Figure.add_subfigure`.  This requires getting
+# the gridspec that the subplots are laid out on.
+
+fig, axs = plt.subplots(2, 3, constrained_layout=True, figsize=(10, 4))
+
+# clear the left column for the subfigure:
+for a in axs[:, 0]:
+    gridspec = a.get_subplotspec().get_gridspec()
+    a.remove()
+
+# plot data in remaining axes:
+for a in axs[:, 1:].flat:
+    a.plot(np.arange(10))
+
+# make the subfigure in the empy gridspec slots:
+subfig = fig.add_subfigure(gridspec[:, 0])
+
+axsLeft = subfig.subplots(1, 2, sharey=True)
+subfig.set_facecolor('0.75')
+for ax in axsLeft:
+    pc = example_plot(ax)
+subfig.suptitle('Left plots', fontsize='x-large')
+subfig.colorbar(pc, shrink=0.6, ax=axsLeft, location='bottom')
+
+fig.suptitle('Figure suptitle', fontsize='xx-large')
+plt.show()
+
+##############################################################################
+# Subfigures can have different widths and heights.  This is exactly the
+# same example as the first example, but *width_ratios* has been changed:
+
+fig = plt.figure(constrained_layout=True, figsize=(10, 4))
+subfigs = fig.subfigures(1, 2, wspace=0.07, width_ratios=[2, 1])
+
+axsLeft = subfigs[0].subplots(1, 2, sharey=True)
+subfigs[0].set_facecolor('0.75')
+for ax in axsLeft:
+    pc = example_plot(ax)
+subfigs[0].suptitle('Left plots', fontsize='x-large')
+subfigs[0].colorbar(pc, shrink=0.6, ax=axsLeft, location='bottom')
+
+axsRight = subfigs[1].subplots(3, 1, sharex=True)
+for nn, ax in enumerate(axsRight):
+    pc = example_plot(ax, hide_labels=True)
+    if nn == 2:
+        ax.set_xlabel('xlabel')
+    if nn == 1:
+        ax.set_ylabel('ylabel')
+
+subfigs[1].set_facecolor('0.85')
+subfigs[1].colorbar(pc, shrink=0.6, ax=axsRight)
+subfigs[1].suptitle('Right plots', fontsize='x-large')
+
+fig.suptitle('Figure suptitle', fontsize='xx-large')
+
+plt.show()
+
+##############################################################################
+# Subfigures can be also be nested:
+
+fig = plt.figure(constrained_layout=True, figsize=(10, 8))
+
+fig.suptitle('fig')
+
+subfigs = fig.subfigures(1, 2, wspace=0.07)
+
+subfigs[0].set_facecolor('coral')
+subfigs[0].suptitle('subfigs[0]')
+
+subfigs[1].set_facecolor('coral')
+subfigs[1].suptitle('subfigs[1]')
+
+subfigsnest = subfigs[0].subfigures(2, 1, height_ratios=[1, 1.4])
+subfigsnest[0].suptitle('subfigsnest[0]')
+subfigsnest[0].set_facecolor('r')
+axsnest0 = subfigsnest[0].subplots(1, 2, sharey=True)
+for nn, ax in enumerate(axsnest0):
+    pc = example_plot(ax, hide_labels=True)
+subfigsnest[0].colorbar(pc, ax=axsnest0)
+
+subfigsnest[1].suptitle('subfigsnest[1]')
+subfigsnest[1].set_facecolor('g')
+axsnest1 = subfigsnest[1].subplots(3, 1, sharex=True)
+
+axsRight = subfigs[1].subplots(2, 2)
+
+plt.show()
diff --git a/lib/matplotlib/_constrained_layout.py b/lib/matplotlib/_constrained_layout.py
@@ -107,7 +107,6 @@ def do_constrained_layout(fig, renderer, h_pad, w_pad,
         # figure.  Add margins for colorbars...
         _make_layout_margins(fig, renderer, h_pad=h_pad, w_pad=w_pad,
                              hspace=hspace, wspace=wspace)
-
         _make_margin_suptitles(fig, renderer, h_pad=h_pad, w_pad=w_pad)
 
         # if a layout is such that a columns (or rows) margin has no
@@ -279,12 +278,15 @@ def _make_margin_suptitles(fig, renderer, *, w_pad=0, h_pad=0):
     # top level figure margin larger.
     for panel in fig.panels:
         _make_margin_suptitles(panel, renderer, w_pad=w_pad, h_pad=h_pad)
-    invTransFig = fig.transSubfigure.inverted().transform_bbox
-
-    w_pad, h_pad = (fig.transSubfigure -
-                    fig.transFigure).transform((w_pad, h_pad))
 
     if fig._suptitle is not None and fig._suptitle.get_in_layout():
+        invTransFig = fig.transSubfigure.inverted().transform_bbox
+        parenttrans = fig.transFigure
+        w_pad, h_pad = (fig.transSubfigure -
+                        parenttrans).transform((w_pad, 1 - h_pad))
+        w_pad, one = (fig.transSubfigure -
+                        parenttrans).transform((w_pad, 1))
+        h_pad = one - h_pad
         bbox = invTransFig(fig._suptitle.get_tightbbox(renderer))
         p = fig._suptitle.get_position()
         fig._suptitle.set_position((p[0], 1-h_pad))
diff --git a/lib/matplotlib/tests/baseline_images/test_figure/test_subfigure_ss.png b/lib/matplotlib/tests/baseline_images/test_figure/test_subfigure_ss.png
