Skip to content

Update figure.py #29277

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

Closed
Thierno88 wants to merge 1 commit into from
Closed

Update figure.py #29277

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
38 changes: 37 additions & 1 deletion lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3219,7 +3219,43 @@ def set_figheight(self, val, forward=True):
matplotlib.figure.Figure.set_size_inches
"""
self.set_size_inches(self.get_figwidth(), val, forward=forward)

def set_figratio(self, width=None, height=None, aspect=None, forward=True):
"""
Set the size of the figure using a width, height, or aspect ratio.
Parameters
----------
width : float, optional
The width of the figure in inches. If None, the width is taken from rcParams["figure.figsize"].
height : float, optional
The height of the figure in inches. If None, the height is taken from rcParams["figure.figsize"].
aspect : float, optional
The aspect ratio to adjust the size. If set, the height or width will be adjusted accordingly.
forward : bool, optional
See `set_size_inches` for details.

Raises
------
ValueError
If neither width nor height nor aspect is provided.
"""
figsize_default = plt.rcParams["figure.figsize"]

if width is not None and height is not None:
self.set_size_inches(width, height, forward=forward)
elif aspect is not None:
if height is not None:
self.set_size_inches(self.get_figwidth() * aspect, height, forward=forward)
elif width is not None:
self.set_size_inches(width, self.get_figheight() * aspect, forward=forward)
else:
self.set_size_inches(self.get_figwidth() * aspect, self.get_figheight() * aspect, forward=forward)
else:
if width is None:
width = figsize_default[0]
if height is None:
height = figsize_default[1]
self.set_size_inches(width, height, forward=forward)

def clear(self, keep_observers=False):
# docstring inherited
super().clear(keep_observers=keep_observers)
Expand Down