mlreportgen.report.Reportclass
包:mlreportgen.report
报告的容器
描述
一个对象的mlreportgen.report.Report
类是一个基于报告记者和MATLAB的容器®和DOM对象。使用一个mlreportgen.report.Report
对象来生成一个HTML、PDF或字的报告基于模板的模板库。
的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
- - - - - -包装为生成的文件
“压缩”
|“解压缩”
|“两个”
|“列纵队”
包装用于生成的文件,表中指定的值。
价值 | 万博1manbetx支持报告类型 | 描述 |
---|---|---|
|
|
生成的报告作为一个压缩文件,在指定的位置 |
“解压缩” |
|
生成报告作为单独的文件在一个文件夹的文件名称 |
“两个” |
|
生成压缩和解压输出。 |
“列纵队” |
|
生成的报告作为一个单独的文件。 |
当类型
属性是“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和文字报告。
语言环境
- - - - - -地区或语言
[]
(默认)|特征向量|字符串标量
地区或语言,指定为一个特征向量或字符串标量,由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。
例如,看到的翻译章标题前缀。
TemplatePath
- - - - - -模板的位置
特征向量|字符串标量
这份报告模板用于格式化的位置,指定为一个特征向量或字符串标量。您可以使用这个属性来指定一个自定义报告的模板。
文档
- - - - - -潜在的DOM文档对象
mlreportgen.dom.Document
潜在的DOM文档对象用于生成报告的内容,指定为一个mlreportgen.dom.Document
对象。这个属性是只读的。
上下文
- - - - - -报告内容
containers.Map
对象
报告内容,指定为一个containers.Map
对象包含信息生成报告,如当前报告部分的层次水平。这个属性是只读的。
调试
- - - - - -调试模式
假
或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 |
检查单词是否报告 |
ishtml |
检查是否多文件的HTML报告 |
ishtmlfile |
检查单个文件的HTML报告 |
例子
创建一个报告
使用报告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);
版本历史
介绍了R2017bR2020b:添加
方法是不可取的
从R2020b,使用附加
方法,而不是添加
方法将内容添加到这些报告API类的对象:
mlreportgen.report.Report
mlreportgen.report.Chapter
mlreportgen.report.Section
将内容添加到一个DOM API对象,比如一个mlreportgen.dom.Paragraph
对象,继续使用附加
DOM对象的方法。使用的优势附加
将内容添加到报告API对象是你使用相同的方法名使用DOM API将内容添加到对象。
没有删除的计划添加
的方法报告
,章
,或部分
类。报告API使用的程序添加
方法将继续运行。
更新现有的代码,替换方法名添加
与附加
由表中的示例所示。
不推荐 | 推荐 |
---|---|
进口mlreportgen.report。*进口mlreportgen.dom。*rpt =报告(“我的报告”,“pdf”);ch =章(“我的章”);教派=节(“我的部分”);帕拉=段(“我的内容”);追加(帕拉,“更多内容”);添加(教派,para);添加(ch,教派);add (rpt, ch);关闭(rpt);rptview (rpt); |
进口mlreportgen.report。*进口mlreportgen.dom。*rpt =报告(“我的报告”,“pdf”);ch =章(“我的章”);教派=节(“我的部分”);帕拉=段(“我的内容”);追加(帕拉,“更多内容”);追加(教派,para);追加(ch,教派);追加(rpt, ch);关闭(rpt);rptview (rpt); |
第一de MATLAB
Ha事实clic en联合国围绕此时一个埃斯特第一de MATLAB:
Ejecute el第一introduciendolo en la ventana de第一de MATLAB。洛杉矶navegadores网络没有admiten第一de MATLAB。
你也可以从下面的列表中选择一个网站:
表现最好的网站怎么走吗
选择中国网站(中文或英文)最佳站点的性能。其他MathWorks国家网站不优化的访问你的位置。