Skip to content

Commit b4bf072

Browse files
lukelbdlukelbd
committed
Add [hw]group tight layout options (see #313)
1 parent d9e62c5 commit b4bf072

File tree

4 files changed

+66
-15
lines changed

4 files changed

+66
-15
lines changed

‎docs/subplots.py‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -242,34 +242,53 @@
242242
# This padding can be set locally by passing an array of values to `wpad`
243243
# and `hpad` (analogous to `wspace` and `hspace`), or by passing the `pad`
244244
# keyword when creating :ref:`panel axes <ug_panels>` or :ref:`outer
245-
# colorbars or legends <ug_guides_loc>` (analogous to `space`). Finally, passing
246-
# ``wequal=True``, ``hequal=True``, or ``equal=True`` constrains the tight layout
247-
# algorithm to produce equal spacing between main subplot rows or columns (note
248-
# that equal spacing is the default behavior when tight layout is disabled).
245+
# colorbars or legends <ug_guides_loc>` (analogous to `space`).
249246
#
250247
# All the spacing arguments described above can be specified with a
251248
# :ref:`unit string <ug_units>` interpreted by `~proplot.utils.units`.
252249
# The default unit assumed for numeric arguments is an "em-width" (i.e., a
253250
# :rcraw:`font.size` width -- see the :ref:`units table <units_table>` for details).
251+
#
252+
# .. note::
253+
254+
# The core behavior of the tight layout algorithm can be modified with a few
255+
# keyword arguments and settings. Using ``wequal=True``, ``hequal=True``, or
256+
# ``equal=True`` (or setting :rcraw:`subplots.equalspace` to ``True``) constrains
257+
# the tight layout algorithm to produce equal spacing between main subplot columns
258+
# or rows (note that equal spacing is the default behavior when tight layout is
259+
# disabled). Similarly, using ``wgroup=False``, ``hgroup=False``, or ``group=False``
260+
# (or setting :rcraw:`subplots.groupspace` to ``False``) disables the default
261+
# behavior of only comparing subplot extent between adjacent subplot "groups"
262+
# and instead compares subplot extents across entire columns and rows.
254263

255264
# %%
256265
import proplot as pplt
257266

258267
# Stress test of the tight layout algorithm
259268
# Add large labels along the edge of one subplot
260-
for equal, descrip in enumerate(('variable', 'equal')):
269+
equals = [('unequal', False), ('equal', True)]
270+
groups = [('grouped', True), ('ungrouped', False)]
271+
for i in range(2):
272+
name1, equal = equals[i]
273+
name2, group = groups[i]
274+
suffix = ' (default)' if i == 0 else ''
275+
suptitle = f'Tight layout with "{name1}" and "{name2}" row-column spacing{suffix}'
261276
fig, axs = pplt.subplots(
262-
nrows=3, ncols=3, refwidth=1.1, share=False, equal=bool(equal)
277+
nrows=3, ncols=3, refwidth=1.1, share=False, equal=equal, group=group,
263278
)
264279
axs[1].format(
265280
xlabel='xlabel\nxlabel',
266281
ylabel='ylabel\nylabel\nylabel\nylabel'
267282
)
283+
axs[3:6:2].format(
284+
title='Title\nTitle',
285+
titlesize='med',
286+
)
268287
axs.format(
269288
grid=False,
270289
toplabels=('Column 1', 'Column 2', 'Column 3'),
271290
leftlabels=('Row 1', 'Row 2', 'Row 3'),
272-
suptitle=f'Tight layout with {descrip} row-column spacing',
291+
suptitle=suptitle,
273292
)
274293

275294
# %%

‎proplot/figure.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -526,6 +526,7 @@ def __init__(
526526
tight=None, outerpad=None, innerpad=None, panelpad=None,
527527
wpad=None, hpad=None, pad=None,
528528
wequal=None, hequal=None, equal=None,
529+
wgroup=None, hgroup=None, group=None,
529530
**kwargs
530531
):
531532
"""
@@ -622,6 +623,7 @@ def __init__(
622623
'left': left, 'right': right, 'top': top, 'bottom': bottom,
623624
'wspace': wspace, 'hspace': hspace, 'space': space,
624625
'wequal': wequal, 'hequal': hequal, 'equal': equal,
626+
'wgroup': wgroup, 'hgroup': hgroup, 'group': group,
625627
'wpad': wpad, 'hpad': hpad, 'pad': pad,
626628
'outerpad': outerpad, 'innerpad': innerpad, 'panelpad': panelpad,
627629
}

‎proplot/gridspec.py‎

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,12 @@
7474
%(units.em)s
7575
"""
7676
_tight_docstring = """
77-
wequal, hequal, equal : bool, default: False
77+
wequal, hequal, equal : bool, default: :rc:`subplots.equalspace`
7878
Whether to make the tight layout algorithm apply equal spacing
7979
between columns, rows, or both.
80+
wgroup, hgroup, group : bool, default: :rc:`subplot.groupspace`
81+
Whether to make the tight layout algorithm just consider spaces between
82+
adjacent subplots instead of entire columns and rows of subplots.
8083
outerpad : unit-spec, default: :rc:`subplots.outerpad`
8184
The scalar tight layout padding around the left, right, top, bottom figure edges.
8285
%(units.em)s
@@ -276,8 +279,10 @@ def __init__(self, nrows=1, ncols=1, **kwargs):
276279
self._panelpad = units(panelpad, 'em', 'in')
277280
self._hpad_total = [units(pad, 'em', 'in')] * (nrows - 1)
278281
self._wpad_total = [units(pad, 'em', 'in')] * (ncols - 1)
279-
self._hequal = False
280-
self._wequal = False
282+
self._hequal = rc['subplots.equalspace']
283+
self._wequal = rc['subplots.equalspace']
284+
self._hgroup = rc['subplots.groupspace']
285+
self._wgroup = rc['subplots.groupspace']
281286
self._hpanels = [''] * nrows # axes and figure panel identification
282287
self._wpanels = [''] * ncols
283288
self._fpanels = { # array representation of figure panel spans
@@ -691,11 +696,13 @@ def _get_tight_space(self, w):
691696
return
692697
if w == 'w':
693698
x, y = 'xy'
699+
group = self._wgroup
694700
nacross = self.nrows_total
695701
space = self.wspace_total
696702
pad = self.wpad_total
697703
else:
698704
x, y = 'yx'
705+
group = self._hgroup
699706
nacross = self.ncols_total
700707
space = self.hspace_total
701708
pad = self.hpad_total
@@ -736,9 +743,14 @@ def _get_tight_space(self, w):
736743
break
737744
else:
738745
if axs1 and axs2:
739-
groups.append([set(axs1), set(axs2)]) # form new group
746+
groups.append((set(axs1), set(axs2))) # form new group
740747
# Determing the spaces using cached tight bounding boxes
741748
# NOTE: Set gridspec space to zero if there are no adjacent edges
749+
if not group:
750+
groups = [(
751+
set(ax for (group1, _) in groups for ax in group1),
752+
set(ax for (_, group2) in groups for ax in group2),
753+
)]
742754
margins = []
743755
for (group1, group2) in groups:
744756
x1 = max(ax._range_tightbbox(x)[1] for ax in group1)
@@ -915,6 +927,7 @@ def _update_params(
915927
wspace=None, hspace=None, space=None,
916928
wpad=None, hpad=None, pad=None,
917929
wequal=None, hequal=None, equal=None,
930+
wgroup=None, hgroup=None, group=None,
918931
outerpad=None, innerpad=None, panelpad=None,
919932
hratios=None, wratios=None, width_ratios=None, height_ratios=None,
920933
):
@@ -924,24 +937,29 @@ def _update_params(
924937
# Assign scalar args
925938
# WARNING: The key signature here is critical! Used in ui.py to
926939
# separate out figure keywords and gridspec keywords.
927-
def _assign_scalar(key, value):
940+
def _assign_scalar(key, value, convert=True):
928941
if value is None:
929942
return
930943
if not np.isscalar(value):
931944
raise ValueError(f'Unexpected {key}={value!r}. Must be scalar.')
932-
value = units(value, 'em', 'in')
945+
if convert:
946+
value = units(value, 'em', 'in')
933947
setattr(self, f'_{key}', value)
934948
hequal = _not_none(hequal, equal)
935949
wequal = _not_none(wequal, equal)
950+
hgroup = _not_none(hgroup, group)
951+
wgroup = _not_none(wgroup, group)
936952
_assign_scalar('left', left)
937953
_assign_scalar('right', right)
938954
_assign_scalar('bottom', bottom)
939955
_assign_scalar('top', top)
940-
_assign_scalar('hequal', hequal)
941-
_assign_scalar('wequal', wequal)
942956
_assign_scalar('panelpad', panelpad)
943957
_assign_scalar('outerpad', outerpad)
944958
_assign_scalar('innerpad', innerpad)
959+
_assign_scalar('hequal', hequal, convert=False)
960+
_assign_scalar('wequal', wequal, convert=False)
961+
_assign_scalar('hgroup', hgroup, convert=False)
962+
_assign_scalar('wgroup', wgroup, convert=False)
945963

946964
# Assign vector args
947965
# NOTE: Here we employ obfuscation that skips 'panel' indices. So users could

‎proplot/internals/rcsetup.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1635,6 +1635,18 @@ def copy(self):
16351635
'Whether to align axis labels during draw. See `aligning labels '
16361636
'<https://matplotlib.org/stable/gallery/subplots_axes_and_figures/align_labels_demo.html>`__.' # noqa: E501
16371637
),
1638+
'subplots.equalspace': (
1639+
False,
1640+
_validate_bool,
1641+
'Whether to make the tight layout algorithm assign the same space for '
1642+
'every row and the same space for every column.'
1643+
),
1644+
'subplots.groupspace': (
1645+
True,
1646+
_validate_bool,
1647+
'Whether to make the tight layout algorithm consider space between only '
1648+
'adjacent subplot "groups" rather than every subplot in the row or column.'
1649+
),
16381650
'subplots.innerpad': (
16391651
1,
16401652
_validate_em,

0 commit comments

Comments
 (0)