主要内容

mlreportgen.report.Reportclass

包:mlreportgen.report

报告的容器

描述

一个对象的mlreportgen.report.Report类是一个基于报告记者和MATLAB的容器®和DOM对象。使用一个mlreportgen.report.Report对象来生成一个HTML、PDF或字的报告基于模板的模板库。

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”

生成的报告作为一个压缩文件,在指定的位置OutputPath财产。zip文件的扩展相匹配的文档类型(多克斯字输出或htmtx对于HTML输出。)例如,如果文档类型多克斯OutputPaths: \ docs \ MyDoc,输出是打包成一个zip文件命名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.TitlePage,mlreportgen.report.TableOfContents,mlreportgen.report.Chapter类可以覆盖页面布局属性指定的布局财产的mlreportgen.report.Report对象。

请注意

布局属性仅适用于PDF和文字报告。

地区或语言,指定为一个特征向量或字符串标量,由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对象。这个属性是只读的。

报告内容,指定为一个containers.Map对象包含信息生成报告,如当前报告部分的层次水平。这个属性是只读的。

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

方法

全部展开

例子

全部折叠

使用报告API创建一个报告。

进口DOM API包和报告,所以你不需要使用长,完全限定类名。

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

创建报告的容器。

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

添加一个标题页、目录、章节。这一章包含两个部分,每个包含一个图像。

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

创建一个报告,横向通过使用报告API。

导入报告API包,所以你不需要使用长,完全限定类名。

进口mlreportgen.report。*

容器创建一个报告。在mlreportgen.report.ReportLayout分配给对象布局属性,设置景观财产真正的

rpt =报告(“myreport”,“pdf”);rpt.Layout。景观= true;

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

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

日本在英文翻译章标题前缀系统通过设置语言环境财产。

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

版本历史

介绍了R2017b

全部展开