Main Content

mlreportgen.report.FormalImage.customizeReporter

Class: mlreportgen.report.FormalImage
Package: mlreportgen.report

Create custom formal image reporter class

expand all in page

Syntax

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

Description

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

Input Arguments

expand all

Location of custom formal image class, specified as a string or character array. The classpath argument also supports specifying a folder with @ before the class name.

Output Arguments

expand all

Formal image reporter path, returned as the string specifying the path to the derived report class file.

Examples

Create Custom Formal Image Reporter

Create a custom formal image 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 MyImage.m class file is <current working folder>/newImage/@MyImage/myImage.m. The default title page templates are in the <current working folder>/newImage/@MyImage/resources/templates folder.

import mlreportgen.report.*
FormalImage.customizeReporter('newImage/@MyImage');

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

image = MyImage();

Version History

Introduced in R2017b

See Also

| |