本页采用了机器翻译。点击此处可查看英文原文。

mlreportgen.report.Report 类

命名空间: mlreportgen.report

报告容器

全页展开

描述

mlreportgen.report.Report 类的一个对象是一个报告容器，由报告器、MATLAB® 和 DOM 对象组成。使用 mlreportgen.report.Report 对象根据模板库中的模板生成 HTML、PDF 或 Word 报告。

注意

要创建包含 Simulink® 或 Stateflow® 内容的报告，请使用 slreportgen.report.Report (Simulink Report Generator) 类。

mlreportgen.report.Report 类是一个 handle 类。

类属性

HandleCompatible
true

有关类属性的信息，请参阅类属性。

创建对象

描述

report = mlreportgen.report.Report 返回具有默认属性值的报告容器对象。

report = mlreportgen.report.Report(outputPath) 将 OutputPath 属性设置为 outputPath。

report = mlreportgen.report.Report(outputPath,type) 还将 Type 属性设置为 type。

示例

report = mlreportgen.report.Report(outputPath,type,template) 还将 TemplatePath 属性设置为 template。

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

输入参量

全部展开

报告输出路径，指定为字符向量或字符串标量。

示例: "myReport.pdf"

数据类型: char | string

生成的报告的输出类型，请指定以下值之一：

  • "docx" - Microsoft® Word 文档。

  • "html" - HTML 报告，打包为一个压缩文件，包含报告的 HTML 文件、图像、样式表和 JavaScript® 文件。要将 HTML 报告生成为包含解压文件的文件夹，请将 PackageType 属性设置为 "unzipped" 或 "both"。

  • "html-file" - HTML 报告，由一个 HTML 文件组成，该文件包含报告的文本、样式表、JavaScript 和 base64 编码的图像。

  • "pdf" - PDF 文件。

  • "pdfa" - PDF/A 文件。 (自 R2025a 起)

数据类型: char | string

用于格式化此报告的模板的位置，指定为字符向量或字符串标量。使用此参量为报告指定自定义模板。模板类型必须与报告输出类型一致。

数据类型: char | string

属性

全部展开

生成的报告文件的路径，指定为字符向量或字符串标量。路径是报告输出文档在文件系统中的位置。该路径可以是完整路径，例如 "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
public
SetAccess
public

数据类型: char | string

生成的报告的输出类型，请指定以下值之一：

  • "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
public
SetAccess
public

数据类型: char | string

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

值支持的报告类型描述

"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
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

区域设置或语言，指定为字符向量或字符串标量，由要生成此报告的区域设置的 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"

中文

如果您指定不受支持的区域设置，则使用英语版本。如需更多信息，请参阅维基百科网站上的 ISO_639-1 代码列表。

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

是否将报告设置为调试模式，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

  • 1 (true) - 将报告设置为调试模式。该报告的临时文件存储在报告文件夹的一个子文件夹中，关闭报告时不会被删除。

  • 0 (false) - 将报告设为常规模式。关闭报告时，临时文件将被删除。

属性：

GetAccess
public
SetAccess
public

数据类型: logical

报告内容的页面布局，指定为 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
public
SetAccess
protected

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

属性：

GetAccess
public
SetAccess
private

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

属性：

GetAccess
public
SetAccess
private

方法

全部展开

示例

全部折叠

打开实时脚本

使用报告 API 创建报告。

导入 DOM 和报告 API 命名空间，这样您就不必使用完全限定的类名。

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

创建报告容器。

rpt = Report('My Report','pdf');

在报告中添加标题页、目录和章节。本章包含两节，每节包含一张图片。

append(rpt,TitlePage(Title='My Report'));
append(rpt,TableOfContents);
ch = Chapter('Images');
append(ch,Section(Title='Boeing 747',...
    Content=Image(which('b747.jpg'))));
append(ch,Section(Title='Peppers',...
    Content=Image(which('peppers.png'))));
append(rpt,ch);
close(rpt);
rptview(rpt);

使用报告 API 创建具有横向方向的报告。

导入报告 API 命名空间，这样您就不必使用长而完全限定的类名。

import mlreportgen.report.*

创建报告容器。在分配给 Layout 属性的 mlreportgen.report.ReportLayout 对象中，将 Landscape 属性设置为 true。

rpt = Report("myreport","pdf");
rpt.Layout.Landscape = true;

向报告添加内容。生成并查看报告。

append(rpt,TitlePage(Title="My Landscape Report"));
append(rpt,TableOfContents);
append(rpt,Chapter(Title="Tests"));
append(rpt,Chapter(Title="Unit Tests"));
close(rpt);
rptview(rpt);

通过设置 Locale 属性，将报告的章节标题前缀设置为日语。

import mlreportgen.report.*
rpt = Report("Japanese Report");
rpt.Locale = "ja";
house = char(23478); % Kanji character for house
append(rpt, Chapter(house));
close(rpt);
rptview(rpt);

版本历史记录

在 R2017b 中推出

全部展开

另请参阅

主题