MATLAB: Adjust distance between snapshot and caption (report generator)

MATLAB Report Generatorreport generatorreport generator caption issue

My problem is based on the following example which is provided by MatLab:

import mlreportgen.report.*
surf(peaks);
rpt = Report('peaks');
chapter = Chapter();
chapter.Title = 'Figure Example';
add(rpt,chapter);
fig = Figure();
fig.Snapshot.Caption = '3-D shaded surface plot';
fig.Snapshot.Height = '5in';
add(rpt,fig);
delete(gcf);
rptview(rpt);

How can i adjust the distance between the caption and the figure. In my case the distance is to big. I want that the Caption is comes closer to the Figure.

Thanks in advance!

Best regards,

Martin

Best Answer

Hi Martin,

You can customize the Figure reporter's template to adjust the distance between the generated figure and caption by updating the p.FigureImage style in the CSS.

Please refer to the below code:

% Create a custom Figure reporter template
customTemplate = mlreportgen.report.Figure.createTemplate('myTemplate','pdf');
% Unzip the custom template
unzipTemplate(customTemplate);
% In myTemplate\stylesheets\root.css, reduce the margin-bottom of p.FigureImage style
%    p.FigureImage {
%        margin-bottom: 1pt;
%    }
% Zip back the custom template
zipTemplate(customTemplate);
% Use this custom template for the Figure reporter
fig = Figure();
fig.TemplateSrc = customTemplate;

Thanks,

Rahul

Related Solutions

MATLAB: Has anyone had success in creating a Report generator class to properly fill holes in a Word document

To generate a report from a DOM-based document object:

Derive your report class from mlreportgen.dom.Document class, for example

% MyReport.m
class MyReport < mlreportgen.dom.Document
    method
       function rpt = MyReport(name)
          rpt@mlreportgen.dom.Document(name, 'docx', 'MyTemplate');
       end
    end
end

Provide a public fill<HOLEID> method for each hole in your report template, where HOLEID is the name of the hole, for example,

    class MyReport < mlreportgen.dom.Document
        method
           function rpt = MyReport(name)
              rpt@mlreportgen.dom.Document(name, 'docx', 'MyTemplate');
           end
           % This method is called by mlreportgen.dom.Document's fill method.
           % Do not call it yourself.
           function fillReportDate(rpt)
               append(rpt, date);
           end
        end
    end

Create a report program (i.e., script or function) to run the report.
In the report program, create an instance of your report class and call its fill method (inherited from mlreportgen.dom.Document class), for example,

% runMyReport.m
rpt = MyReport('myreport');
fill(rpt);
rptview(rpt.OutputPath);

MATLAB: How to change the chapter title font in Report Generator

To change the full chapter title including the "Chapter X" and the Title:

1. Save a default Chapter template by executing the following line of code:

>> template = mlreportgen.report.Chapter.createTemplate('customChapterStyle.pdftx','pdf')

2. Unzip the PDFTX-file to make edits:

>> unzipTemplate('customChapterStyle.pdftx')

3. In the unzipped "customChapterStyle" folder, open the stylesheet "root.css":

4. Make edits as desired and then save the css file. For example:

h1.SectionTitle1, p.SectionTitle1 {
    font-family: 'Times New Roman';
    font-size: 40pt;
    margin-top: 25pt;
    font-weight:bold;
    margin-bottom: 10pt;
    color: red;
    white-space: pre;
    -fo-keep-with-next.within-page: always;
}

5. Rezip the PDFTX by executing the following code:

>> zipTemplate('customChapterStyle.pdftx')

6. Go to the script creating the Report and find where the chapter is being created. Set the chapter property of TemplateSrc to the proper file path:

>> ch1 = Chapter
>> ch1.TemplateSrc = 'customChapterStyle.pdftx'

The above changes the style of the full title: Chapter X. Title Text

To remove the component "Chapter X." and just include the Title Text:

>> ch1. Numbered = false;

To include the "Chapter X", but give the Title Text a different font:

1. Make the chapter title a mlreportgen.dom.Text object:

>> ch1title = Text('Change Chapter Title Font');

2. Define the properties of the Text object:

>> fontFamily = FontFamily('Arial');
>> fontSizeObj = FontSize('25px');
>> ch1title.Style = {fontFamily, fontSizeObj};
>> ch1title.Color = 'blue';

Attached is an example that generates a PDF report with the Chapter X. and Title Text reformatted.

Best Answer

Related Solutions

MATLAB: Has anyone had success in creating a Report generator class to properly fill holes in a Word document

MATLAB: How to change the chapter title font in Report Generator

Related Question