getReportLayout

Class:mlreportgen.report.Report
Package:mlreportgen.report

Current page layout of report

expand all in page

Syntax

pglayout = getReportLayout(report)

Description

pglayout= getReportLayout(report)returns the current page layout of this report. Use this method in thegetImplmethod of a custom reporter to get the report page layout.

Input Arguments

expand all

`report`—Report
report object

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

Output Arguments

expand all

`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 anmlreportgen.dom.PDFPageLayout
docx — Returns anmlreportgen.dom.DOCXPageLayout
HTML — Returns [] because page layouts do not apply to HMTL reports

Version History

Introduced in R2018a