MATLAB: No appropriate method ‘TOCObj’ for class ‘mlreportgen.report.TableOfContents’.

MATLABMATLAB Report Generatortabletable of contents

Hello, I am trying to customize my table of contents in my report as presented the mlreportgen.report.TableOfContents class documentation. However I get an error when I do this

toc = TableOfContents;
toc.TOCObj.NumberOfLevels = 2; 
add(rpt, toc);

The error is:

No appropriate method, property, or field 'TOCObj' for class 'mlreportgen.report.TableOfContents'.
Error in Mreport (line 92)
    toc.TOCObj.NumberOfLevels = 2;

Has the TOCObj been removed from Matlab or does the error come from somewhere else?

Thank you in advance!

Best Answer

I think you are using MATLAB R2018a version. But the example you are referring is from documentation of R2019a version (which supports the feature of specifying number of levels). The feature to programmatically specify the number of TOC levels is added in R2018b version.

Since you are using MATLAB R2018a, the error is being created (TOCObj is not supported in versions prior to R2018b). Try using MATLAB R2018b or R2019a.

You may refer Enhanced table of contents customization in the following link

https://in.mathworks.com/help/rptgen/release-notes.html?rntext=&startrelease=R2018b&endrelease=R2018b&groupby=release&sortby=descending&searchHighlight=

Related Solutions

MATLAB: How to not include an element in the Table of Content

Hi Jack,

As mentioned in the answer of the linked question, the TOCObj property of TableOfContents reporter was added in R2018b and hence you are unable to use it in R2018a.

To customize the number of levels in R2018a, you can customize the default template of the TableOfContents reporter to set the number of levels and then use this custom template to create your TableOfContents reporter. You can use mlreportgen.report.TableOfContents.createTemplate to create a copy of the default template and then customize it according to your requirements. As an example, to update the number of levels in PDF template, you will have to update the <toc> field in the dptemplate named TableOfContents as follows:

Change:

<dptemplate name="TableOfContents">
    .....
    <toc/>
</dptemplate>

to:

<dptemplate name="TableOfContents">
    .....
    <toc number-of-levels="1"/>
</dptemplate>

If you do not wish to customize the template and wants to achieve this programmatically, another alternative is to first get the DOM implementation of the TableOfContents reporter and then get access to the TOC from its children to customize it. Below is an example for a PDF report:

% Create a PDF report
rpt = mlreportgen.report.Report("myReport","pdf");
open(rpt);
% Create TableOfContents reporter based on the default template
reporter = mlreportgen.report.TableOfContents;
% Get the DOM implementation of this reporter
impl = getImpl(reporter,rpt);
% Get the DOM TOC child, which will be the third one in this case
tocObj = impl.Children(3);
% Customize this object according to your requirements
tocObj.NumberOfLevels = 1;
% Add the implementation to the report
add(rpt,impl);
% Create and add chapter and section objects to the report
% ...

% ...
% Close and view the report
close(rpt);
rptview(rpt);

Both the ways I have shown above demonstrates the TableOfContents customization for PDF reports. It may differ a little if you are generating a HTML or a DOCX report.

Hope this helps!

Thanks,

Rahul

MATLAB: Reportgenerator Template/Styles Matlab 2018b

Hi Martin,

It looks like you are using the Report API to create report, but using the Report Explorer application to create the custom template.

In Report API, each reporter has its own default template whose copy can be created by using the reporter's createTemplate() method. For example, if you want to create a copy of the Section reporter's default template, use mlreportgen.report.Section.createTemplate method.