Main Content

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

mlreportgen.report.ListOfCaptions 类

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

题注列表报告器

自 R2020b 起

全页展开

描述

使用 mlreportgen.report.ListOfCaptions 类的对象创建一个报告器，该报告器将一个带题注列表报告元素的节添加到报告。要为带有题注的图窗列表或带标题的表格创建报告器，请分别使用 mlreportgen.report.ListOfFigure 和 mlreportgen.report.ListOfTables 类的对象。要为其他类型的报告元素（例如方程）列表创建报告器，请使用 ListOfCaptions 对象。

要识别要包含在题注列表中的报告元素：

  1. 选择编号流名称，例如 equation。将 ListOfCaptions 对象的 AutoNumberStreamName 属性设置为编号流名称。

  2. 为报告对象创建题注作为 mlreportgen.dom.Paragraph 对象。

  3. 使用 mlreportgen.dom.AutoNumber 对象将 Paragraph 对象与编号流名称关联。

生成的题注列表包含与指定编号流名称相关的题注。列表条目链接到报告中的题注。在 PDF 和 Word 报 告中，列表还包括报告中题注的页码。引导符填充了题注和页码之间的空白。

题注列表的生成方式取决于报告类型：

  • PDF -报告 API 在报告生成期间生成列表。

  • Word -报告 API 为列表生成一个占位符。要生成列表项，您必须在报告生成程序或 Word 中更新 Word 文档。请参阅更新 Word 文档中的目录和生成的列表。

  • HTML -报告 API 为列表生成一个占位符。当报告在 HTML 浏览器中打开时，浏览器会在侧栏中生成列表。

注意

您可以使用 ListOfCaptions 报告器来记录报告元素下方的题注或报告元素上方的标题。

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

类属性

HandleCompatible
true

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

创建对象

描述

示例

loc = mlreportgen.report.ListOfCaptions 创建具有默认属性值的 ListOfCaptions 报告器。通过设置 Title 属性来指定题注节的节标题。

lof = mlreportgen.report.ListOfCaptions(title) 创建一个 ListOfCaptions 报告器，并将 Title 属性设置为指定的标题。

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

属性

全部展开

题注列表的节标题，指定为以下值之一：

  • 字符串标量或字符向量

  • 内联 DOM 对象，例如 mlreportgen.dom.Text 对象

  • 1×N 或 N×1 字符串标量或内联 DOM 对象数组

  • 1×N 或 N×1 元胞数组，包含字符串、字符向量或内联 DOM 对象的任意组合

  • getTitleReporter 方法返回的 mlreportgen.report.Title 对象

编号流的名称，指定为字符向量或字符串标量。

题注和页码之间使用的引导符类型，指定为以下字符向量或字符串标量之一：

  • '.' 或 'dots'

  • ' ' 或 'space'

此属性仅适用于 PDF 报 告。Word 报告总是以点为引导符。HTML 报 告没有引导符。

题注列表节的页面布局，指定为 mlreportgen.report.ReporterLayout 对象。使用 ReporterLayout 对象的属性来覆盖一些默认的页面布局属性，例如页面方向。

此报告器的模板来源，指定为以下选项之一：

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

  • 报告器或报告，其模板用于此报告器，或其模板库包含此报告器的模板

  • DOM 文档或文档部件，其模板用于此报告器，或其模板库包含此报告器的模板

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

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

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

方法

全部展开

示例

全部折叠

打开实时脚本

此示例在报告中生成一个包含方程题注列表的节。您可以使用相同的过程来生成其他报告元素的题注列表。该示例通过将题注与名为 equation 的自动编号流关联来标识要包含在列表中的题注。您可以对编号流使用任何名称，只要该名称与代表题注列表的 ListOfCaptions 对象的 AutoNumberStream 属性值匹配即可。

导入 DOM 和报告 API 包，这样您就不必使用长而完全限定的类名。

import mlreportgen.dom.*
import mlreportgen.report.*

创建报告。

rpt = Report("My Report","pdf");

向报告中添加目录。

toc = TableOfContents;
append(rpt,toc);

创建题注列表节并将其添加到报告中。指定要包含在列表中的元素与数字流名称 equation 相关联。

loc = ListOfCaptions();
loc.Title = "List of Equations";
loc.AutoNumberStreamName = "equation";
append(rpt,loc);

创建一个章节并在章节中添加一个方程。

ch = Chapter("Physics Principles");
eq = Equation("e = m * c^2");
append(ch,eq);

为方程题注创建一个段落。 

p = Paragraph("Equation ");

创建一个名为 equation 的自动编号流并将其与段落关联。

append(p,AutoNumber("equation"));

增加编号流的计数器。

p.Style = {HAlign("center"),CounterInc("equation"),WhiteSpace("preserve")};

将其余题注文本追加到段落并将段落追加到章节。将该章节追加到报告中。

append(p,' Mass–energy equivalence');
append(ch,p);
append(rpt,ch);

关闭并查看报告。

close(rpt);
rptview(rpt);

以下是报告中方程的列表：

版本历史记录

在 R2020b 中推出

另请参阅

| | | | |

主题