主要内容

mlreportgen.report.Report类

包:mlreportgen.report

报告的容器

描述

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

mlreportgen.report.Report类是一个处理类。

类属性

HandleCompatible
真正的

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

创建

描述

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

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

例子

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

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

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

属性

全部展开

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

请注意

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

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

价值 万博1manbetx支持的报表类型 描述

“压缩”

“多克斯”“html”

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

“解压缩”

“多克斯”“html”

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

“两个”

“多克斯”“html”

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

“列纵队”

“pdf”html文件的

将报告生成为单个文件。

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

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

  • “pdf”- PDF文件。

  • “html”- HTML报告,打包为一个压缩文件,其中包含HTML文件,图像,样式表和JavaScript®报告文件。要将HTML报告生成为包含解压缩文件的文件夹,请设置PackageType财产“解压缩”“两个”

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

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

属性指定模板TemplatePath属性的值类型必须与模板类型匹配。

的页面布局选项,指定为mlreportgen.report.ReportLayout对象。的初始值布局属性是一个mlreportgen.report.ReportLayout对象,使用默认值。通过修改属性值定制页面布局。有关示例,请参见创建景观报告

控件指定的布局选项布局对象的属性mlreportgen.report.TitlePagemlreportgen.report.TableOfContents,mlreportgen.report.Chapter类所指定的页面布局属性布局的属性mlreportgen.report.Report对象。

请注意

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

区域设置或语言,指定为字符向量或字符串标量,由要为其生成报告的区域设置的ISO_639-1两个字母的语言代码组成。默认值:[],指定系统区域设置的语言,例如在英文系统上为英文。报表API使用语言代码将章节标题前缀转换为指定地区的语言。为以下地区提供翻译:“对焦”“ca”“cs”“哒”“德”“el”“en”“西文”“等”“欧盟”“fi”“fr”‘胡’“id”“它”“ja”“柯”“问”“神经网络”“不”“pl”“pt”“罗”“俄罗斯”“sk”“sl”“老”“sv”“tr”“英国”“xh”,“古银”.如果指定了不受支持的地区,则使用英文版本万博1manbetx。看到https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

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

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

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

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

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

方法

全部展开

例子

全部折叠

使用报表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 =报告(“myreport”“pdf”);rpt.Layout.Landscape = true;

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

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

属性将英文系统上的章节标题前缀翻译为日语语言环境财产。

进口mlreportgen.report。*rpt =报告(“日本报告”);rpt。语言环境=“ja”;House = char(23478);房子的汉字追加(rpt,(房子)章);关闭(rpt);rptview (rpt);

兼容性的考虑

全部展开

不建议从R2020b开始

在R2017b中引入