8000 Merge pull request #26454 from timhoffm/label_outer_check_rectilinear · matplotlib/matplotlib@b764dcd · GitHub
[go: up one dir, main page]
Skip to content

Commit b764dcd

Browse files
ksundentimhoffm
ksunden
authored and
timhoffm
committed
Merge pull request #26454 from timhoffm/label_outer_check_rectilinear
Rename an internal parameter of _label_outer_x/yaxis()
2 parents 868004b + 88e1353 commit b764dcd

File tree

6 files changed

+98
-30
lines changed

6 files changed

+98
-30
lines changed

‎doc/users/next_whats_new/label_outer.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Remove inner ticks in ``label_outer()``
2+
---------------------------------------
3+
Up to now, ``label_outer()`` has only removed the ticklabels. The ticks lines
4+
were left visible. This is now configurable through a new parameter
5+
``label_outer(remove_inner_ticks=True)``.
6+
7+
8+
.. plot::
9+
:include-source: true
10+
11+
import numpy as np
12+
import matplotlib.pyplot as plt
13+
14+
x = np.linspace(0, 2 * np.pi, 100)
15+
16+
fig, axs = plt.subplots(2, 2, sharex=True, sharey=True,
17+
gridspec_kw=dict(hspace=0, wspace=0))
18+
19+
axs[0, 0].plot(x, np.sin(x))
20+
axs[0, 1].plot(x, np.cos(x))
21+
axs[1, 0].plot(x, -np.cos(x))
22+
axs[1, 1].plot(x, -np.sin(x))
23+
24+
for ax in axs.flat:
25+
ax.grid(color='0.9')
26+
ax.label_outer(remove_inner_ticks=True)

‎lib/matplotlib/axes/_base.py

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4490,20 +4490,29 @@ def get_shared_y_axes(self):
44904490
"""Return an immutable view on the shared y-axes Grouper."""
44914491
return cbook.GrouperView(self._shared_axes["y"])
44924492

4493-
def label_outer(self):
4493+
def label_outer(self, remove_inner_ticks=False):
44944494
"""
44954495
Only show "outer" labels and tick labels.
44964496
44974497
x-labels are only kept for subplots on the last row (or first row, if
44984498
labels are on the top side); y-labels only for subplots on the first
44994499
column (or last column, if labels are on the right side).
4500+
4501+
Parameters
4502+
----------
4503+
remove_inner_ticks : bool, default: False
4504+
If True, remove the inner ticks as well (not only tick labels).
45004505
"""
4501-
self._label_outer_xaxis(check_patch=False)
4502-
self._label_outer_yaxis(check_patch=False)
4506+
self._label_outer_xaxis(skip_non_rectangular_axes=False,
4507+
remove_inner_ticks=remove_inner_ticks)
4508+
self._label_outer_yaxis(skip_non_rectangular_axes=False,
4509+
remove_inner_ticks=remove_inner_ticks)
45034510

4504-
def _label_outer_xaxis(self, *, check_patch):
4511+
def _label_outer_xaxis(self, *, skip_non_rectangular_axes,
4512+
remove_inner_ticks=False):
45054513
# see documentation in label_outer.
4506-
if check_patch and not isinstance(self.patch, mpl.patches.Rectangle):
4514+
if skip_non_rectangular_axes and not isinstance(self.patch,
4515+
mpl.patches.Rectangle):
45074516
return
45084517
ss = self.get_subplotspec()
45094518
if not ss:
@@ -4512,19 +4521,25 @@ def _label_outer_xaxis(self, *, check_patch):
45124521
if not ss.is_first_row(): # Remove top label/ticklabels/offsettext.
45134522
if label_position == "top":
45144523
self.set_xlabel("")
4515-
self.xaxis.set_tick_params(which="both", labeltop=False)
4524+
top_kw = {'top': False} if remove_inner_ticks else {}
4525+
self.xaxis.set_tick_params(
4526+
which="both", labeltop=False, **top_kw)
45164527
if self.xaxis.offsetText.get_position()[1] == 1:
45174528
self.xaxis.offsetText.set_visible(False)
45184529
if not ss.is_last_row(): # Remove bottom label/ticklabels/offsettext.
45194530
if label_position == "bottom":
45204531
self.set_xlabel("")
4521-
self.xaxis.set_tick_params(which="both", labelbottom=False)
4532+
bottom_kw = {'bottom': False} if remove_inner_ticks else {}
4533+
self.xaxis.set_tick_params(
4534+
which="both", labelbottom=False, **bottom_kw)
45224535
if self.xaxis.offsetText.get_position()[1] == 0:
45234536
self.xaxis.offsetText.set_visible(False)
45244537

4525-
def _label_outer_yaxis(self, *, check_patch):
4538+
def _label_outer_yaxis(self, *, skip_non_rectangular_axes,
4539+
remove_inner_ticks=False):
45264540
# see documentation in label_outer.
4527-
if check_patch and not isinstance(self.patch, mpl.patches.Rectangle):
4541+
if skip_non_rectangular_axes and not isinstance(self.patch,
4542+
mpl.patches.Rectangle):
45284543
return
45294544
ss = self.get_subplotspec()
45304545
if not ss:
@@ -4533,13 +4548,17 @@ def _label_outer_yaxis(self, *, check_patch):
45334548
if not ss.is_first_col(): # Remove left label/ticklabels/offsettext.
45344549
if label_position == "left":
45354550
self.set_ylabel("")
4536-
self.yaxis.set_tick_params(which="both", labelleft=False)
4551+
left_kw = {'left': False} if remove_inner_ticks else {}
4552+
self.yaxis.set_tick_params(
4553+
which="both", labelleft=False, **left_kw)
45374554
if self.yaxis.offsetText.get_position()[0] == 0:
45384555
self.yaxis.offsetText.set_visible(False)
45394556
if not ss.is_last_col(): # Remove right label/ticklabels/offsettext.
45404557
if label_position == "right":
45414558
self.set_ylabel("")
4542-
self.yaxis.set_tick_params(which="both", labelright=False)
4559+
right_kw = {'right': False} if remove_inner_ticks else {}
4560+
self.yaxis.set_tick_params(
4561+
which="both", labelright=False, **right_kw)
45434562
if self.yaxis.offsetText.get_position()[0] == 1:
45444563
self.yaxis.offsetText.set_visible(False)
45454564

‎lib/matplotlib/axes/_base.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ class _AxesBase(martist.Artist):
376376
def twiny(self) -> _AxesBase: ...
377377
def get_shared_x_axes(self) -> cbook.GrouperView: ...
378378
def get_shared_y_axes(self) -> cbook.GrouperView: ...
379-
def label_outer(self) -> None: ...
379+
def label_outer(self, remove_inner_ticks: bool) -> None: ...
380380

381381
# The methods underneath this line are added via the `_axis_method_wrapper` class
382382
# Initially they are set to an object, but that object uses `__set_name__` to override

‎lib/matplotlib/figure.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2118,10 +2118,10 @@ def _do_layout(gs, mosaic, unique_ids, nested):
21182118
for ax in ret.values():
21192119
if sharex:
21202120
ax.sharex(ax0)
2121-
ax._label_outer_xaxis(check_patch=True)
2121+
ax._label_outer_xaxis(skip_non_rectangular_axes=True)
21222122
if sharey:
21232123
ax.sharey(ax0)
2124-
ax._label_outer_yaxis(check_patch=True)
2124+
ax._label_outer_yaxis(skip_non_rectangular_axes=True)
21252125
if extra := set(per_subplot_kw) - set(ret):
21262126
raise ValueError(
21272127
f"The keys {extra} are in *per_subplot_kw* "

‎lib/matplotlib/gridspec.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,10 +301,10 @@ def subplots(self, *, sharex=False, sharey=False, squeeze=True,
301301
# turn off redundant tick labeling
302302
if sharex in ["col", "all"]:
303303
for ax in axarr.flat:
304-
ax._label_outer_xaxis(check_patch=True)
304+
ax._label_outer_xaxis(skip_non_rectangular_axes=True)
305305
if sharey in ["row", "all"]:
306306
for ax in axarr.flat:
307-
ax._label_outer_yaxis(check_patch=True)
307+
ax._label_outer_yaxis(skip_non_rectangular_axes=True)
308308

309309
if squeeze:
310310
# Discarding unneeded dimensions that equal 1. If we only have one

‎lib/matplotlib/tests/test_subplots.py

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ def check_shared(axs, x_shared, y_shared):
2424
i1, i2, "not " if shared[i1, i2] else "", name)
2525

2626

27-
def check_visible(axs, x_visible, y_visible):
27+
def check_ticklabel_visible(axs, x_visible, y_visible):
28+
"""Check that the x and y ticklabel visibility is as specified."""
2829
for i, (ax, vx, vy) in enumerate(zip(axs, x_visible, y_visible)):
2930
for l in ax.get_xticklabels() + [ax.xaxis.offsetText]:
3031
assert l.get_visible() == vx, \
@@ -40,6 +41,20 @@ def check_visible(axs, x_visible, y_visible):
4041
assert ax.get_ylabel() == ""
4142

4243

44+
def check_tick1_visible(axs, x_visible, y_visible):
45+
"""
46+
Check that the x and y tick visibility is as specified.
47+
48+
Note: This only checks the tick1line, i.e. bottom / left ticks.
49+
"""
50+
for ax, visible, in zip(axs, x_visible):
51+
for tick in ax.xaxis.get_major_ticks():
52+
assert tick.tick1line.get_visible() == visible
53+
for ax, y_visible, in zip(axs, y_visible):
54+
for tick in ax.yaxis.get_major_ticks():
55+
assert tick.tick1line.get_visible() == visible
56+
57+
4358
def test_shared():
4459
rdim = (4, 4, 2)
4560
share = {
@@ -90,16 +105,24 @@ def test_shared():
90105
f, ((a1, a2), (a3, a4)) = plt.subplots(2, 2, sharex=xo, sharey=yo)
91106
axs = [a1, a2, a3, a4]
92107
check_shared(axs, share[xo], share[yo])
93-
check_visible(axs, visible['x'][xo], visible['y'][yo])
108+
check_ticklabel_visible(axs, visible['x'][xo], visible['y'][yo])
94109
plt.close(f)
95110

96-
# test label_outer
97-
f, ((a1, a2), (a3, a4)) = plt.subplots(2, 2, sharex=True, sharey=True)
98-
axs = [a1, a2, a3, a4]
99-
for ax in axs:
111+
112+
@pytest.mark.parametrize('remove_ticks', [True, False])
113+
def test_label_outer(remove_ticks):
114+
f, axs = plt.subplots(2, 2, sharex=True, sharey=True)
115+
for ax in axs.flat:
100116
ax.set(xlabel="foo", ylabel="bar")
101-
ax.label_outer()
102-
check_visible(axs, [False, False, True, True], [True, False, True, False])
117+
ax.label_outer(remove_inner_ticks=remove_ticks)
118+
check_ticklabel_visible(
119+
axs.flat, [False, False, True, True], [True, False, True, False])
120+
if remove_ticks:
121+
check_tick1_visible(
122+
axs.flat, [False, False, True, True], [True, False, True, False])
123+
else:
124+
check_tick1_visible(
125+
axs.flat, [True, True, True, True], [True, True, True, True])
103126

104127

105128
def test_label_outer_span():
@@ -118,28 +141,28 @@ def test_label_outer_span():
118141
a4 = fig.add_subplot(gs[2, 1])
119142
for ax in fig.axes:
120143
ax.label_outer()
121-
check_visible(
144+
check_ticklabel_visible(
122145
fig.axes, [False, True, False, True], [True, True, False, False])
123146

124147

125148
def test_label_outer_non_gridspec():
126149
ax = plt.axes((0, 0, 1, 1))
127150
ax.label_outer() # Does nothing.
128-
check_visible([ax], [True], [True])
151+
check_ticklabel_visible([ax], [True], [True])
129152

130153

131154
def test_shared_and_moved():
132155
# test if sharey is on, but then tick_left is called that labels don't
133156
# re-appear. Seaborn does this just to be sure yaxis is on left...
134157
f, (a1, a2) = plt.subplots(1, 2, sharey=True)
135-
check_visible([a2], [True], [False])
158+
check_ticklabel_visible([a2], [True], [False])
136159
a2.yaxis.tick_left()
137-
check_visible([a2], [True], [False])
160+
check_ticklabel_visible([a2], [True], [False])
138161

139162
f, (a1, a2) = plt.subplots(2, 1, sharex=True)
140-
check_visible([a1], [False], [True])
163+
check_ticklabel_visible([a1], [False], [True])
141164
a2.xaxis.tick_bottom()
142-
check_visible([a1], [False], [True])
165+
check_ticklabel_visible([a1], [False], [True])
143166

144167

145168
def test_exceptions():

0 commit comments

Comments
 (0)
0