slreportgen.report.Report 类

命名空间: slreportgen.report

报告容器

描述

slreportgen.report.Report是一个容器，用于存储由Simulink^®报告器和DOM对象组成的报告。使用此对象根据模板库中的模板生成 HTML、PDF 或 Word 报告。

注意

使用此类对象（而不是 mlreportgen.report.Report）来创建 Simulink 报告，这些报告使用 Simulink 报告器生成内容。您还可以使用 MATLAB^® 报告器和 DOM 对象来生成 Simulink 报告内容。

slreportgen.report.Report 类是 handle 类。

创建对象

描述

report = slreportgen.report.Report 返回具有默认报告类型(PDF)和默认文件名(untitled.pdf)的报告对象报告。

report = slreportgen.report.Report(path) 使用指定的输出 path 进行报告。

report = slreportgen.report.Report(path,type) 创建报告的指定 type。

report = slreportgen.report.Report(path,type,template) 使用指定的模板。

report = slreportgen.report.Report(Name=Value) 使用名称-值参量设置属性。您可以按任意顺序指定多个名称-值参量。

输入参量

全部展开

`path` — 报告输出路径
`untitled.pdf` (默认) | 字符串 | 字符数组

请参阅 OutputPath 属性。

`type` — 报告输出类型
`"pdf"` (默认) | `"pdfa"` | `"html"` | `"html-file"` | `"docx"`

请参阅 Type 属性。

`template` — 报告模板
字符串 | 字符数组

请参阅 TemplatePath 属性。

属性

全部展开

`CompileModelBeforeReporting` — 在报告之前是否编译 Simulink 模型
`true` (默认) | `false`

在报告之前是否编译 Simulink 模型，指定为逻辑值 true 或 false。如果此属性为 true（默认值），则向此报告添加一个报告模型的报告器会导致尚未编译的模型被编译。如果无法编译模型，报告生成将终止。false 值允许在不编译模型的情况下继续生成报告。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: logical

`OutputPath` — 生成的报告文件的路径
字符向量 | 字符串标量

生成的报告文件的路径，指定为字符向量或字符串标量。路径是报告输出文档在文件系统中的位置。路径可以是完整路径，例如 "C:/myreports/reportA.docx"。路径也可以相对于当前的 MATLAB 文件夹，例如 "reportA"。如果文件名没有与 Type 属性相对应的文件扩展名，报告生成器会在关闭报告文档时添加相应的文件扩展名。

注意

在云驱动器（例如 MATLAB Drive™ 或 Microsoft^® OneDrive™）上生成 PDF 报告可能会导致报告生成软件与云驱动器同步软件之间发生文件冲突，从而导致以下错误：

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.

为避免此问题，请在不与云同步的本地驱动器上生成报告。考虑编写一个脚本，在本地驱动器上生成报告，然后将报告复制到云端驱动器。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`Type` — 输出类型
`"pdf"` (默认) | `"docx"` | `"html"` | `"html-file"` | `"pdfa"`

输出类型，指定为以下值之一：

"docx" - Microsoft Word 文档。
"html" - HTML 报告，打包为一个压缩文件，包含报告的 HTML 文件、图像、样式表和 JavaScript^® 文件。要生成一个包含解压缩文件的文件夹作为 HTML 报告，请将 PackageType 属性设置为 "unzipped" 或 "both"。
"html-file" - HTML 报告，由一个 HTML 文件组成，该文件包含报告的文本、样式表、JavaScript 和 base64 编码的图像。
"pdf" - PDF 文件。
"pdfa" - PDF/A 文件。 (自 R2025a 起)

如果使用 TemplatePath 属性指定模板，则 Type 的值必须与模板类型匹配。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`PackageType` — 用于生成文件的打包格式
`"zipped"` (默认) | `"unzipped"` | `"both"` | `"single-file"`

用于生成文件的打包格式，指定为以下值之一：

值	支持的报告类型	描述
`"zipped"`	`"docx"` `"html"`	将报告作为 ZIP 文件生成到 `OutputPath` 属性指定的位置。ZIP 文件的扩展名与文档类型匹配（Word 输出为 `.docx`，HTML 输出为 `.htmtx`。）例如，如果文档类型为 `"docx"`，且 `OutputPath` 对应的类型为 `s:\docs\MyDoc`，则输出将以 ZIP 文件形式保存，文件名为 `s:\docs\MyDoc.docx`。
`"unzipped"`	`"docx"` `"html"`	将报告作为单独的文件生成在具有 `OutputPath` 属性文件名的文件夹中。例如，如果 `OutputPath` 是 `s:\docs\MyDoc`，则输出文件夹是 `s:\docs\MyDoc`。
`"both"`	`"docx"` `"html"`	生成压缩和解压缩的输出。
`"single-file"`	`"html-file"` `"pdf"` `"pdfa"` (自 R2025a 起)	将报告生成为单个文件。

提示

要生成一个无需解压缩即可打开的 HTML 报告，当 Type 属性为 "html" 时，将 PackageType 设置为 "unzipped" 或 "both"。在包含生成文件的文件夹中，打开 root.html 文件。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`true`

数据类型: char | string

`TemplatePath` — 用于格式化报告的模板位置
字符向量 | 字符串标量

用于格式化此报告的模板位置，指定为字符向量或字符串标量。您可以使用此属性为报告指定自定义模板。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`Locale` — 区域设置或语言
`[]` (默认) | `"af"` | `"ca"` | `"cs"` | ...

语言环境或语言，指定为字符向量或字符串标量，由要生成此报告的语言环境的 ISO_639-1 两字母语言代码组成。默认值 [] 指定系统区域设置的语言，例如，在英语系统上为英语。报告 API 使用语言代码将章节标题前缀翻译为指定语言环境的语言。以下语言的翻译已提供：

"af"
"ca"
"cs"
"da"
"de"
"el"
"en"
"es"
"et"
"eu"
"fi"
"fr"
"hu"
"id"
"it"
"ja"
"ko"
"nl"
"nn"
"no"
"pl"
"pt"
"ro"
"ru"
"sk"
"sl"
"sr"
"sv"
"tr"
"uk"
"xh"
"zh"

.如果您指定不受支持的区域设置，则使用英语版本。如需详细信息，请参阅 Wikipedia 网站上的ISO_639-1 代码列表。

有关示例，请参阅指定章节标题前缀的区域设置。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`Debug` — 调试模式
`false` 或 `0` (默认) | `true` 或 `1`

调试模式，指定为数字或逻辑值 1 (true) 或 0 (false)。如果将 Debug 设置为 true 或 1，则报告的临时文件将存储在报告文件夹的子文件夹中，并在关闭报告时不会被删除。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: logical

`Layout` — 页面布局选项
`mlreportgen.report.ReportLayout` 对象

此报告的页面布局选项，指定为 mlreportgen.report.ReportLayout 对象。Layout 属性的默认值是一个具有默认值的 mlreportgen.report.ReportLayout 对象。通过修改属性值来自定义页面布局。有关示例，请参阅创建景观报告。

mlreportgen.report.TitlePage、mlreportgen.report.TableOfContents 和 mlreportgen.report.Chapter 类对象的 Layout 属性指定的布局选项可以覆盖 mlreportgen.report.Report 对象的 Layout 属性指定的页面布局属性。

注意

Layout 属性仅适用于 PDF 和 Word 报告。

属性：

`GetAccess`	`公共`
`SetAccess`	`受保护`

`Document` — DOM 文档对象
`mlreportgen.dom.Document`

用于生成报告内容的 DOM 文档对象，指定为 mlreportgen.dom.Document 对象。

属性：

`GetAccess`	`公共`
`SetAccess`	`私有`

`Context` — 报告上下文
`containers.Map` 对象

报告上下文，指定为 containers.Map 对象，其中包含用于生成报告的信息，例如当前报告部分的层次级别。

属性：

`GetAccess`	`公共`
`SetAccess`	`私有`

方法

全部展开

公共方法

此类使用与 MATLAB 版本 mlreportgen.report.Report 相同的方法。不要在类名中使用 mlreportgen，而要使用 slreportgen。

`open`	打开报告
`append`	添加内容以报告
`add`	（不推荐）添加要报告的内容
`close`	关闭并生成报告
`rptview`	在查看器中打开生成的报告文件
`mlreportgen.report.Report.createTemplate`	创建报告模板
`mlreportgen.report.Report.customizeReport`	创建从报告类派生的类
`mlreportgen.report.Report.getClassFolder`	报告类定义文件位置
`getTempPath`	报告临时目录路径
`generateFileName`	生成临时报告文件名
`getReportLayout`	报告的当前页面布局
`fill`	填补报告模板空位
`getContext`	获取报告上下文值
`setContext`	设置报告上下文值
`ispdf`	检查 PDF 报告
`isdocx`	检查 Word 报告
`ishtml`	检查多文件 HTML 报告
`ishtmlfile`	检查单文件 HTML 报告

版本历史记录

在 R2017b 中推出

全部展开

R2025a: 以 PDF/A 格式输出报告

您可以以 PDF/A 格式输出 DOM 和报告 API 报告。

R2020b: `add` 方法不推荐

从 R2020b 开始，使用 append 方法（而不是 add 方法）向这些报告 API 类的对象添加内容：

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

要向 DOM API 对象添加内容（例如 mlreportgen.dom.Paragraph 对象），请继续使用 DOM 对象的 append 方法。使用 append 向报告 API 对象添加内容的优势在于，您使用与向 DOM API 对象添加内容相同的方法名称。

没有计划删除 Report、Chapter 或 Section 类的 add 方法。使用 add 方法的报告 API 程序将继续运行。

要更新现有代码，请将方法名称 add 替换为 append，如表中示例所示。

不建议使用	推荐
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 类

描述

创建对象

描述

输入参量

path — 报告输出路径 untitled.pdf (默认) | 字符串 | 字符数组

type — 报告输出类型 "pdf" (默认) | "pdfa" | "html" | "html-file" | "docx"

template — 报告模板 字符串 | 字符数组

属性

CompileModelBeforeReporting — 在报告之前是否编译 Simulink 模型 true (默认) | false

属性：

OutputPath — 生成的报告文件的路径 字符向量 | 字符串标量

属性：

Type — 输出类型 "pdf" (默认) | "docx" | "html" | "html-file" | "pdfa"

属性：

PackageType — 用于生成文件的打包格式 "zipped" (默认) | "unzipped" | "both" | "single-file"

属性：

TemplatePath — 用于格式化报告的模板位置 字符向量 | 字符串标量

属性：

Locale — 区域设置或语言 [] (默认) | "af" | "ca" | "cs" | ...

属性：

Debug — 调试模式 false 或 0 (默认) | true 或 1

属性：

Layout — 页面布局选项 mlreportgen.report.ReportLayout 对象

属性：

Document — DOM 文档对象 mlreportgen.dom.Document

属性：

Context — 报告上下文 containers.Map 对象

属性：

方法

公共方法

版本历史记录

R2025a: 以 PDF/A 格式输出报告

R2020b: add 方法不推荐

另请参阅

主题

`path` — 报告输出路径
`untitled.pdf` (默认) | 字符串 | 字符数组

`type` — 报告输出类型
`"pdf"` (默认) | `"pdfa"` | `"html"` | `"html-file"` | `"docx"`

`template` — 报告模板
字符串 | 字符数组

`CompileModelBeforeReporting` — 在报告之前是否编译 Simulink 模型
`true` (默认) | `false`

`OutputPath` — 生成的报告文件的路径
字符向量 | 字符串标量

`Type` — 输出类型
`"pdf"` (默认) | `"docx"` | `"html"` | `"html-file"` | `"pdfa"`

`PackageType` — 用于生成文件的打包格式
`"zipped"` (默认) | `"unzipped"` | `"both"` | `"single-file"`

`TemplatePath` — 用于格式化报告的模板位置
字符向量 | 字符串标量

`Locale` — 区域设置或语言
`[]` (默认) | `"af"` | `"ca"` | `"cs"` | ...

`Debug` — 调试模式
`false` 或 `0` (默认) | `true` 或 `1`

`Layout` — 页面布局选项
`mlreportgen.report.ReportLayout` 对象

`Document` — DOM 文档对象
`mlreportgen.dom.Document`

`Context` — 报告上下文
`containers.Map` 对象

R2020b: `add` 方法不推荐