主要内容

记者是什么?

记者是MATLAB®类时生成格式化内容的对象MATLAB报表生成器报告对象。MATLAB Report Generator提供了用于生成常见报表组件的报表,如标题页、目录、章节、子节、图形和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文本对象的示例文本”。

记者元素

报告器通常包括以下元素:

  • 定义报表生成的动态内容的外观、固定内容和孔的模板文档。报表通常提供一组模板文件,每个模板文件对应支持的输出类型:Word、PDF和HTML。万博1manbetx每个模板文件都包含一个模板库,报表使用这些模板对其内容进行格式化。例如,报表APITitlePage报表使用名为TitlePage格式化标题页。的TitlePage模板存储在模板文件的模板库中。您可以修改此模板以重新排列或向标题页添加内容。有关信息,请参见模板

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

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

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

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

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

在MATLAB程序中使用报告器

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

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

创建报表对象

创建一个Report对象(mlreportgen.report.Report),以载列报告所产生的内容。报表对象使用DOM文档对象保存添加到报表的报表生成的内容。此代码导入Report API包,该包允许代码使用短类名。然后,它创建一个PDF报表对象(rpt).

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

创建报表的实例

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

tp = TitlePage('标题','我的报告','作者','约翰·史密斯');

设置已存在报表的属性

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

tp。字幕= 'on My Project';tp。PubDate =日期;

将报表添加到报表

方法将报表对象添加到报表对象中,以使用报表程序生成内容附加方法。的附加方法通过调用getImpl记者的方法。的getImpl方法创建报告程序的实现。然后,附加方法将实现添加到DOM文档对象,该对象用作报表对象的实现。你也可以使用附加方法将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)

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

另请参阅

|||

相关的话题