WrightTools.artists.savefig

WrightTools.artists.savefig(path, fig=None, close=True, **kwargs)[source]

Save a figure.

Note, that this method defaults to transparent background (facecolor kwarg) and to 300 dpi.

Parameters:

  • path (str) – Path to save figure at.

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

  • close (bool (optional)) – Toggle closing of figure after saving. Default is True.

  • Parameters (Keyword)

  • ------------------

  • kwargs (any) – All additional parameters are passed to the underlying matplotlib savefig call

Returns:

The full path where the figure was saved.

Return type:

str