Package: mlreportgen.report
Superclasses: mlreportgen.report.Reporter
Equation reporter
Create an equation reporter that adds an equation to a report.
An equation is added to a report as an image of the formatted equation. By default, the image is embedded in an empty, centered paragraph. Optionally, it can be appended in line with other text in a paragraph. The image, and therefore, the equation can be scaled to any size.
The snapshot image of the equation is stored in the temporary folder of the report. When
the report is closed, the equation image is copied into the report and, then, the image is
deleted from the temporary folder. To prevent the equation image files from being deleted, use
the Debug
property of the report. See mlreportgen.report.Report
.
The mlreportgen.report.Equation
class is a handle
class.
HandleCompatible | true |
For information on class attributes, see Class Attributes (MATLAB).
creates an empty equation reporter object. Use the object properties to specify the
equation and its formatting.equation
= mlreportgen.report.Equation()
formats the equation that is specified by the LaTeX markup for the equation. See the
Content
property.equation
= mlreportgen.report.Equation(markup
)
sets properties using name-value pairs. You can specify multiple name-value pair arguments
in any order. Enclose each property name in single or double quotes.equation
= mlreportgen.report.Equation(Name,Value
)