matplotlib 3.5.1

Other ParametersParametersBackRef
savefig(self, fname, *, transparent=None, **kwargs)

Call signature:

savefig(fname, *, 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.

Other Parameters

dpi : float or 'figure', default: :rc:`savefig.dpi`

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

format : str

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

metadata : dict, optional

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

bbox_inches : str or `.Bbox`, default: :rc:`savefig.bbox`

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_inches : float, default: :rc:`savefig.pad_inches`

Amount of padding around the figure when bbox_inches is 'tight'.

facecolor : color or 'auto', default: :rc:`savefig.facecolor`

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

edgecolor : color or 'auto', default: :rc:`savefig.edgecolor`

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

backend : str, 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. See the-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.

papertype : str

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

transparent : bool

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.

bbox_extra_artists : list of `~matplotlib.artist.Artist`, optional

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

pil_kwargs : dict, optional

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

Parameters

fname : str or path-like or binary file-like

A path, or a Python file-like object, or possibly some backend-dependent object such as matplotlib.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 savefig.format and the appropriate extension is appended to fname.

Save the current figure.

Examples

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

matplotlib.backends.backend_pdf.PdfPages.savefig matplotlib.tight_bbox matplotlib.pyplot.show matplotlib.mathtext.math_to_image matplotlib.animation.AbstractMovieWriter.grab_frame matplotlib.animation.Animation.save

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /matplotlib/figure.py#2896
type: <class 'function'>
Commit: