Skip to content

feat(figure): add loc parameter to suptitle #32203

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

Open
Muhtasim-Munif-Fahim wants to merge 1 commit into
base: main
Choose a base branch
from
+36 −2
Open

feat(figure): add loc parameter to suptitle #32203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,8 @@ def _suplabels(self, t, info, **kwargs):
fontweight, weight : default: :rc:`figure.%(rc)sweight`
The font weight of the text. See `.Text.set_weight` for possible
values.
loc : {'left', 'center', 'right'}, default: 'center'
The horizontal position of the %(name)s.

Returns
-------
Expand Down Expand Up @@ -475,11 +477,18 @@ def _remove_suplabel(self, label, name):
@_docstring.Substitution(x0=0.5, y0=0.98, name='super title', ha='center',
va='top', rc='title')
@_docstring.copy(_suplabels)
def suptitle(self, t, **kwargs):
def suptitle(self, t, loc=None, **kwargs):
# docstring from _suplabels...
info = {'name': '_suptitle', 'x0': 0.5, 'y0': 0.98,
'ha': 'center', 'va': 'top', 'rotation': 0,
'size': 'figure.titlesize', 'weight': 'figure.titleweight'}
if loc is not None:
_valid_locs = {'left': (0.02, 'left'),
'center': (0.5, 'center'),
'right': (0.98, 'right')}
_loc = loc.lower()
_api.check_in_list(_valid_locs, loc=_loc)
info['x0'], info['ha'] = _valid_locs[_loc]
return self._suplabels(t, info, **kwargs)

def get_suptitle(self):
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/figure.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ class FigureBase(Artist):

def get_children(self) -> list[Artist]: ...
def contains(self, mouseevent: MouseEvent) -> tuple[bool, dict[Any, Any]]: ...
def suptitle(self, t: str, **kwargs) -> Text: ...
def suptitle(self, t: str, loc: Literal['left', 'center', 'right'] | None = None, **kwargs) -> Text: ...
def get_suptitle(self) -> str: ...
def supxlabel(self, t: str, **kwargs) -> Text: ...
def get_supxlabel(self) -> str: ...
Expand Down
25 changes: 25 additions & 0 deletions lib/matplotlib/tests/test_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,31 @@ def test_suptitle_fontproperties():
assert txt.get_weight() == fps.get_weight()


def test_suptitle_loc():
fig, _ = plt.subplots()
t_left = fig.suptitle('left', loc='left')
assert t_left.get_ha() == 'left'
assert t_left.get_position()[0] == 0.02

t_center = fig.suptitle('center', loc='center')
assert t_center.get_ha() == 'center'
assert t_center.get_position()[0] == 0.5

t_right = fig.suptitle('right', loc='right')
assert t_right.get_ha() == 'right'
assert t_right.get_position()[0] == 0.98

# default (loc=None) should use center
fig2, _ = plt.subplots()
t_default = fig2.suptitle('default')
assert t_default.get_ha() == 'center'
assert t_default.get_position()[0] == 0.5

# invalid loc should raise
with pytest.raises(ValueError, match="'invalid' is not a valid value for loc"):
fig.suptitle('bad', loc='invalid')


def test_suptitle_subfigures():
fig = plt.figure(figsize=(4, 3))
sf1, sf2 = fig.subfigures(1, 2)
Expand Down
Loading