主要内容

什么是记者?

记者是MATLAB®对象,当添加到MATLAB报告生成器™报告对象。MATLAB报表生成器提供了用于生成常见报表组件的记者,如标题页、目录表、章节、分段、图表和MATLAB变量值。您可以自定义这些记者的内容和外观。您还可以创建自己的记者。对于一个内置的Report API对象列表,输入这个MATLAB命令:

帮助mlreportgen.report

报告器和DOM对象

除了记者,MATLAB报告生成器提供用于生成报告内容的另一组对象。这些对象是文档对象模型(DOM)对象。它们实现了HTML、Word和其他文档创建软件使用的文档模型。该模型将文档定义为文档中常见的对象的层次结构,如文本字符串、段落、图像和表格。DOM API包含生成这些基本文档对象的软件对象。对于DOM对象的列表,输入这个MATLAB命令:

帮助mlreportgen.dom

相比之下,记者创建高级文档结构,如标题页、目录和章节,这些结构出现在许多但不是所有类型的文档中。报告器的优点是单个报告器可以创建需要许多DOM对象的内容。但是,报表生成器程序通常需要DOM和报表对象。例如,章节报告程序生成报告章节的标题和页面布局,但不生成其内容。DOM API提供了文本、段落、表、列表、图像和其他可以用于创建报告内容的对象。

下面的MATLAB程序演示了如何使用报告器和DOM对象创建PDF报告。该程序使用DOM文本对象以向章节添加文本块。本例中的所有其他对象(报告TitlePageTableOfContents,)为报告对象。

rpt = mlreportgen.report.Report(“myreport”、“pdf”);追加(rpt mlreportgen.report。TitlePage('Title','My Report',... 'Author','Myself')) append(rpt,mlreportgen.report.TableOfContents) ch = mlreportgen.report.Chapter('Title','Sample Text'); append(ch,mlreportgen.dom.Text... ('Here is sample text using a DOM Text object.')) append(rpt,ch) close(rpt) rptview(rpt)

报告的标题页,标题为“我的报告”,作者“本人”和日期

目录列出一章

第一章的标题是“样本文本”和文本,“这是使用DOM Text对象的样本文本”。

记者元素

记者通常包括以下要素:

  • 用于定义报表生成的动态内容的外观、固定内容和漏洞的模板文档。报告程序通常提供一组模板文件,针对每种支持的输出类型:Word、PDF和HTML。金宝app每个模板文件都包含一个模版库,报表使用该模版库来格式化其内容。例如,Report APITitlePage记者使用的模板名称为TitlePage排版标题页。的TitlePage模板存储在模板文件的模板库中。您可以修改此模板以重新排列或向标题页添加内容。信息,请参阅模板

  • 属性,该属性指定由报告程序生成的动态内容。这些属性对应于报告器模板中的漏洞。报告程序用相应属性的值填充模板孔。

  • 定义用于创建和操作报告器的报告属性和方法的MATLAB类。报告器类名以前缀开头,mlreportgen.report.例如,标题页的记者是mlreportgen.report.TitlePage.在MATLAB脚本或函数中,你可以通过在脚本或函数的开头插入以下语句来省略前缀:

    进口mlreportgen.report。*
    同样,你也可以包含进口mlreportgen.dom。*使用简短的DOM类名。

  • 构造函数,该方法创建报告对象作为报告类的实例。构造函数的名称与类的名称相同。

  • DOM对象,该对象包含由报表生成的内容。该对象称为报告器的实现。每个记者都有一个getImpl方法创建实现对象,该对象通常是DOMDocumentPart对象。

在MATLAB程序中使用记者

要在报表程序中生成内容,请遵循以下步骤:

这些步骤中描述的示例程序创建了一个只包含标题页的简单文档。但是,这些步骤演示了创建完整报告的任务。完整的程序列表显示在步骤描述之后。

创建报表对象

创建报告对象(mlreportgen.report.Report)以包含由报告生成的内容。报表对象使用DOM文档对象保存添加到报表中的记者生成的内容。这段代码导入Report API包,它允许代码使用简短的类名。然后,它创建一个PDF报告对象(rpt).

进口mlreportgen.report。*rpt= Report('myReport','pdf');

创建Reporter的实例

创建报告类的实例,即使用报告的构造函数实例化报告。构造函数还可以设置它创建的报告对象的属性。例如,这段代码创建一个标题页报告程序(tp),并设置其标题作者属性。

tp = TitlePage('Title','My Report','Author','John Smith');

设置已存在报表报表的属性

要在程序创建报告器后设置报告器属性,该程序可以使用MATLAB点表示法。例如,这段代码设置副标题发布日期的属性TitlePage记者(tp).

tp。Subtitle = 'on My Project';tp。发布日期=日期;

将报表添加到报表

要使用报表生成内容,报表程序必须使用附加方法。的附加方法通过调用getImpl那个记者的方法。的getImpl方法创建报告器的实现。然后,附加方法将实现添加到DOM文档对象,该对象充当报表对象的实现。你也可以用the附加方法将DOM对象添加到报表中。但是,您不能添加另一个DOM文档一份报告。

例如,这段代码添加了标题页报告程序(tp)提交报告(rpt).

追加(rpt, tp)

关闭报表对象

当报表程序完成向报表添加内容时,它必须使用关闭方法。关闭报表将报表内容写入由报表对象的构造函数指定的类型(如PDF)的文档文件。

关上(rpt)

这段代码是报告的完整程序,它只包含一个标题页。

进口mlreportgen.report。*rpt= Report('myReport','pdf'); tp = TitlePage('Title','My Report',... 'Author','John Smith'); tp.Subtitle = 'on My Project'; tp.PubDate = date; append(rpt,tp) close(rpt) rptview(rpt)

报告标题页,标题为“我的项目报告”,作者“约翰·史密斯”,日期

另请参阅

|||

相关的话题