MATLAB: How to create mixed orientation pages in the report generator PDF

generatorlandscapeMATLABmixedorientationpagepdfportraitreport

I am using report generator to create a PDF and I would like certain pages to have landscape orientation and the rest to have portrait orientation. I know that if I want to set my full report to landscape orientation, I do:

>> rpt.Layout.Landscape = true;

How do I do this for individual pages?

Best Answer

The best way to do this would be to put your desired landscape pages in their own chapter and then setting the chapter layout to landscape:

>> ch.Layout.Landscape = true;

If you want individual pages within chapters to have mixed orientation, then you have to follow a couple of steps:

1. Create the chapter.

2. Add any content that you want in portrait landscape to the chapter.

3. Add a PDFPageLayout obj and have it oriented to landscape with the width and height changed:

>> PageLayoutObj = mlreportgen.dom.PDFPageLayout;
>> PageLayoutObj.PageSize.Orientation = 'landscape';
>> PageLayoutObj.PageSize.Height = '8.5in';
>> PageLayoutObj.PageSize.Width = '11in';

4. Add the landscape page layout object to the chapter

5. Then add any content you want on that page to the chapter. Be careful to make sure this content does not exceed that one landscape page. You can ensure you don't exceed a single page by placing the content inside an invisible table that is 10.5in by 8in.

Please see the attached example for how to change a chapter's orientation and how to change an individual page's orientation.

Related Solutions

MATLAB: How to add a footer in PDF report using only Report API with chapters

The report generation in MATLAB allows you to create a custom template for reporters using 'customizeReporter' method for reporter classes in mlreportgen.report.*. You can create a custom chapter template first and add holes to create a footer in the PDF template. For reference, template holes are places in a template that the report program fills with content.

The following steps illustrate how to add a footer in the report:

Step 1 – Create a custom chapter class with the following command:

>> mlreportgen.report.Chapter.customizeReporter('@customChapter');
               This will create a folder named '@customChapter' in your current directory. It contains the file 'customChapter.m' and a resource directory.

Step 2 – Navigate to the PDF template - @customChapter/resources/templates/pdf, unzip the PDF template using the command:

>> unzip("default.pdftx","default")
              This will create a folder named “default” with "root.html" and "docpart_templates.html"

Step 3 – Edit the PDF template to add a footer containing a hole. For example, you can update the "docpart_templates.html" with following code in the <body> section :

......
<layout>
  <pfooter type="default" template-name="MyPageFooter"/>
</layout>
:
:
<dptemplate name="MyPageFooter">
    <p style="text-align:right;font-family:Arial,Helvetica,sans-serif;font-size:10pt">
     <hole id="PageFooterHole1" /> </p>
   </dptemplate>
......

For more details on how to add footer, refer to

https://www.mathworks.com/help/releases/R2018a/rptgen/ug/add-page-footers-and-headers.html#bu710dp-1

Step 4 – Zip the template (remember to be on the path @customChapter/resources/templates/pdf:

>> zipTemplate("default.pdftx","default")

Step 5 – Edit 'customChapter.m' and add a property that matches the hole ID in the template. Each hole in the report will be replaced by the value of the corresponding property of the report. In this case, create property name 'PageFooterHole1' for 'customChapter' class.

Step 6 – Create a chapter with custom chapter template. Set the content for the footer hole by setting the corresponding property of the report object. In this example, following code would create report and add a chapter with desired footer content:

>> rpt = Report('test','pdf'); %create a report object
>> ch = customChapter;
>> tp = TitlePage;  %create a title page
>> tp.Title = 'Test Case Results';
>> tp.Subtitle = 'Subtitle';
>> tp.Author = 'John';
>> add(rpt,tp);
>> ch.PageFooterHole1 =  mlreportgen.dom.Text("This is my footer1");
>> add(rpt,ch);
>> add(rpt, "body content");
>> add(rpt, mlreportgen.dom.PageBreak);
>> add(rpt, "body content");
>> close(rpt);
>> rptview(rpt); % To view the report

This will create a PDF report with a title page and a chapter with two pages showing the footer with the style specified in "docpart_templates.html".

Files are attached for reference.

Please note that you can adapt this method to add headers as well or any other customization needed by your workflow. For instance, the following MATLAB Answers post discusses an approach to add an image to a header:

https://www.mathworks.com/matlabcentral/answers/469827-add-image-in-the-header-of-the-report

MATLAB: How to switch between landscape and portrait page orientation when creating a Word report using MATLAB Report Generator R2019a

Each time you want to change the page layout in the document, you need to create a new DOCXPageLayout object, set the orientation, and append it to the document object. If you are switching between portrait and landscape pages multiple times in the document, one strategy is to create two page layout objects, one portrait and one landscape, and append clones of the objects to the document whenever you need to switch the orientation. For example:

import mlreportgen.dom.*
d = Document('exampleDoc', 'docx');
open(d);
% default page layout is portrait
portraitPLO = DOCXPageLayout;
portraitPageSize = portraitPLO.PageSize;
% define landscape layout
landscapePLO = DOCXPageLayout;
landscapePLO.PageSize.Orientation = "landscape";
landscapePLO.PageSize.Height = portraitPageSize.Width;
landscapePLO.PageSize.Width = portraitPageSize.Height;
table = append(d,magic(15));
table.Border = 'solid';
table.ColSep = 'solid';
table.RowSep = 'solid';
%switch to landscape
append(d, clone(landscapePLO));
table = append(d,magic(11));
table.Border = 'solid';
table.ColSep = 'solid';
table.RowSep = 'solid';
%switch to portrait
append(d, clone(portraitPLO));
table = append(d,magic(5));
table.Border = 'solid';
table.ColSep = 'solid';
table.RowSep = 'solid';
%switch to landscape again
append(d, clone(landscapePLO));
table = append(d,magic(8));
table.Border = 'solid';
table.ColSep = 'solid';
table.RowSep = 'solid';
close(d);
rptview(d);

Best Answer

Related Solutions

MATLAB: How to add a footer in PDF report using only Report API with chapters

MATLAB: How to switch between landscape and portrait page orientation when creating a Word report using MATLAB Report Generator R2019a

Related Question