MATLAB Report Generator Task Examples

Report Generator sample tasks and associated code

These examples illustrate how to use the DOM API and Report API to create and format report content.

Word

Page Layout

Create a Report with Landscape Pages
Generate a report that has landscape pages.
Create a Report with Portrait and Landscape Pages
Generate a report that has both portrait and landscape pages.
Customize the Page Size and Margins of a Report Programmatically
Use Report API objects to customize page dimensions.
Customize the Page Size and Margins of a Word Report Using Templates
Modify the page dimensions in the Word templates for the title page, table of contents, and chapter reporters.
Set Page Margins in a Word Report
Define margins and header, footer, and gutter sizes for a DOCX page.
Generate a Microsoft Word Document with Page Borders
Specify Word document page borders programmatically by using mlreportgen.dom.PageBorder objects.
Generate a Report API Report with Page Borders
Specify page borders for Report API reports programmatically by using mlreportgen.dom.PageBorder objects.
Side-by-Side Tables
Arrange tables next to each other on a page.
Side-by-Side Figures
Arrange MATLAB figures next to each other on a page.
Side-by-Side Images
Arrange images next to each other on a page.
Fit Wide Tables in a Page
Slice a wide table to fit on a page.
Center Figure Snapshot on a Page
Center a figure snapshot on a landscape page for PDF and Word reports.
Scale Image to Fit Page
Use an mlreportgen.dom.ScaleToFit object to make an image fit on a page.
Center Image on a Page
Center an image using an invisible 1-by-1 table that has the same size as the page body.
Specify Space Between Paragraphs
Change the spacing between paragraphs in a report.

Tables

Create a Table from a Cell Array
Simplify table creation by modeling the table as a cell array.
Span a Table Entry Across Rows and Columns
Set table entry to span across rows or columns.
Align Table Entry Content Horizontally
Use format properties and objects to align table entry content.
Set Table Column Width
Set table column widths.
Format Numbers in Tables
Format numbers in a table using an mlreportgen.dom.NumberFormat object.
Create a Zebra-Striped Table
Create striped table with alternating row colors.

Lists

Multilevel List
Create multilevel lists in HTML, PDF, or Word reports. Use cell arrays or List and ListItem objects.
Custom Styled Word List
Use a custom Word template to style a multilevel list.

Numbering

Number Section Headings, Table Titles, and Figure Captions Programmatically
Create numbered chapter and subsection headings.
Programmatically Number Pages
Use the DOM and Report APIs to number Word or PDF pages.
Number Pages in a Word Template
Specify page numbering in a report by customizing a Word template.

Images, Figures, and Equations

Create an Inline Equation in a Report
Insert inline equation in a line of text in a report.
Prevent MATLAB Figure Display During Report Generation
Make figure that you include in a report invisible in MATLAB.

Styles

Define Styles Programmatically
Simplify formatting of a report by using named sets of formats in a report program.

PDF

Page Layout

Create a Report with Landscape Pages
Generate a report that has landscape pages.
Create a Report with Portrait and Landscape Pages
Generate a report that has both portrait and landscape pages.
Customize the Page Size and Margins of a Report Programmatically
Use Report API objects to customize page dimensions.
Customize the Page Size and Margins of a PDF Report Using Templates
Modify the page dimensions in the PDF templates for the title page, table of contents, and chapter reporters.
Set Page Margins in a PDF Report
Define margins and header, footer, and gutter sizes for a PDF page.
Generate a PDF Document with Page Borders
Specify PDF document page borders programmatically by using mlreportgen.dom.PageBorder objects.
Generate a Report API Report with Page Borders
Specify page borders for Report API reports programmatically by using mlreportgen.dom.PageBorder objects.
Side-by-Side Tables
Arrange tables next to each other on a page.
Side-by-Side Figures
Arrange MATLAB figures next to each other on a page.
Side-by-Side Images
Arrange images next to each other on a page.
Fit Wide Tables in a Page
Slice a wide table to fit on a page.
Center Figure Snapshot on a Page
Center a figure snapshot on a landscape page for PDF and Word reports.
Scale Image to Fit Page
Use an mlreportgen.dom.ScaleToFit object to make an image fit on a page.
Center Image on a Page
Center an image using an invisible 1-by-1 table that has the same size as the page body.
Center Formal Image in a PDF Report
Center a formal image using an invisible 1-by-1 table that has the same size as the page body.
Specify Space Between Paragraphs
Change the spacing between paragraphs in a report.

Tables

Create a Table from a Cell Array
Simplify table creation by modeling the table as a cell array.
Span a Table Entry Across Rows and Columns
Set table entry to span across rows or columns.
Align Table Entry Content Horizontally
Use format properties and objects to align table entry content.
Set Table Column Width
Set table column widths.
Format Numbers in Tables
Format numbers in a table using an mlreportgen.dom.NumberFormat object.
Create a Zebra-Striped Table
Create striped table with alternating row colors.
Excel to PDF
Create a PDF report from a Microsoft^® Excel^® spreadsheet.

Lists

Multilevel List
Create multilevel lists in HTML, PDF, or Word reports. Use cell arrays or List and ListItem objects.

Images, Figures, and Equations

Hyperlink Image
Add hyperlinks to an image.
Create an Inline Equation in a Report
Insert inline equation in a line of text in a report.
Prevent MATLAB Figure Display During Report Generation
Make figure that you include in a report invisible in MATLAB.

Numbering

Number Section Headings, Table Titles, and Figure Captions Programmatically
Create numbered chapter and subsection headings.
Programmatically Number Pages
Use the DOM and Report APIs to number Word or PDF pages.
Number Pages in a PDF Template
Specify page numbering in a report by customizing a PDF template.

Styles

Define Styles Programmatically
Simplify formatting of a report by using named sets of formats in a report program.

HTML

Page Layout

Side-by-Side Tables
Arrange tables next to each other on a page.
Side-by-Side Figures
Arrange MATLAB figures next to each other on a page.
Side-by-Side Images
Arrange images next to each other on a page.
Specify Space Between Paragraphs
Change the spacing between paragraphs in a report.

Tables

Create a Table from a Cell Array
Simplify table creation by modeling the table as a cell array.
Span a Table Entry Across Rows and Columns
Set table entry to span across rows or columns.
Set Table Column Width
Set table column widths.
Format Numbers in Tables
Format numbers in a table using an mlreportgen.dom.NumberFormat object.
Create a Zebra-Striped Table
Create striped table with alternating row colors.

Lists

Multilevel List
Create multilevel lists in HTML, PDF, or Word reports. Use cell arrays or List and ListItem objects.

Images, Figures, and Equations

Hyperlink Image
Add hyperlinks to an image.
Create an Inline Equation in a Report
Insert inline equation in a line of text in a report.
Prevent MATLAB Figure Display During Report Generation
Make figure that you include in a report invisible in MATLAB.

Numbering

Number Section Headings, Table Titles, and Figure Captions Programmatically
Create numbered chapter and subsection headings.

Styles

Define Styles Programmatically
Simplify formatting of a report by using named sets of formats in a report program.