matplotlib.pyplot.savefig — Matplotlib 3.10.1 documentation (original) (raw)

matplotlib.pyplot.savefig(*args, **kwargs)[source]#

Save the current figure as an image or vector graphic to a file.

Call signature:

savefig(fname, *, transparent=None, dpi='figure', format=None, metadata=None, bbox_inches=None, pad_inches=0.1, facecolor='auto', edgecolor='auto', backend=None, **kwargs )

The available output formats depend on the backend being used.

Parameters:

fnamestr or path-like or binary file-like

A path, or a Python file-like object, or possibly some backend-dependent object such asmatplotlib.backends.backend_pdf.PdfPages.

If format is set, it determines the output format, and the file is saved as fname. Note that fname is used verbatim, and there is no attempt to make the extension, if any, of fname match_format_, and no extension is appended.

If format is not set, then the format is inferred from the extension of fname, if there is one. If format is not set and fname has no extension, then the file is saved with[rcParams["savefig.format"]](../../users/explain/customizing.html?highlight=savefig.format#matplotlibrc-sample) (default: 'png') and the appropriate extension is appended to_fname_.

Other Parameters:

transparentbool, default: [rcParams["savefig.transparent"]](../../users/explain/customizing.html?highlight=savefig.transparent#matplotlibrc-sample) (default: False)

If True, the Axes patches will all be transparent; the Figure patch will also be transparent unless _facecolor_and/or edgecolor are specified via kwargs.

If False has no effect and the color of the Axes and Figure patches are unchanged (unless the Figure patch is specified via the facecolor and/or edgecolor keyword arguments in which case those colors are used).

The transparency of these patches will be restored to their original values upon exit of this function.

This is useful, for example, for displaying a plot on top of a colored background on a web page.

dpifloat or 'figure', default: [rcParams["savefig.dpi"]](../../users/explain/customizing.html?highlight=savefig.dpi#matplotlibrc-sample) (default: 'figure')

The resolution in dots per inch. If 'figure', use the figure's dpi value.

formatstr

The file format, e.g. 'png', 'pdf', 'svg', ... The behavior when this is unset is documented under fname.

metadatadict, optional

Key/value pairs to store in the image metadata. The supported keys and defaults depend on the image format and backend:

Not supported for 'pgf', 'raw', and 'rgba' as those formats do not support embedding metadata. Does not currently support 'jpg', 'tiff', or 'webp', but may include embedding EXIF metadata in the future.

bbox_inchesstr or Bbox, default: [rcParams["savefig.bbox"]](../../users/explain/customizing.html?highlight=savefig.bbox#matplotlibrc-sample) (default: None)

Bounding box in inches: only the given portion of the figure is saved. If 'tight', try to figure out the tight bbox of the figure.

pad_inchesfloat or 'layout', default: [rcParams["savefig.pad_inches"]](../../users/explain/customizing.html?highlight=savefig.pad%5Finches#matplotlibrc-sample) (default: 0.1)

Amount of padding in inches around the figure when bbox_inches is 'tight'. If 'layout' use the padding from the constrained or compressed layout engine; ignored if one of those engines is not in use.

facecolorcolor or 'auto', default: [rcParams["savefig.facecolor"]](../../users/explain/customizing.html?highlight=savefig.facecolor#matplotlibrc-sample) (default: 'auto')

The facecolor of the figure. If 'auto', use the current figure facecolor.

edgecolorcolor or 'auto', default: [rcParams["savefig.edgecolor"]](../../users/explain/customizing.html?highlight=savefig.edgecolor#matplotlibrc-sample) (default: 'auto')

The edgecolor of the figure. If 'auto', use the current figure edgecolor.

backendstr, optional

Use a non-default backend to render the file, e.g. to render a png file with the "cairo" backend rather than the default "agg", or a pdf file with the "pgf" backend rather than the default "pdf". Note that the default backend is normally sufficient. SeeThe builtin backends for a list of valid backends for each file format. Custom backends can be referenced as "module://...".

orientation{'landscape', 'portrait'}

Currently only supported by the postscript backend.

papertypestr

One of 'letter', 'legal', 'executive', 'ledger', 'a0' through 'a10', 'b0' through 'b10'. Only supported for postscript output.

bbox_extra_artistslist of Artist, optional

A list of extra artists that will be considered when the tight bbox is calculated.

pil_kwargsdict, optional

Additional keyword arguments that are passed toPIL.Image.Image.save when saving the figure.

Notes

Examples using matplotlib.pyplot.savefig#