主要内容

什么是记者?

记者是Matlab.®添加到a时生成格式化内容的对象MATLAB报告生成器™报告对象。MATLAB报告生成器提供了用于生成公共报告组件的记者,例如标题页,内容表,章节,小节,图和MATLAB变量值。您可以自定义这些记者的内容和外观。您还可以创建自己的记者。有关内置报告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。万博1manbetx每个模板文件包含记者使用的模板库,以格式化其内容。例如,报告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 =报告('myReport','PDF');

创建Reporter的实例

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

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

设置现有记者的属性

要在程序创建报告器后设置报告器属性,该程序可以使用MATLAB点表示法。例如,这段代码设置字幕p的属性TitlePage记者(tp)。

tp.subtitle ='我的项目';tp.pubdate =日期;

将报表添加到报表

要使用Reporter生成内容,请使用该报告程序将Reporter添加到Report对象,使用附加报告对象的方法。的附加方法通过调用GetImpl.那个记者的方法。的GetImpl.方法创建了记者的实现。然后,这附加方法将实现添加到DOM文档用作报表对象的实现的对象。你也可以使用附加将DOM对象添加到报告的方法。但是,您不能添加另一个DOM文档报告。

例如,这段代码添加了标题页报告程序(tp)向报告(RPT.)。

附录(RPT,TP)

关闭报告对象

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

关上(rpt)

此代码是报表的完整程序,仅包含标题页。

导入mlreportgen.report。* RPT =报告('myReport','PDF');tp = Title ('Title','My Report',…“作者”,“约翰·史密斯”);tp.subtitle ='我的项目';tp.pubdate =日期;追加(rpt, tp)关闭(rpt) rptview (rpt)

报告标题页面标题为“我的项目报告”,作者“John Smith”以及日期

另请参阅

|||

相关主题