本页采用了机器翻译。点击此处可查看英文原文。

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(Name=Value) 使用名称-值参量设置属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public

数据类型: int32

字体颜色，指定为包含颜色名称或等效十六进制或 RGB 三元组规范的字符向量或字符串标量。

颜色规范取决于 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

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

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

显示与文本一致的方程，指定为 true 或 false。

如果将 DisplayInline 属性设置为 false，则报告器会获取公式的图像，将图像包装在段落中，然后将段落添加到报告中。报告中，该方程独自位于一条线上。请参阅在章节中添加方程。使用此选项可以填充模板中的块状空位。

如果将 DisplayInline 属性设置为 true，则公式图像不会包装在段落中。要将公式添加到报告，请使用 getImpl 方法获取公式图像，然后将该图像添加到段落。在生成的报告中，公式与段落文本一致。请参阅在段落文本中显示方程。使用此选项可以填充模板中的内联空位。

注意

默认情况下，内联图像的底部与周围文本的基线对齐。如果内联方程图像比周围文本高，则可以使用 mlreportgen.dom.VerticalAlign 格式将图像相对于文本基线对齐，以便方程基线与文本基线匹配。您必须进行实验来确定所需的垂直调整量。

属性：

GetAccess
public
SetAccess
public

数据类型: logical

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

  • "png" - PNG 图像。

  • "emf" - 增强元文件。此格式仅在 Windows® 平台上的 DOCX 输出中受支持。

  • "svg" - 可缩放矢量图 (SVG)。

    注意

    如果 UseDirectRenderer 属性为 true，则仅支持 PNG 图像格式。如果您的应用程序需要其他格式，请将 UseDirectRenderer 属性设置为 false。

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

是否使用直接方程渲染，指定为 true 或 false。如果值为 true，则报告器直接使用实时编辑器和 Simulink® 编辑器所使用的渲染来渲染公式。如果值为 false，则报告器使用图窗窗口来呈现方程。

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

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

直接渲染不支持：

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

属性：

GetAccess
public
SetAccess
public

数据类型: logical

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

  • 字符向量或字符串标量，指定包含此报告器模板的文件的路径

  • 此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告

  • 文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public

方法

全部展开

示例

全部折叠

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

% 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 in line 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);

版本历史记录

在 R2017b 中推出

全部展开

另请参阅

| |

主题