slreportgen.report.Report Class

Namespace: slreportgen.report

Report container

Description

slreportgen.report.Report is a container for a report consisting of Simulink^® reporters and DOM objects. Use this object to generate an HTML, PDF, or Word report based on templates in a template library.

Note

Use objects of this type, instead of mlreportgen.report.Report, to create Simulink reports, which are reports that use Simulink reporters to generate content. You can also use MATLAB^® reporters and DOM objects to generate Simulink report content.

The slreportgen.report.Report class is a handle class.

Creation

Description

report = slreportgen.report.Report returns a report object report with the default report type (PDF) and a default file name (untitled.pdf).

report = slreportgen.report.Report(outputPath) uses the specified output outputPath for the report.

report = slreportgen.report.Report(outputPath,type) creates the specified type of report.

report = slreportgen.report.Report(outputPath,type,template) uses the specified template.

report = slreportgen.report.Report(PropertyName=Value) sets properties using name-value arguments. You can specify multiple name-value arguments in any order.

Input Arguments

expand all

`outputPath` — Report output path
`untitled.pdf` (default) | character array | string scalar

Report output path, specified as a character vector or a string scalar.

Example: "myReport.pdf"

Data Types: char | string

`type` — Output type of generated report
`"pdf"` (default) | `"pdfa"` | `"html"` | `"html-file"` | `"docx"`

Output type of the generated report, specified as one of these values:

"docx" — Microsoft^® Word document.
"html" — HTML report, packaged as a zipped file that contains the HTML file, images, style sheet, and JavaScript^® files of the report. To generate an HTML report as a folder that contains unzipped files, set the PackageType property to "unzipped" or "both".
"html-file" — HTML report that consists of a single HTML file that contains the text, style sheets, JavaScript, and base64-encoded images of the report.
"pdf"— PDF file.
"pdfa" — PDF/A file. (since R2025a)

Data Types: char | string

`template` — Location of template to use to format this report
`[]` | string scalar | character array

Location of the template to use to format this report, specified as a character vector or a string scalar. Use this argument to specify a custom template for the report. The template type must match the report output type.

Data Types: char | string

Properties

expand all

`CompileModelBeforeReporting` — Whether to compile the Simulink model before reporting
`1` (`true`) (default) | `0` (`false`)

Whether to compile the Simulink model before reporting, specified as a logical 1 (true) or 0 (false). When you specify:

1 (true) — Compile the Simulink model before reporting if it is not already compiled. If the model cannot be compiled, report generation terminates.
0 (false) — Allow report generation to proceed without compiling the model.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types: logical

`OutputPath` — Path of generated report file
`[]` (default) | character vector | string scalar

Path of the generated report file, specified as a character vector or string scalar. The path is the location in the file system of the report output document. The path can be a full path, for example, "C:/myreports/reportA.docx". The path can also be relative to the current MATLAB folder, for example, "reportA". If the file name does not have a file extension that corresponds to the Type property, the report generator adds the appropriate file extension when the report document is closed.

Note

Generating a PDF report on a cloud drive, such as MATLAB Drive™ or Microsoft OneDrive™, can cause file contention between the report generation software and the cloud drive synchronization software resulting in a version of this error:

Error closing document package: Could not commit changes: removeAll failed: fl:filesystem:AccessDenied: 
C:\Users\jdoe\OneDrive\Documents\MATLAB\reports\temp_FO\stylesheets: Permission denied.

To avoid this issue, generate reports on a local drive that does not synchronize with the cloud. Consider writing a script that generates a report on a local drive and then copies the report to the cloud drive.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types: char | string

`Type` — Output type of generated report
`"pdf"` (default) | `"docx"` | `"html"` | `"html-file"` | `"pdfa"`

Output type of the generated report, specified as one of these values:

"docx" — Microsoft Word document.
"html" — HTML report, packaged as a zipped file that contains the HTML file, images, style sheet, and JavaScript files of the report. To generate an HTML report as a folder that contains unzipped files, set the PackageType property to "unzipped" or "both".
"html-file" — HTML report that consists of a single HTML file that contains the text, style sheets, JavaScript, and base64-encoded images of the report.
"pdf"— PDF file.
"pdfa" — PDF/A file. (since R2025a)

If you specify a template using the TemplatePath property, the value for Type must match the template type.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types: char | string

`PackageType` — Packaging to use for generated files
`[]` (default) | `"zipped"` | `"unzipped"` | `"both"` | `"single-file"`

Packaging to use for the generated files, specified as one of these values:

Value	Supported Report Types	Description
`"zipped"`	`"docx"` `"html"`	Generates the report as a ZIP file at the location specified by the `OutputPath` property. The ZIP file has an extension that matches the document type (`.docx` for Word output or `.htmtx` for HTML output.) For example, if the document type is `"docx"` and `OutputPath` is `s:\docs\MyDoc`, the output is in a ZIP file named `s:\docs\MyDoc.docx`.
`"unzipped"`	`"docx"` `"html"`	Generates the report as separate files in a folder that has the file name of the `OutputPath` property. For example, if the `OutputPath` is `s:\docs\MyDoc`, the output folder is `s:\docs\MyDoc`.
`"both"`	`"docx"` `"html"`	Generates zipped and unzipped outputs.
`"single-file"`	`"html-file"` `"pdf"` `"pdfa"` (since R2025a)	Generates the report as a single file.

Tip

To generate an HTML report that you can open without unzipping when the Type property is "html", set PackageType to "unzipped" or "both". In the folder that contains the generated files, open the root.html file.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: char | string

`TemplatePath` — Location of template to use to format report
`[]` (default) | character vector | string scalar

Location of the template to use to format this report, specified as a character vector or string scalar. Use this property to specify a custom template for the report.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types: char | string

`Locale` — Locale or language
`[]` (default) | `"af"` | `"ca"` | `"cs"` | ...

Locale or language, specified as a character vector or string scalar that consists of the ISO_639-1 two-letter language code of the locale for which this report is to be generated. The default value, [], specifies the language of the system locale, for example, English on an English system. The Report API uses the language code to translate chapter title prefixes to the language of the specified locale. Translations are provided for the following locales.

Abbreviation	Language
`[]`	Language of the system locale
`"af"`	Afrikaans
`"ca"`	Catalan
`"cs"`	Czech
`"da"`	Danish
`"de"`	German
`"el"`	Greek, Modern
`"en"`	English
`"es"`	Spanish, Castilian
`"et"`	Estonian
`"eu"`	Basque
`"fi"`	Finnish
`"fr"`	French
`"hu"`	Hungarian
`"id"`	Indonesian
`"it"`	Italian
`"ja"`	Japanese
`"ko"`	Korean
`"nl"`	Dutch, Flemish
`"nn"`	Norwegian Nynorsk
`"no"`	Norwegian
`"pl"`	Polish
`"pt"`	Portuguese
`"ro"`	Romanian, Moldavian, Moldovan
`"ru"`	Russian
`"sk"`	Slovak
`"sl"`	Slovenian
`"sr"`	Serbian
`"sv"`	Swedish
`"tr"`	Turkish
`"uk"`	Ukrainian
`"xh"`	Xhosa
`"zh"`	Chinese

If you specify an unsupported locale, the English version is used. For more information, see List of ISO_639-1 codes on the Wikipedia website.

For an example, see Specify a Locale for Chapter Title Prefixes.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types: char | string

`Debug` — Whether to put report in debug mode
`0` (`false`) (default) | `1` (`true`)

Whether to put the report in debug mode, specified as a logical 1 (true) or 0 (false). When you specify:

1 (true) — Put the report in debug mode. The temporary files for the report are stored in a subfolder of the report folder and are not deleted when the report is closed.
0 (false) — Put the report in regular mode. Temporary files are deleted when the report is closed.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

Data Types: logical

`Layout` — Page layout of report contents
`mlreportgen.report.ReportLayout` object

Page layout of the report contents, specified as an mlreportgen.report.ReportLayout object. The default value of the Layout property is an mlreportgen.report.ReportLayout object with default values. Customize the page layout by modifying the property values. For an example, see Create a Landscape Report.

The layout options specified by the Layout property of objects of the mlreportgen.report.TitlePage, mlreportgen.report.TableOfContents, and mlreportgen.report.Chapter classes can override the page layout properties specified by the Layout property of an mlreportgen.report.Report object.

Note

The Layout property applies only to PDF and Word reports.

Attributes:

`GetAccess`	`public`
`SetAccess`	`protected`

`Document` — DOM document object
`mlreportgen.dom.Document`

DOM document object to use to generate the content of the report, specified as an mlreportgen.dom.Document object.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

`Context` — Report context
`containers.Map` object

Report context, specified as a containers.Map object that contains the information to use to generate the report, such as the hierarchical level of the current report section.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

Methods

expand all

Public Methods

This class uses the same methods as the MATLAB version, mlreportgen.report.Report. Instead of using mlreportgen in the class name, use slreportgen.

`open`	Opens the report
`append`	Add content to report
`add`	(Not recommended) Add content to report
`close`	Close and generate report
`rptview`	Open generated report file in viewer
`mlreportgen.report.Report.createTemplate`	Create report template
`mlreportgen.report.Report.customizeReport`	Create class derived from Report class
`mlreportgen.report.Report.getClassFolder`	Report class definition file location
`getTempPath`	Path of report temporary directory
`generateFileName`	Generate temporary report file name
`getReportLayout`	Current page layout of report
`fill`	Fill report template holes
`getContext`	Get report context value
`setContext`	Set report context value
`ispdf`	Check if PDF report
`isdocx`	Check if Word report
`ishtml`	Check if multifile HTML report
`ishtmlfile`	Check if single-file HTML report

Version History

Introduced in R2017b

expand all

R2025a: Output reports in PDF/A format

You can output DOM and Report API reports in the PDF/A format.

R2020b: `add` method is not recommended

Starting in R2020b, use the append method instead of the add method to add content to objects of these Report API classes:

mlreportgen.report.Report
mlreportgen.report.Chapter
mlreportgen.report.Section
slreportgen.report.Report

To add content to a DOM API object, such as an mlreportgen.dom.Paragraph object, continue to use the append method of the DOM object. The advantage of using append to add content to Report API objects is that you use the same method name as you use to add content to DOM API objects.

There are no plans to remove the add methods of the Report, Chapter, or Section classes. Report API programs that use the add methods will continue to run.

To update existing code, replace the method name add with append as shown by the examples in the table.

Not Recommended	Recommended
import mlreportgen.report.* import mlreportgen.dom.* rpt = Report("My Report","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); add(sect,para); add(ch,sect); add(rpt,ch); close(rpt); rptview(rpt);	import mlreportgen.report.* import mlreportgen.dom.* rpt = Report("My Report","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); append(sect,para); append(ch,sect); append(rpt,ch); close(rpt); rptview(rpt);

Not Recommended

Recommended

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report("My Report","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
add(sect,para);
add(ch,sect);
add(rpt,ch);

close(rpt);
rptview(rpt);

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report("My Report","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
append(sect,para);
append(ch,sect);
append(rpt,ch);

close(rpt);
rptview(rpt);

slreportgen.report.Report Class

Description

Creation

Description

Input Arguments

`outputPath` — Report output path
`untitled.pdf` (default) | character array | string scalar

`type` — Output type of generated report
`"pdf"` (default) | `"pdfa"` | `"html"` | `"html-file"` | `"docx"`

`template` — Location of template to use to format this report
`[]` | string scalar | character array

Properties

`CompileModelBeforeReporting` — Whether to compile the Simulink model before reporting
`1` (`true`) (default) | `0` (`false`)

Attributes:

`OutputPath` — Path of generated report file
`[]` (default) | character vector | string scalar

Attributes:

`Type` — Output type of generated report
`"pdf"` (default) | `"docx"` | `"html"` | `"html-file"` | `"pdfa"`

Attributes:

`PackageType` — Packaging to use for generated files
`[]` (default) | `"zipped"` | `"unzipped"` | `"both"` | `"single-file"`

Attributes:

`TemplatePath` — Location of template to use to format report
`[]` (default) | character vector | string scalar

Attributes:

`Locale` — Locale or language
`[]` (default) | `"af"` | `"ca"` | `"cs"` | ...

Attributes:

`Debug` — Whether to put report in debug mode
`0` (`false`) (default) | `1` (`true`)

Attributes:

`Layout` — Page layout of report contents
`mlreportgen.report.ReportLayout` object

Attributes:

`Document` — DOM document object
`mlreportgen.dom.Document`

Attributes:

`Context` — Report context
`containers.Map` object

Attributes:

Methods

Public Methods

Version History

R2025a: Output reports in PDF/A format

R2020b: `add` method is not recommended

See Also

Topics

slreportgen.report.Report Class

Description

Creation

Description

Input Arguments

outputPath — Report output path untitled.pdf (default) | character array | string scalar

type — Output type of generated report "pdf" (default) | "pdfa" | "html" | "html-file" | "docx"

template — Location of template to use to format this report [] | string scalar | character array

Properties

CompileModelBeforeReporting — Whether to compile the Simulink model before reporting 1 (true) (default) | 0 (false)

Attributes:

OutputPath — Path of generated report file [] (default) | character vector | string scalar

Attributes:

Type — Output type of generated report "pdf" (default) | "docx" | "html" | "html-file" | "pdfa"

Attributes:

PackageType — Packaging to use for generated files [] (default) | "zipped" | "unzipped" | "both" | "single-file"

Attributes:

TemplatePath — Location of template to use to format report [] (default) | character vector | string scalar

Attributes:

Locale — Locale or language [] (default) | "af" | "ca" | "cs" | ...

Attributes:

Debug — Whether to put report in debug mode 0 (false) (default) | 1 (true)

Attributes:

Layout — Page layout of report contents mlreportgen.report.ReportLayout object

Attributes:

Document — DOM document object mlreportgen.dom.Document

Attributes:

Context — Report context containers.Map object

Attributes:

Methods

Public Methods

Version History

R2025a: Output reports in PDF/A format

R2020b: add method is not recommended

See Also

Topics

`outputPath` — Report output path
`untitled.pdf` (default) | character array | string scalar

`type` — Output type of generated report
`"pdf"` (default) | `"pdfa"` | `"html"` | `"html-file"` | `"docx"`

`template` — Location of template to use to format this report
`[]` | string scalar | character array

`CompileModelBeforeReporting` — Whether to compile the Simulink model before reporting
`1` (`true`) (default) | `0` (`false`)

`OutputPath` — Path of generated report file
`[]` (default) | character vector | string scalar

`Type` — Output type of generated report
`"pdf"` (default) | `"docx"` | `"html"` | `"html-file"` | `"pdfa"`

`PackageType` — Packaging to use for generated files
`[]` (default) | `"zipped"` | `"unzipped"` | `"both"` | `"single-file"`

`TemplatePath` — Location of template to use to format report
`[]` (default) | character vector | string scalar

`Locale` — Locale or language
`[]` (default) | `"af"` | `"ca"` | `"cs"` | ...

`Debug` — Whether to put report in debug mode
`0` (`false`) (default) | `1` (`true`)

`Layout` — Page layout of report contents
`mlreportgen.report.ReportLayout` object

`Document` — DOM document object
`mlreportgen.dom.Document`

`Context` — Report context
`containers.Map` object

R2020b: `add` method is not recommended