WrightTools.artists.plot_margins

WrightTools.artists.plot_margins(*, fig=None, inches=1.0, centers=True, edges=True)[source]

Add lines onto a figure indicating the margins, centers, and edges.

Useful for ensuring your figure design scripts work as intended, and for laying out figures.

Parameters:

  • fig (matplotlib.figure.Figure object (optional)) – The figure to plot onto. If None, gets current figure. Default is None.

  • inches (float or length 4 list (optional)) – Spacing, in inches, between the figure edge and the subplot boundary (i.e. ticks and labels appear in the margin space). If margin is a float, uniform spacing is applied to all four sides of the figure. If margin is a list, unique spacing is applied along each side [top, right, bottom, left]. Default is 1 inch margins.

  • centers (bool (optional)) – Toggle for plotting lines indicating the figure center. Default is True.

  • edges (bool (optional)) – Toggle for plotting lines indicating the figure edges. Default is True.