mlreportgen.report.Equation 类

命名空间: mlreportgen.report
超类: mlreportgen.report.Reporter

方程报告器

全页展开

描述

创建一个方程报告器，将方程添加到报告中。

方程以格式化方程的图像形式添加到报告中。默认情况下，图像嵌入在空的、居中的段落中。如果需要，也可以将其与段落中的其他文本行内追加在一起。因此，图像和方程都可以缩放到任意大小。

方程的快照图像存储在报告的临时文件夹中。当报告关闭时，方程图像将被复制到报告中，然后从临时文件夹中删除该图像。为了防止方程图像文件被删除，请使用报告的 Debug 属性。请参阅 mlreportgen.report.Report。

mlreportgen.report.Equation 类是一个 handle 类。

类属性

HandleCompatible true

有关类属性的信息，请参阅类属性。

创建对象

描述

equation = mlreportgen.report.Equation 创建一个空的方程报告器对象。使用对象属性来指定方程及其格式。

equation = mlreportgen.report.Equation(markup) 格式化由 LaTeX 标记为方程指定的方程。查看 Content 属性。

示例

equation = mlreportgen.report.Equation(PropertyName=Value) 使用名称-值参量设置属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

`Content` — LaTeX 标记
`[]` (默认) | 字符向量 | 字符串标量

方程的 LaTeX 标记，指定为字符向量或字符串标量。您可以使用 MATLAB^® 文本对象的 Interpreter 属性支持的任何 LaTeX 标记。请参阅 Text 属性。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`FontSize` — 字体大小
`[]` (默认) | 正整数

格式化方程的字体大小，指定为空或正整数。如果 FontSize 属性为空，则字体大小默认为 10。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: int32

`Color` — 字体颜色
`[]` (默认) | 字符向量 | 字符串标量

字体颜色，指定为包含 CSS 颜色名称、十六进制 RGB 值或十进制 RGB 值的字符向量或字符串标量。

格式	值
CSS 颜色名称	指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
十六进制 RGB 值	使用格式 `"#RRGGBB"`。使用 `#` 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色的值。您可以使用大写或小写字母。
十进制 RGB 颜色值	请使用格式 `"rgb(r,g,b)"`，其中 `r`、`g` 和 `b` 是以逗号分隔的正整数，分别表示红色、绿色和蓝色的值。每个值的范围必须介于 `0` 和 `255` 之间。

颜色规范取决于 UseDirectRenderer 属性的值。如果属性值为 true，请指定有效的 CSS 颜色名称、RGB 三元组或十六进制值。请参阅https://www.w3.org/TR/2018/REC-css-color-3-20180619/。如果属性值为 false，请使用名称、简称、RGB 三元组或十六进制值指定颜色，如 Text 属性的 Color 属性中所述。下表显示了如何为 UseDirectRenderer 属性的不同值指定红色。

`UseDirectRenderer` 值	名称	RGB 三元组	十六进制代码
`true`	`"red"`	`"rgb(255,0,0)"`	`"#FF0000"`
`false`	`"red"` 或 `"r"`	`"[1,0,0]"`	`"#FF0000"`

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`BackgroundColor` — 背景颜色的名称
`[]` (默认) | 字符向量 | 字符串标量

格式化方程的背景颜色名称，指定为字符向量或字符串标量。如果 Color 为空，则背景颜色默认为白色。您可以使用长或短的颜色名称。有关有效颜色名称的列表，请参阅 Text 属性中的 Color 属性。

如果 UseDirectRenderer 属性为 true，则忽略 BackgroundColor 属性。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`DisplayInline` — 将方程与文本行内显示
`0` (`false`) (默认) | `1` (`true`)

将方程与文本内联显示，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 方程图片未被包裹在段落中。要将公式添加到报告，请使用 getImpl 方法获取公式图像，然后将该图像添加到段落。在生成的报告中，该方程与段落中的文本并排显示。请参阅将方程内联显示在段落正文中。使用此选项可以填充模板中的内联空位。

注意
默认情况下，内联图像的底部与周围文本的基线对齐。如果内联方程图像比周围文本高，则可以使用 mlreportgen.dom.VerticalAlign 格式将图像相对于文本基线对齐，以便方程基线与文本基线匹配。您必须进行实验来确定所需的垂直调整量。
0 (false) - 报告器拍摄了该方程的图片，将图片嵌入到一个段落中，然后将该段落添加到报告中。报告中，该方程独自位于一条线上。请参阅在章节中添加方程。使用此选项可以填充模板中的块状空位。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: logical

`SnapshotFormat` — 快照图像格式
`"svg"` (默认) | `"png"` | `"emf"`

快照图像格式，指定为字符向量或字符串标量。支持的格式包括：

"png" - PNG 图像。
"emf" - 增强元文件。此格式仅在 Windows^® 平台上的 DOCX 输出中受支持。
"svg" - 可缩放矢量图 (SVG)。
注意
如果 UseDirectRenderer 属性为 true，则仅支持 PNG 图像格式。如果您的应用程序需要其他格式，请将 UseDirectRenderer 属性设置为 false。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`UseDirectRenderer` — 是否使用直接方程渲染
`0` (`false`) (默认) | `1` (`true`)

是否使用直接方程渲染，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 报告器直接使用 Live Editor 和 Simulink^® Editor 所采用的渲染方式来呈现方程。
0 (false) - 报告器使用公式窗口来绘制一个方程。

直接渲染对方程标记的支持比图窗窗口提供的支持更好。通过直接渲染，渲染的方程与实时编辑器和 Simulink 注释中的方程具有相同的外观。

MATLAB Online 中无法直接渲染方程。

直接渲染不支持：

PNG 以外的图像格式。
方程的背景颜色。
颜色的简称，例如 "r"。您必须使用有效的 CSS 颜色名称，例如 "red"，或等效的 RGB 三元组或十六进制颜色代码。请参阅https://www.w3.org/wiki/CSS/Properties/color/keywords。

如果您的应用程序需要 PNG 以外的格式或不同的背景颜色，请将 UseDirectRenderer 属性设置为 false。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: logical

`TemplateSrc` — 此报告器的模板来源
字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

该报告器的模板来源，以下列方式之一指定：

字符向量或字符串标量，指定包含此报告器模板的文件的路径
此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告
文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

指定的模板必须与您追加此报告器的报告类型相同。例如，对于 Microsoft^® Word 报告，TemplateSrc 必须是 Word 报告模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`
`Dependent`	`true`

`TemplateName` — 此报告器的模板名称
字符向量 | 字符串标量

此报告器的模板名称，指定为字符向量或字符串标量。该报告器的模板必须位于该报告器的 TemplateSrc 属性指定的模板的模板库中。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`LinkTarget` — 此报告器的超链接目标
`[]` (默认) | 字符向量 | 字符串标量 | `mlreportgen.dom.LinkTarget` 对象

此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或 mlreportgen.dom.LinkTarget 对象。字符向量或字符串标量值转换为 LinkTarget 对象。链接目标在输出报告中紧接着此报告器的内容。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

方法

全部展开

公共方法

方法	用途
`getContentReporter`	获取方程内容空位报告器
`getSnapshotImage`	创建方程图像并返回文件路径或数据 URL
`createTemplate`	创建报告器模板 `template = createTemplate(templatePath,templateType)` 在 `templatePath` 指定的位置，为 `templateType` 指定的报告类型创建默认模板的副本。您可以使用复制的模板作为起点，为您的报告设计自定义的报告模板。输入参量 `templatePath` - 模板文件的目标路径和文件名，指定为字符向量或字符串标量。 `templateType` - 模板类型，指定为 `"html"`、`"docx"` 或 `"pdf"` 返回值 `template` - 模板副本的路径和文件名，以字符串标量形式返回。有关详细信息，请参阅 `Reporter` 类的 `mlreportgen.report.Reporter.createTemplate` 方法。
`customizeReporter`	从 `mlreportgen.report.Equation` 类创建报告器 `classPathOut = customizeReporter(classPath)` 创建一个报告类定义文件，该文件在 `classPath` 指定的位置定义 `mlreportgen.report.Equation` 的子类。该方法将默认报告器模板复制到包含类定义文件的文件夹下的 `resources/templates` 子文件夹中。您可以使用类定义文件作为起点来设计自定义报告器类。输入参量 `classPath` - 新类定义文件的路径和名称，指定为字符向量或字符串标量返回值 `classPathOut` - 新类的路径和文件名，以字符串标量形式返回有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `mlreportgen.report.Reporter.customizeReporter` 方法。
`getClassFolder`	获取包含 `mlreportgen.report.Equation` 类定义文件的文件夹位置 `path = getClassFolder` 返回包含类定义文件的文件夹的路径。返回值 `path` - 类定义文件的位置，以字符向量形式返回。有关详细信息，请参阅 `Reporter` 类的 `mlreportgen.report.Reporter.getClassFolder` 方法。
`copy`	创建报告器对象的副本，并对属性值进行深拷贝 `copiedObj = copy(reporterObj)` 返回指定报告对象的副本。返回的副本包含引用报告器、DOM 对象或 `mlreportgen.report.ReporterLayout` 对象的 `reporterObj` 的任何属性值的深拷贝。因此，您可以修改原始对象或新对象的属性，而不会影响其他对象。输入参量 `reporterObj` - 要复制的报告器对象，指定为报告器类的对象返回值 `copiedObj` - 报告器的副本，以报告器类对象形式返回有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `copy` 方法。
`getImpl`	获取报告器的实现 `impl = getImpl(reporter,report)` 返回在将报告器 `reporter` 追加到报告 `report` 时实现该报告器的文档对象模型 (DOM) 对象。注意调用此方法后，您无法再向报告器添加内容。输入参量 `reporterObj` - 报告器对象，指定为 `mlreportgen.report.Reporter` 的对象或 `mlreportgen.report.Reporter` 的子类的对象 `report` - 报告，指定为 `mlreportgen.report.Report` 对象返回值 `impl` - 实现对象，以 DOM 对象形式返回。有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `getImpl` 方法。

示例

全部折叠

在章节中添加方程

创建一份在章节中包含方程的报告。默认情况下，报告器会在报告的单独一行中添加方程的图像。

% Import the API namespaces
import mlreportgen.report.*

% Create the report and chapter 
% Add an equation as a separate line in the chapter
rpt = Report("equation","docx");
ch = Chapter(Title="Equation");
add(ch,Equation("\int_{0}^{2} x^2\sin(x) dx"));
add(rpt,ch);

% Close and view the report.
close(rpt);
rptview(rpt);

设置方程字体大小和颜色

创建一份报告，其中包含黄色背景上 14 号字体的方程。

% Import the API namespaces
import mlreportgen.report.*

% Create the report and chapter 
% Create an Equation reporter and set the FontSize and Color properties
rpt = Report("equation","docx");
ch = Chapter(Title="Equation");
eq = Equation;
eq.Content = "\int_{0}^{2} x^2\sin(x) dx";
eq.FontSize = 14; 
eq.Color = "blue";
eq.BackgroundColor = "y";
add(ch,eq);
add(rpt,ch);

% Close and view the report
close(rpt);
rptview(rpt);

将方程内联显示在段落正文中

通过将 DisplayInline 属性设置为 true，可在段落正文中创建行内方程。然后，调用 getImpl 方法获取公式的图像快照。将图像的快照添加到段落中。

% Import the API namespaces
import mlreportgen.report.*
import mlreportgen.dom.*

% Create report
% Add equation inline with text in a paragraph of the report
rpt = Report("equation","docx");
eq = Equation("\int_{0}^{2} x^2\sin(x) dx");
eq.DisplayInline = true;
img = getImpl(eq,rpt);
img.Style = {VerticalAlign("-5pt")};
p = Paragraph("Here is an inline equation: ");
p.WhiteSpace = "preserve";
append(p,img);
append(p," More text ");

add(rpt,p);

% Close and view the report
close(rpt);
rptview(rpt);

限制

MATLAB Online 中无法直接渲染方程。

版本历史记录

在 R2017b 中推出

全部展开

R2019b: 对于所有报告类型，`SnapshotFormat` 的默认值均为 `'svg'`

从 R2019b 开始，Word 报告支持可缩放矢量图 (SVG) 图像。对于所有报告类型（HTML、PDF 和 Word），SnapshotFormat 属性的默认值为 'svg'，而 'auto' 属性值表示 'svg'。在以前的版本中，SnapshotFormat 属性的默认值为 'auto'，对于 HTML 和 PDF 报告，它表示为 'svg'；对于 Word 报告，它表示为 'emf' 或 'png'，具体取决于平台。

包含 SVG 图像的 Word 报告需要 Word 2016 或更高版本。在 MATLAB R2019b 或更高版本中，要生成与早期版本的 Word 兼容的图像的报告，请将 SnapshotFormat 属性设置为 'svg' 以外的值。要指定 MATLAB 早期版本中默认使用的图像格式，请将 SnapshotFormat 设置为：

"emf" 适用于 Windows 平台
"png" 适用于 UNIX^® 或 Mac 平台

另请参阅

mlreportgen.report.Reporter | mlreportgen.report.Report | Text 属性

mlreportgen.report.Equation 类

描述

类属性

创建对象

描述

属性

Content — LaTeX 标记 [] (默认) | 字符向量 | 字符串标量

属性：

FontSize — 字体大小 [] (默认) | 正整数

属性：

Color — 字体颜色 [] (默认) | 字符向量 | 字符串标量

属性：

BackgroundColor — 背景颜色的名称 [] (默认) | 字符向量 | 字符串标量

属性：

DisplayInline — 将方程与文本行内显示 0 (false) (默认) | 1 (true)

属性：

SnapshotFormat — 快照图像格式 "svg" (默认) | "png" | "emf"

属性：

UseDirectRenderer — 是否使用直接方程渲染 0 (false) (默认) | 1 (true)

属性：

TemplateSrc — 此报告器的模板来源 字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

属性：

TemplateName — 此报告器的模板名称 字符向量 | 字符串标量

属性：

LinkTarget — 此报告器的超链接目标 [] (默认) | 字符向量 | 字符串标量 | mlreportgen.dom.LinkTarget 对象

属性：

方法

公共方法

示例

在章节中添加方程

设置方程字体大小和颜色

将方程内联显示在段落正文中

限制

版本历史记录

R2019b: 对于所有报告类型，SnapshotFormat 的默认值均为 'svg'

另请参阅

主题

`Content` — LaTeX 标记
`[]` (默认) | 字符向量 | 字符串标量

`FontSize` — 字体大小
`[]` (默认) | 正整数

`Color` — 字体颜色
`[]` (默认) | 字符向量 | 字符串标量

`BackgroundColor` — 背景颜色的名称
`[]` (默认) | 字符向量 | 字符串标量

`DisplayInline` — 将方程与文本行内显示
`0` (`false`) (默认) | `1` (`true`)

`SnapshotFormat` — 快照图像格式
`"svg"` (默认) | `"png"` | `"emf"`

`UseDirectRenderer` — 是否使用直接方程渲染
`0` (`false`) (默认) | `1` (`true`)

`TemplateSrc` — 此报告器的模板来源
字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

`TemplateName` — 此报告器的模板名称
字符向量 | 字符串标量

`LinkTarget` — 此报告器的超链接目标
`[]` (默认) | 字符向量 | 字符串标量 | `mlreportgen.dom.LinkTarget` 对象

R2019b: 对于所有报告类型，`SnapshotFormat` 的默认值均为 `'svg'`