主要内容

什么是记者?

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

帮助mlreportgen.report

记者和DOM对象

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

帮助mlreportgen.dom

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

以下MATLAB程序使用记者和DOM对象说明了创建PDF报告。该程序使用DOM文本对象将文本块添加到章节中。此示例中的所有其他对象(报告titlePage.目录,)是记者对象。

RPT = mlreportgen.report.report('myReport','pdf');附加(RPT,MLREPORTGEN.REPORT.TITLEPAGE('title','我的报告',...'作者','我自己'))附加(RPT,mlreportgen.report.tableofcontents)ch = mlreportgen.report.chapter('标题','示例文本');附加(ch,mlreportgen.dom.text ...('这里是使用DOM Text对象的示例文本))附加(RPT,CH)关闭(RPT)RPTVIEW(RPT)

报告的标题页面标题为“我的报告”,作者“我自己”和日期

列表一章的目录

第一章的标题是

记者元素

记者通常包括以下元素:

  • 模板文档定义了记者生成的动态内容的外观、固定内容和漏洞。报告者通常提供一组模板文件,分别对应于受支持的输出类型:Word、PDF和HTML。金宝app每个模板文件包含一个模板库,该模板库用于格式化其内容。例如,报告APItitlePage.Reporter使用名为titlePage.格式化标题页。这titlePage.模板存储在其模板文件的模板库中。您可以修改此模板以重新排列或将内容添加到标题页面。有关信息,请参阅模板

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

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

    进口mlreportgen.report。*
    同样,您可以包括进口mlreportgen.dom。*使用短DOM类名称。

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

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

在MATLAB程序中使用记者

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

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

创建报表对象

创建一个报表对象(mlreportgen.report.Report)包含报告生成的内容。报告对象使用DOM文档对象以保存由报告管理器生成的内容添加到报告中。此代码导入报告API包,这使得代码能够使用短类名称。然后,它创建了PDF报告对象(RPT.).

导入mlreportgen.report。* RPT =报告('myReport','PDF');

创建报告者的实例

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

tp = titlepage('title','我的报告','作者','John Smith');

设置已有报表的属性

要在程序创建报告管理员后设置Reporter属性,程序可以使用MATLAB点表示法。例如,此代码设置了副标题发布日期a的属性titlePage.记者(TP.).

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

将记者添加到报告

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

例如,此代码添加标题页报告器(TP.)提交报告(RPT.).

追加(rpt, tp)

关闭报告对象

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

关闭(RPT)

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

导入mlreportgen.report。* RPT =报告('myReport','PDF');tp = titlepage('title','我的报告',...'作者','John Smith');tp.subtitle ='我的项目';tp.pubdate =日期;附录(RPT,TP)关闭(RPT)RPTVIEW(RPT)

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

也可以看看

|||

相关话题