append

Class: mlreportgen.report.Report
Namespace: mlreportgen.report

Add content to report

Syntax

append(report,content)


Description

append(report,content) adds the specified content to the report. If the status of the report is "unopened", the append method sets the status to "open" and appends the content. If the status of the report is set to "closed", the append method returns an error message.

Note

You can add a reporter to a report multiple times, but you cannot add the reporter to different reports. For example, if you add an mlreportgen.report.TitlePage reporter to one report, you cannot add it to another report.

Input Arguments

report — Report

mlreportgen.report.Report object

Report, specified as a mlreportgen.report.Report object.

content — Content to add to report

Report API reporter | DOM object | MATLAB built-in object

Content to add to report, specified as a Report API reporter, DOM object, or built-in MATLAB^® object. The content can be a Report API reporter or any object that you can append to a DOM document. Content that you can append to a DOM document includes DOM objects and many built-in MATLAB objects, such as strings, character vectors, and cell arrays.

Examples

Add Content to a Report

This example adds a title page, table of contents, and chapter to a report by using the append method of the mlreportgen.report.Report object. To add content to the chapter, the example uses the append method of the mlreportgen.report.Chapter object.

Import the DOM and API packages so that you do not have to use long, fully qualified class names.

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

Create a report and add a title and table of contents to the report.

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

Create a chapter and add content to the chapter.

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)))));

Add the chapter to the report.

append(rpt,ch);

Close and view the report.

close(rpt);
rptview(rpt);

Limitations

• Once you append content to report, you cannot append additional content to content.

Tips

• When you append instances of mlreportgen.dom.Text, mlreportgen.dom.Number, mlreportgen.dom.InternalLink, or mlreportgen.dom.ExternalLink objects in reports, the object content appends differently depending on the report format. In HTML reports, the content appends in the same line. In PDF and DOCX reports, the content appends in separate lines. To append the content in the same line, create a mlreportgen.dom.Paragraph object, append the content to the paragraph object by using the append method, then append the paragraph object to the report object.

• When you append an mlreportgen.dom.Image object that uses a PDF as the imagePath, only the first page of the image appears.

• When you append an mlreportgen.dom.Image object that uses a PDF as the imagePath, the image and report must use the same version of the PDF file format. For more information on determining the version of a PDF file, see Document properties and metadata overview on the Adobe website.

Version History

Introduced in R2020b