engforge.attr_plotting.save_all_figures_to_pdf

save_all_figures_to_pdf(filename, figs=None, dpi=200, close=True, pdf=None, return_pdf=False)[source]

Save all figures to a PDF file.

Parameters:
  • filename – The name of the PDF file to save.

  • figs – List of figures to save. If None, all open figures will be saved.

  • dpi – The resolution of the saved figures in dots per inch.

  • close – Whether to close all figures after saving.

  • pdf – An existing PdfPages object to append the figures to. If None, a new PdfPages object will be created.

  • return_pdf – Whether to return the PdfPages object after saving.

Returns:

The PdfPages object if return_pdf is True, else None.

Return type:

PdfPages or None