mlreportgen.utils.PDFDoc class

Package: mlreportgen.utils
Superclasses:

Wrap PDF file for viewing

Construction

docobj = mlreportgen.utils.PDFDoc(filename) wraps a PDF document file for viewing. The PDF document object is not visible on construction. To make it visible, use the show method.

Input Arguments

filename — Path to PDF file

string | character vector

Path to a PDF file, specified as a string or character vector.

Output Arguments

docobj — PDF document object

wrapped file

PDF document object, returned as a wrapped document object file.

Properties

FileName — Full path to PDF file

string | character vector

Full path to PDF file, specified as a string or character vector.

Methods

show	Show PDF file mlreportgen.utils.PDFDoc.show(pdfDoc)
hide	Hide PDF file mlreportgen.utils.PDFDoc.hide(pdfDoc)
isVisible	Check whether PDF file is visible mlreportgen.utils.PDFDoc.isVisible(pdfDoc)

Examples

Create PDF Doc Object and Make It Visible

docobj = mlreportgen.utils.PDFDoc("MyPDFDoc.pdf");
show(docobj);