matplotlib.figure.Figure.set_layout_engine#

Figure.set_layout_engine(layout=None, **kwargs)[source]#

Set the layout engine for this figure.

Parameters:

layout{'constrained', 'compressed', 'tight', 'none', LayoutEngine, None}

• 'constrained' will use ConstrainedLayoutEngine

• 'compressed' will also use ConstrainedLayoutEngine, but with a correction that attempts to make a good layout for fixed-aspect ratio Axes.

• 'tight' uses TightLayoutEngine

• 'none' removes layout engine.

If a LayoutEngine instance, that instance will be used.

If None, the behavior is controlled by rcParams["figure.autolayout"] (default: False) (which if True behaves as if 'tight' was passed) and rcParams["figure.constrained_layout.use"] (default: False) (which if True behaves as if 'constrained' was passed). If both are True, rcParams["figure.autolayout"] (default: False) takes priority.

Users and libraries can define their own layout engines and pass the instance directly as well.

**kwargs

The keyword arguments are passed to the layout engine to set things like padding and margin sizes. Only used if layout is a string.

Examples using matplotlib.figure.Figure.set_layout_engine#

[]

Constrained layout guide

Constrained layout guide