getReportLayout

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

Current page layout of report

Syntax

pglayout = getReportLayout(report)


Description

pglayout = getReportLayout(report) returns the current page layout of this report. Use this method only in the getImpl method of a custom reporter to get the page layout of the report section that it generates. Using this method in other contexts might produce incorrect results.

Note

Use the Layout property of the mlreportgen.report.TitlePage, mlreportgen.report.TableOfContents, and mlreportgen.report.Chapter reporters to modify the page layouts of the report sections they generate.

Input Arguments

report — Report

report object

Report, specified as a report object. To create the report input, use mlreportgen.report.Report.

Output Arguments

pglayout — Current page layout

page layout object | []

Current page layout, returned as a page layout object. This method returns the current layout whether the reporter is added directly to the report or indirectly as chapter content. The returned value depends on the report type.

• pdf — Returns an mlreportgen.dom.PDFPageLayout

• docx — Returns an mlreportgen.dom.DOCXPageLayout

• HTML — Returns [] because page layouts do not apply to HMTL reports

Version History

Introduced in R2018a