mlreportgen.report.Reporter class

Package: mlreportgen.report
Superclasses:

Create a MATLAB Reporter

Description

mlreportgen.report.Reporter is a superclass for reporter objects that generate content to be added to a report. The format of a reporter is based on a template, which is stored in a template library.

Construction

reporter = Reporter() creates an empty reporter.

reporter = Reporter(Name,Value) sets properties using name-value pairs. You can specify multiple name-value pair arguments in any order. Enclose each property name in single quotes.

Properties

expand all

Source of the template for this reporter, specified in one of these ways:

  • Character vector or string scalar that specifies the path of the file that contains the template for this reporter

  • Reporter or report whose template is used for this reporter or whose template library contains the template for this reporter

  • DOM document or document part whose template is used for this reporter or whose template library contains the template for this reporter

The specified template must be the same type as the report to which this reporter is appended. For example, for a Microsoft® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template source (TemplateSrc) for this reporter.

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget object. A character vector or string scalar value is converted to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Methods

copyCreate copy of reporter object and make deep copies of property values that reference a reporter, ReporterLayout, or DOM object
getImplGet implementation of reporter
mlreportgen.report.Reporter.customizeReporterCreate class derived from Reporter class
Introduced in R2017b