tight_layout

matplotlib.tight_layout

This module provides routines to adjust subplot params so that subplots are nicely fit in the figure. In doing so, only axis labels, tick labels, axes titles and offsetboxes that are anchored to axes are currently considered.

Internally, it assumes that the margins (left_margin, etc.) which are differences between ax.get_tightbbox and ax.bbox are independent of axes position. This may fail if Axes.adjustable is datalim. Also, This will fail for some cases (for example, left or right margin is affected by xlabel).

matplotlib.tight_layout.auto_adjust_subplotpars(fig, renderer, nrows_ncols, num1num2_list, subplot_list, ax_bbox_list=None, pad=1.08, h_pad=None, w_pad=None, rect=None)

Return a dictionary of subplot parameters so that spacing between subplots are adjusted. Note that this function ignore geometry information of subplot itself, but uses what is given by nrows_ncols and num1num2_list parameteres. Also, the results could be incorrect if some subplots have adjustable=datalim.

Parameters:

nrows_ncols

number of rows and number of columns of the grid.

num1num2_list

list of numbers specifying the area occupied by the subplot

subplot_list

list of subplots that will be used to calcuate optimal subplot_params.

pad : float

padding between the figure edge and the edges of subplots, as a fraction of the font-size.

h_pad, w_pad : float

padding (height/width) between edges of adjacent subplots.

Defaults to pad_inches.

rect

[left, bottom, right, top] in normalized (0, 1) figure coordinates.

matplotlib.tight_layout.get_renderer(fig)

matplotlib.tight_layout.get_subplotspec_list(axes_list, grid_spec=None)

Return a list of subplotspec from the given list of axes. For an instance of axes that does not support subplotspec, None is inserted in the list.

If grid_spec is given, None is inserted for those not from the given grid_spec.

matplotlib.tight_layout.get_tight_layout_figure(fig, axes_list, subplotspec_list, renderer, pad=1.08, h_pad=None, w_pad=None, rect=None)

Return subplot parameters for tight-layouted-figure with specified padding.

Parameters:

fig : figure instance

axes_list : a list of axes

subplotspec_list : a list of subplotspec associated with each

axes in axes_list

renderer : renderer instance

pad : float

padding between the figure edge and the edges of subplots, as a fraction of the font-size.

h_pad, w_pad : float

padding (height/width) between edges of adjacent subplots. Defaults to pad_inches.

rect : if rect is given, it is interpreted as a rectangle

(left, bottom, right, top) in the normalized figure coordinate that the whole subplots area (including labels) will fit into. Default is (0, 0, 1, 1).