主要内容

mlreportgen.report.Equation类

包:mlreportgen.report
超类:mlreportgen.report.Reporter

方程的记者

描述

创建一个等式报告器,将等式添加到报表中。

将一个等式作为格式化等式的映像添加到报表中。默认情况下,图像嵌入在一个空的中间段落中。也可以将它与段落中的其他文本放在一行中。因此,图像和方程可以缩放到任何大小。

方程的快照映像存储在报告的临时文件夹中。当报表关闭时,将等式图像复制到报表中,然后从临时文件夹中删除图像。若要防止等式图像文件被删除,请使用调试报告的性质。看见mlreportgen.report.Report

mlreportgen.report.Equation类是一个手柄

类属性

HandleCompatible
真正的

有关类属性的信息,请参见类属性

创建

描述

方程=mlreportgen.report.Equation()创建空的公式报告器对象。使用对象属性指定公式及其格式。

例子

方程=mlreportgen.report.Equation(标记设置由公式的LaTeX标记指定的公式的格式。见内容财产。

方程=mlreportgen.report.Equation(名称、值使用名称-值对设置属性。可以以任意顺序指定多个名称-值对参数。将每个属性名用单引号或双引号括起来。

性质

全部展开

方程的LaTeX标记,指定为字符串标量或字符向量。控件支持的任何LaTeX标记都可以使用万博1manbetx翻译MATLAB的性质®文本对象。请参阅文本属性

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

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

颜色的规格取决于颜色的值UseDirectRenderer属性。如果属性值为真正的,指定有效的CSS颜色名称、RGB三元组或十六进制值。看到https://www.w3.org/TR/2018/REC-css-color-3-20180619/。如果属性值为错误的,使用名称、短名称、RGB三元组或十六进制值指定颜色,如中所述颜色性质文本属性. 此表显示了如何为不同的颜色值指定红色UseDirectRenderer财产。

UseDirectRenderer价值 的名字 RGB值 十六进制代码
真正的 “红色” “rgb(255, 0, 0)” “# FF0000”
错误的 “红色”“r” “(1,0,0)” “# FF0000”

格式化方程式的背景色名称,指定为空或字符串标量或字符向量。如果颜色为空时,背景色默认为白色。你可以使用长或短的颜色名称。有关有效颜色名称的列表,请参见颜色财产文本属性

如果UseDirectRenderer属性是真正的,写成BackgroundColor属性将被忽略。

按文本显示方程,指定为真正的错误的

如果DisplayInline属性设置为错误的时,记者取方程的图像,将图像包装在一个段落中,并将该段落添加到报告中。在报告中,等式本身在一条线上。看到给一章添加一个等式. 使用此选项可以填充样板中的块孔。

如果DisplayInline属性设置为真正的,等式图像没有被包裹在段落中。要将方程添加到报告中,可以使用getImpl方法,然后将图像添加到段落中。在生成的报告中,等式与段落的文本是一致的。看到在段落的文本中显示方程.使用此选项来填充模板中的内联孔。

请注意

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

快照图像格式,指定为字符向量或字符串标量。支持的格式有:万博1manbetx

  • “png”-PNG图像。

  • “电动势”——增强的图元文件。此格式仅在Windows上的D万博1manbetxOCX输出中支持®平台。

  • “svg”-可缩放矢量图形(SVG)。

    如果UseDirectRenderer属性是真正的,仅支持PNG图像格式。如果应用程序需要其他格式,请设置万博1manbetxUseDirectRenderer财产错误的

是否使用直接方程式渲染,指定为真正的错误的。如果值为真正的时,报告器使用Live Editor和Simulink使用的渲染方式直接呈现方程万博1manbetx®编辑器。如果值为错误的,报告器使用图形窗口渲染方程式。

与图形窗口提供的支持相比,直接渲染可以更好地支持方程式标记。使用直万博1manbetx接渲染,渲染方程式与Live Editor和Simulink批注中的方程式具有相同的外观。万博1manbetx

直接渲染不支持:万博1manbetx

  • 图像格式,而不是PNG。

  • 方程式的背景色。

  • 颜色的简称,如“r”。必须使用有效的CSS颜色名称,例如“红色”,或等效的RGB三元组或十六进制颜色代码。请参阅https://www.w3.org/wiki/CSS/Properties/color/keywords

如果应用程序需要PNG以外的格式或不同的背景色,请设置UseDirectRenderer财产错误的

此报告器的模板源,通过以下方式之一指定:

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

  • 该报表使用模板或模板库中包含该报表模板的报表或报表

  • DOM文档或文档部分,其模板用于此报表,或其模板库包含此报表的模板

指定的模板类型必须与该报表所附加的报表类型相同。例如,对于a微软®单词报告,TemplateSrc必须是Word reporter模板。如果TemplateSrc属性为空,此报告器使用默认报告器模板作为报告的输出类型。

此报告器的模板名称,指定为字符向量或字符串标量。该报告程序的模板必须位于模板源的模板库中(TemplateSrc)对本报记者说。

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

方法

全部展开

例子

全部崩溃

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

%导入API包进口mlreportgen.report*%创建报告和章节%在本章中添加一个方程式作为单独的行rpt=报告(“方程”“多克斯”);ch =章(“标题”“方程式”);add (ch,方程(“\int{0}^{2}x^2\sin(x)dx”));add (rpt, ch);%关闭并查看报表。关闭(rpt);rptview (rpt);

创建一个报告,在黄色背景上以14点字体显示一个等式。

%导入API包进口mlreportgen.report*%创建报告和章节%创建一个方程式报告器并设置字体大小和颜色属性rpt=报告(“方程”“多克斯”);ch =章(“标题”“方程式”);等式=等式;等式内容=“\int{0}^{2}x^2\sin(x)dx”;eq.FontSize = 14;eq.Color =“蓝色”;等背景色=“是的”; 加(ch,eq);添加(rpt,ch);%关闭并查看报表关闭(rpt);rptview (rpt);

创建一个方程,使其与段落的文本保持一致DisplayInline财产真正的.然后,调用getImpl方法获取方程的图像快照。将图像快照添加到段落中。

%导入API包进口mlreportgen.report*进口mlreportgen.dom*%创建报告%在报告的段落中与文本一致添加方程式rpt=报告(“方程”“docx”); 方程(“\ int_ {0} ^ {2} x ^ 2 \ sin (x) dx”);eq.DisplayInline = true;img = getImpl(eq, rpt);img。风格= {VerticalAlign (“5 pt”)};p =段(“这是一个内联方程式:”);p.WhiteSpace =“保存”;追加(p, img);追加(p,“更多文本”); 添加(rpt,p);%关闭并查看报表关闭(rpt);rptview (rpt);

兼容性的考虑

全部展开

R2019b中的行为发生了变化

介绍了R2017b