mlreportgen.utils.HTMXDoc Class

Namespace: mlreportgen.utils

Wrap HTMX document file for viewing

Description

The mlreportgen.utils.HTMXDoc class is a handle class.

Creation

Description

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

character vector | string scalar

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

Properties

FileName — Full path to HTMX file

character vector | string scalar

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

Attributes:

GetAccess	public
SetAccess	private

Data Types: char | string

Methods

Public 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);

Version History

Introduced in R2018b