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.

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

Algorithms

This method returns a different layout depending on when you invoke the method while generating a report.

• If you invoke this method while adding a section or chapter to a report, this method returns the current page layout of the section or chapter. For example, if a chapter includes a reporter that invokes this method, this method returns the chapter page layout when that the invoking reporter is added to the content hole in the chapter. The reporter does not add the chapter or section until all of its content has been added to the content hole.

• Otherwise, this method returns the page layout of the report that you most recently configured.

Version History

Introduced in R2018a