mlreportgen.report.Axes.customizeReporter

Class: mlreportgen.report.Axes
Namespace: mlreportgen.report

Create class derived from axes reporter class

Since R2021b

Syntax

reporter = mlreportgen.report.Axes.customizeReporter(classPath)


Description

reporter = mlreportgen.report.Axes.customizeReporter(classPath) creates a reporter class definition file that defines a subclass of mlreportgen.report.Axes at the location specified by classPath. The method also copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. Use the class definition file as a starting point to design a custom reporter class.

Input Arguments

classpath — Path and name of new class definition file

string scalar | character vector

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

Value	Description
mlreportgen.report.Axes.customizeReporter("myFolder/MyClass")	Create MyClass.m in the subfolder myFolder of the current folder.
mlreportgen.report.Axes.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.Axes.customizeReporter("+myOrg/@MyClass")	Create the reporter class in a class namespace 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

reporter — Path and file name of new reporter class

string scalar

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

Examples

Create Custom Axes Reporter

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

mlreportgen.report.Axes.customizeReporter("newAxes/@myAxes")

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

axes = myAxes();

Version History

Introduced in R2021b