Main Content

mlreportgen.report.TableOfContents.customizeReporter

Class: mlreportgen.report.TableOfContents
Package: mlreportgen.report

Create custom table of contents reporter class

Syntax

reporter = mlreportgen.report.TableOfContents.customizeReporter(classpath)

Description

reporter = mlreportgen.report.TableOfContents.customizeReporter(classpath) creates a table of contents (TOC) class definition file that is a subclass of mlreportgen.report.TableOfContents. The file is created at the specified classpath location. The TableOfContents.customizeReporter method also copies the default TOC templates to the <classpath>/resources/template folder. You can use the class definition file as a starting point to design a custom table of contents class for your report.

Input Arguments

expand all

Path and name of the new class definition file, specified as a string scalar or character vector.

ValueDescription
mlreportgen.report.TableOfContents.customizeReporter("myFolder/MyClass")Create MyClass.m in the subfolder myFolder of the current folder.
mlreportgen.report.TableOfContents.customizeReporter("myFolder/@MyClass")

Create the reporter class in a class folder by preceding the class name with the @ character. Do not specify the .m extension.

See Folders Containing Class Definitions.

mlreportgen.report.TableOfContents.customizeReporter("+myOrg/@MyClass")Create the reporter class in a class package by preceding the folder name with the + character.

Note

You can specify a relative path or an absolute path.

Data Types: string | char

Output Arguments

expand all

Path and file name of the new reporter class, returned as a string scalar.

Examples

Create Custom TOC Reporter

Create a custom TOC reporter and its associated default templates. The derived class file is created at the specified path relative to the current working folder. In this case, the path to the MyTOC.m class file is <current working folder>/newTOC/@MyTOC/myTOC.m. The default title page templates are in the <current working folder>/newTOC/@MyTOC/resources/templates folder.

import mlreportgen.report.*
TableOfContents.customizeReporter('newTOC/@MyTOC');

After editing this new class file, you can use it as your TOC section reporter.

toc = MyTOC();

Version History

Introduced in R2017b