mlreportgen.utils.HTMXDoc class

Package: mlreportgen.utils
Superclasses:

Wrap HTMX document file for viewing

Construction

docobj = mlreportgen.utils.HTMXDoc(filename) wraps an HTMX document file and returns it as an HTMX doc object. The HTMX doc object is not visible on construction. To make it visible, use the show method.

Input Arguments

filename — Path to HTMX file

string | character vector

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

Output Arguments

docobj — HTMX document object

wrapped file

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

Properties

FileName — Full path to HTMX file

string | character vector

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

Methods

show	Show HTMX file mlreportgen.utils.HTMXDoc.show(htmldoc)
hide	Hide HTMX file mlreportgen.utils.HTMXDoc.hide(htmldoc)
isVisible	Test whether HTMX file is visible mlreportgen.utils.HTMXDoc.isVisible(htmldoc)

Examples

Create HTMX Doc Object and Make It Visible

This example wraps the existing MyHTMXDoc.html file into an HTMXDoc object.

docobj = mlreportgen.utils.HTMXDoc("MyHTMXDoc.htmx");
show(docobj);