mlreportgen.utils.HTMLDoc class

Package: mlreportgen.utils
Superclasses:

Wrap HTML file for viewing

Description

This utility wraps a .html file into an object. You can then manipulate the object using the methods of this utility.

Construction

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

Input Arguments

filename — Path to HTML file

string | character vector

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

Output Arguments

docobj — HTMLDoc object

wrapped file

HTMLDoc object, returned as a wrapped document object file.

Methods

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

Examples

Create HTMLDoc Object and Make It Visible

This example wraps the existing MyHTMLDoc.html file into an HTMLDoc object.

docobj = mlreportgen.utils.HTMLDoc("MyHTMLDoc.html");
show(docobj);