主要内容

mlreportgen.report.report类

包裹:mlreportgen.report

报表容器

描述

一件物品mlreportgen.report.Report类是基于reporters和MATLAB的报告的容器®和DOM对象。使用mlreportgen.report.Report对象以基于模板库中的模板生成HTML、PDF或Word报告。

这个mlreportgen.report.Report类是一个手柄类。

类属性

易懂的
真的

有关类属性的信息,请参见类属性

创建

描述

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

报告=mlreportgen.report.report(路径)设定OutputPath财产路径

例子

报告=mlreportgen.report.report(路径,类型)还设置了类型财产类型

报告=mlreportgen.report.report(路径,类型,模板)还设置了模板路径财产模板

报告=mlreportgen.report.report(名称、值)使用名称-值对设置属性。可以以任意顺序指定多个名称-值对参数。将每个属性名用单引号或双引号括起来。

属性

全部展开

生成的报表文件的路径,指定为字符向量或字符串标量。该路径是文件系统中存储报表输出文档的位置。该路径可以是完整路径,例如,“C: / myreports / reportA.docx”.路径也可以相对于当前的MATLAB文件夹,例如:“报告A”.如果文件名没有对应的文件扩展名类型属性时,将添加适当的文件扩展名。

在云驱动器上生成PDF报告,例如MATLAB驱动™,可能会导致由报告生成软件和云驱动器同步软件之间的文件争用引起的错误。要避免此错误,请在不与云同步的本地驱动器上生成报告。考虑编写一个脚本,该脚本在本地驱动器上生成报告,然后将报表复制到云驱动器。

用于生成文件的打包,指定为表中的值之一。

价值 金宝app支持报告类型 描述

“压缩”

“多克斯”“html”

控件指定的位置以zip文件的形式生成报告OutputPath财产。zip文件的扩展名与文档类型匹配(多克斯用于字输出或htmtx对于HTML输出。)例如,如果文档类型为多克斯OutputPaths: \ docs \ MyDoc,输出打包在名为s:\docs\MyDoc.docx

“解压缩”

“多克斯”“html”

在文件名为的文件夹中以单独文件的形式生成报告OutputPath财产。例如,如果OutputPaths: \ docs \ MyDoc,则输出文件夹为s: \ docs \ MyDoc

“都是”

“多克斯”“html”

生成压缩和解压缩的输出。

“列纵队”

“pdf”html文件的

将报告生成为单个文件。

类型属性是“html”,以生成无需解压即可打开的HTML报告,请设置包装类型“解压缩”“都是”. 在包含生成的文件的文件夹中,打开root.html文件。

输出类型,指定为以下值之一:

  • “pdf”–PDF文件。

  • “html”- HTML报告,打包成包含HTML文件、图像、样式表和JavaScript的压缩文件®要将HTML报告生成为包含解压缩文件的文件夹,请设置包装类型财产“解压缩”“都是”

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

  • “多克斯”微软®文档。

如果使用模板路径属性的值类型必须与模板类型匹配。

为该报告指定的页面布局选项mlreportgen.report.ReportLayout对象的初始值布局财产是一种财富mlreportgen.report.ReportLayout具有默认值的对象。通过修改属性值自定义页面布局。有关示例,请参见创建横向报告

指定的布局选项布局对象的属性mlreportgen.report.TitlePage,mlreportgen.report.TableOfContents,及mlreportgen.report.Chapter属性指定的页面布局属性布局财产mlreportgen.report.Report对象。

这个布局属性仅适用于PDF和Word报表。

区域设置或语言,指定为字符向量或字符串标量,由要生成此报告的区域设置的ISO_639-1两个字母的语言代码组成。默认值,[],指定系统区域设置的语言,例如,英语系统上的英语。报表API使用语言代码将章节标题前缀翻译为指定区域的语言。提供了以下地区的翻译:“对焦”,“ca”,“cs”,“爸爸”,“德”,“el”,“en”,“西文”,“等”,“欧盟”,“fi”,“fr”,‘胡’,“身份证”,“它”,“是的”,“高”,“nl”,“nn”,“不”,“pl”,“pt”,“罗”,“汝”,“sk”,“sl”,“sr”,“sv”,“tr”,“英国”,“xh”,及‘zh’.如果指定不受支持的地区,则使用英文版本。金宝app看到https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

有关示例,请参见翻译章节标题前缀

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

用于生成报告内容的基础DOM文档对象,指定为mlreportgen.dom.Document对象。此属性是只读的。

报告上下文,指定为容器。地图对象,该对象包含生成报表的信息,例如当前报表部分的层次结构级别。此属性是只读的。

调试模式,指定为数字或逻辑模式1.(真的)或0(假的).如果你调试真的1.时,报表的临时文件存储在报表文件夹的子文件夹中,在报表关闭时不会删除。

方法

全部展开

例子

全部崩溃

使用report API创建一个报告。

导入DOM和Report API包,这样就不必使用长且完全限定的类名。

进口mlreportgen.report。*进口mlreportgen.dom。*

创建报表容器。

rpt =报告(“我的报告”,“pdf”);

向报告中添加标题页、目录和章节。本章包含两个部分,每个部分都包含一个图像。

追加(rpt TitlePage (“标题”,“我的报告”));追加(rpt TableOfContents);ch =章(“图片”);追加(ch,部分(“标题”,“波音747”,...“内容”,图像(哪个(‘b747.jpg’))));追加(ch,部分(“标题”,“辣椒”,...“内容”,图像(哪个(“peppers.png”))));追加(rpt, ch);关闭(rpt);rptview (rpt);

使用report API创建一个横向的报表。

导入Report API包,这样您就不必使用长且完全限定的类名。

进口mlreportgen.report。*

创建报表容器。在mlreportgen.report.ReportLayout指定给对象的对象布局属性,设置景观财产真的

rpt =报告(“我的报告”,“pdf”);rpt.Layout.Landscape = true;

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

追加(rpt TitlePage (“标题”,“我的景观报告”));追加(rpt TableOfContents);追加(rpt,章(“标题”,“测试”)); 附加(摘录,第章)(“标题”,“单元测试”)); 关闭(rpt);rptview(rpt);

翻译章标题前缀为日语在英语系统上设置场所财产。

进口mlreportgen.report。*rpt =报告(“日本报告”);rpt。语言环境=“是的”;房子= char (23478);%房屋汉字附加(rpt,第章(众议院));关闭(rpt);rptview(rpt);

兼容性考虑

全部展开

不建议从R2020b开始

在R2017b中引入