mlreportgen.report.Report类
包:mlreportgen.report
报告的容器
描述
的对象mlreportgen.report.Report
类是一个基于报表和MATLAB的报表容器®和DOM对象。使用一个mlreportgen.report.Report
对象根据模板库中的模板生成HTML、PDF或Word报表。
的mlreportgen.report.Report
类是一个处理
类。
创建
描述
返回具有默认属性值的报表容器对象。报告
= mlreportgen.report.Report ()
设置OutputPath财产报告
= mlreportgen.report.Report (路径
)路径
.
还设置TemplatePath财产报告
= mlreportgen.report.Report (路径
,类型
,模板
)模板
.
使用名称-值对设置属性。您可以以任意顺序指定多个名称-值对参数。报告
= mlreportgen.report.Report (名称=值
)
属性
OutputPath
- - - - - -生成报表文件的路径
特征向量|字符串标量
生成的报表文件的路径,指定为字符向量或字符串标量。路径是文件系统中存储报表输出文档的位置。路径可以是完整路径,例如,“C: / myreports / reportA.docx”
.路径也可以相对于当前的MATLAB文件夹,例如,“reportA”
.属性对应的文件扩展名类型
属性时,将添加适当的文件扩展名。
请注意
在云驱动器上生成PDF报告,例如MATLAB驱动™,会导致报表生成软件和云驱动器同步软件之间的文件争用导致的错误。若要避免此错误,请在未与云同步的本地驱动器上生成报告。考虑编写一个脚本,在本地驱动器上生成报告,然后将报告复制到云驱动器。
PackageType
- - - - - -为生成的文件打包
“压缩”
|“解压缩”
|“两个”
|“列纵队”
用于生成的文件的打包,指定为表中的值之一。
价值 | 金宝app支持的报表类型 | 描述 |
---|---|---|
|
|
控件指定的位置上以zip文件的形式生成报告 |
“解压缩” |
|
属性的文件夹中以单独文件的形式生成报表 |
“两个” |
|
生成压缩和解压缩的输出。 |
“列纵队” |
|
将报告生成为单个文件。 |
当类型
属性是“html”
,以生成无需解压缩即可打开的HTML报告,请设置PackageType
来“解压缩”
或“两个”
.在包含生成文件的文件夹中,打开root.html
文件。
类型
- - - - - -输出类型
“pdf”
(默认)|“html”
|html文件的
|“多克斯”
输出类型,指定为以下值之一:
“pdf”
- PDF文件。“html”
- HTML报告,打包为一个压缩文件,其中包含HTML文件,图像,样式表和JavaScript®报告文件。要将HTML报告生成为包含解压缩文件的文件夹,请设置PackageType
财产“解压缩”
或“两个”
.html文件的
- HTML报告,由一个HTML文件组成,该文件包含报告的文本、样式表、JavaScript和base64编码的图像。“多克斯”
- - - - - -微软®词文档。
属性指定模板TemplatePath
属性的值类型
必须与模板类型匹配。
布局
- - - - - -页面布局选项
mlreportgen.report.ReportLayout
对象
的页面布局选项,指定为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”
,‘胡’
,“id”
,“它”
,“ja”
,“柯”
,“问”
,“神经网络”
,“不”
,“pl”
,“pt”
,“罗”
,“俄罗斯”
,“sk”
,“sl”
,“老”
,“sv”
,“tr”
,“英国”
,“xh”
,“古银”
.如果指定了不受支持的地区,则使用英文版本金宝app。看到https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.
有关示例,请参见翻译章节标题前缀.
TemplatePath
- - - - - -模板位置
特征向量|字符串标量
用于格式化此报表的模板的位置,指定为字符向量或字符串标量。您可以使用此属性为报表指定自定义模板。
文档
- - - - - -底层DOM文档对象
mlreportgen.dom.Document
底层DOM文档对象,用于生成报告的内容,指定为mlreportgen.dom.Document
对象。此属性是只读的。
上下文
- - - - - -报告内容
容器。地图
对象
报表上下文,指定为容器。地图
对象,该对象包含生成报表的信息,例如当前报表部分的层次结构级别。此属性是只读的。
调试
- - - - - -调试模式
假
或0
(默认)|真正的
或1
调试模式,指定为数字或逻辑模式1
(真正的
)或0
(假
).如果你设置调试
来真正的
或1
时,报表的临时文件存储在报表文件夹的子文件夹中,报表关闭时不会删除。
方法
公共方法
开放 |
打开报告 |
附加 |
向报告添加内容 |
添加 |
(不推荐)添加报表内容 |
关闭 |
关闭并生成报告 |
rptview |
在查看器中打开生成的报告文件 |
mlreportgen.report.Report.createTemplate |
创建报表模板 |
mlreportgen.report.Report.customizeReport |
创建从报表类派生的类 |
mlreportgen.report.Report.getClassFolder |
报表类定义文件位置 |
getTempPath |
报表临时目录路径 |
generateFileName |
生成临时报告文件名 |
getReportLayout |
报告的当前页面布局 |
填满 |
填报表模板孔 |
getContext |
获取报告上下文值 |
setContext |
设置报表上下文值 |
ispdf |
检查PDF报告 |
isdocx |
检查Word报告 |
ishtml |
检查是否有多文件HTML报告 |
ishtmlfile |
检查是否单文件HTML报告 |
例子
创建报表
使用报表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);
版本历史
在R2017b中引入R2020b:添加
方法不推荐使用。
从R2020b开始,使用附加
方法,而不是添加
方法向这些Report API类的对象添加内容:
mlreportgen.report.Report
mlreportgen.report.Chapter
mlreportgen.report.Section
将内容添加到DOM API对象,例如mlreportgen.dom.Paragraph
对象,继续使用附加
DOM对象的方法。使用的好处附加
向Report API对象添加内容的方法之一是使用与向DOM API对象添加内容相同的方法名。
目前还没有计划移除添加
方法报告
,章
,或部分
类。对象的API程序报告添加
方法将继续运行。
若要更新现有代码,请替换方法名称添加
与附加
如表中的例子所示。
不推荐 | 推荐 |
---|---|
进口mlreportgen.report。*进口mlreportgen.dom。*rpt =报告(“我的报告”,“pdf”);ch =章节(“我的章”);Section = Section(“我的部分”);para =段落(“我的内容”);追加(帕拉,“更多内容”);添加(教派,para);添加(ch,教派);add (rpt, ch);关闭(rpt);rptview (rpt); |
进口mlreportgen.report。*进口mlreportgen.dom。*rpt =报告(“我的报告”,“pdf”);ch =章节(“我的章”);Section = Section(“我的部分”);para =段落(“我的内容”);追加(帕拉,“更多内容”);追加(教派,para);追加(ch,教派);追加(rpt, ch);关闭(rpt);rptview (rpt); |
MATLAB命令
你点击了一个对应于这个MATLAB命令的链接:
在MATLAB命令窗口中输入该命令来运行该命令。Web浏览器不支持MATLAB命令。金宝app
您也可以从以下列表中选择一个网站:
如何获得最佳的网站性能
选择中国站点(中文或英文)以获得最佳站点性能。其他MathWorks国家站点没有针对您所在位置的访问进行优化。