append

类: mlreportgen.report.Report
命名空间: mlreportgen.report

添加内容以报告

语法

append(report,content)

说明

append(report,content) 将指定的内容添加到报告中。如果报告的状态为 "unopened"，则 append 方法会将状态设置为 "open"，并追加内容。如果报告的状态设置为 "closed"，则 append 方法将返回一条错误消息。

注意

您可以多次将报告器添加到一份报告中，但不能将报告器添加到不同的报告中。例如，如果您将 mlreportgen.report.TitlePage 报告器添加到一份报告，则不能将其添加到另一份报告。

输入参数

全部展开

`report` — 报告
`mlreportgen.report.Report` 对象

报告，指定为 mlreportgen.report.Report 对象。

`content` — 要添加到报告的内容
报告 API 报告器 | DOM 对象 | MATLAB 内置对象

要添加到报告中的内容，指定为报告 API 报告器、DOM 对象或内置的 MATLAB^® 对象。内容可以是报告 API 报告器或可以追加到 DOM 文档的任何对象。可以追加到 DOM 文档的内容包括 DOM 对象和许多内置 MATLAB 对象，例如字符串、字符向量和元胞数组。

示例

全部展开

向报告添加内容

打开实时脚本

此示例使用 append 对象的 mlreportgen.report.Report 方法向报告添加标题页、目录和章节。为了向章节添加内容，该示例使用了 append 对象的 mlreportgen.report.Chapter 方法。

导入 DOM 和 API 包，这样您就不必使用长而完全限定的类名。

import mlreportgen.report.*
import mlreportgen.dom.*;

创建报告并向报告添加标题和目录。

rpt = Report("Magic Square Magic");
append(rpt, TitlePage("Title","Magic Square Magic","Subtitle", ...
    "Inverting a Magic Square","Author","John Doe"));
append(rpt,TableOfContents);

创建章节并向章节添加内容。

ch = Chapter("Magic Moments");
m = magic(5);
append(ch,BaseTable("Title","m = magic(5)","Content", m));
mInverse = m^-1;
append(ch,BaseTable("Title","mInverse = magic(5)^-1","Content", ...
    cellfun(@(x) sprintf("%0.3f", x),num2cell(mInverse), ...
    "UniformOutput", false)));
append(ch,BaseTable("Title", "m*mInverse","Content", ...
    cellfun(@(x) sprintf("%0.3f", x),num2cell(m*mInverse), ...
    "UniformOutput", false)));
append(ch, Paragraph(sprintf("sum(m(1,:)) - sum(m(:,1)) = %d", ...
    sum(m(1,:)) - sum(m(:,1)))));
append(ch, Paragraph(sprintf("sum(mInverse(1,:)) - sum(mInverse(:,1)) = %0.3f", ...
    sum(mInverse(1,:)) - sum(mInverse(:,1)))));

将该章节添加到报告中。

append(rpt,ch);

关闭并查看报告。

close(rpt);
rptview(rpt);

限制

一旦在 report 后追加了 content，就无法再向 content 追加其他内容。

提示

在报告中追加 mlreportgen.dom.Text、mlreportgen.dom.Number、mlreportgen.dom.InternalLink 或 mlreportgen.dom.ExternalLink 对象实例时，对象内容会根据报告格式以不同的方式追加。在 HTML 报告中，内容追加在同一行中。在 PDF 和 DOCX 报告中，内容以单独的行追加。要将内容追加到同一行，请创建一个 mlreportgen.dom.Paragraph 对象，使用 append 方法将内容追加到段落对象，然后将段落对象追加到报告对象。
当您追加一个将 PDF 作为 imagePath 的 mlreportgen.dom.Image 对象时，只会显示图像的第一页。
当您追加一个将 PDF 作为 imagePath 的 mlreportgen.dom.Image 对象时，图像和报告必须使用相同版本的 PDF 文件格式。有关确定 PDF 文件版本的更多信息，请参阅 Adobe 网站上的文档属性和元数据概述。

版本历史记录

在 R2020b 中推出

另请参阅