Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

mlreportgen.report.Equation.customizeReporter

Class: mlreportgen.report.Equation
Package: mlreportgen.report

Create custom equation reporter class

Syntax

reporter = customizeReporter(classpath)
output_args = method(input_args,Name,Value)

Description

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

For example:

mlreportgen.report.Equation.customizeReporter("path_folder/MyClassA.m")
mlreportgen.report.Equation.customizeReporter("+package/@MyClassB")

output_args = method(input_args,Name,Value) creates an equation class definition file with additional options specified by one or more Name,Value pair arguments.

Input Arguments

expand all

Location of custom equation 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

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

Examples

Create Custom Equation Reporter

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

import mlreportgen.report.*
Equation.customizeReporter('newEq/@MyEq');

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

eq = MyEq();

Introduced in R2017b

Was this topic helpful?