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

mlreportgen.dom.LOF 类

命名空间: mlreportgen.dom
超类: mlreportgen.dom.LOC

图窗列表

全页展开

描述

使用 mlreportgen.dom.LOF 类的实例在报告中生成一组图表。

每个列表项包含一个图窗（图像）的题注和指向报告中题注的链接。在 PDF 或 Microsoft® Word 报告中，列表项还包括页码和填充题注与页码之间空白的引导符。在 PDF 或 Word 报告中，列表位于报告中追加 LOC 对象的位置。在 HTML 报告中，该列表位于侧边栏，标题为 List of Figures。

列表的生成方式取决于报告类型。

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

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

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

要将图窗（图像）包含在图窗列表中：

  1. 使用 mlreportgen.dom.Paragraph 对象为图窗创建题注。

  2. 使用 mlreportgen.dom.AutoNumber 对象将 Paragraph 对象与名为 figure 的编号流关联。

要了解可以将 mlreportgen.dom.LOF 对象追加到哪些 DOM 对象，请参阅将 mlreportgen.dom.LOF 对象追加到 DOM 类对象上。

mlreportgen.dom.LOF 类是一个 handle 类。

类属性

ConstructOnLoad
true
HandleCompatible
true

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

创建对象

描述

lofObj = mlreportgen.dom.LOF() 创建一个 mlreportgen.dom.LOF 对象并将 LeaderPattern 属性设置为 "."。

示例

lofObj = mlreportgen.dom.LOF(leaderPattern) 创建一个 mlreportgen.dom.LOF 对象，并将 LeaderPattern 属性设置为指定的引导符模式。

属性

全部展开

编号流的名称，指定为 "figure"。

注意

请勿更改此属性的值。要使用自定义编号流名称创建题注列表，请使用 mlreportgen.dom.LOC 对象。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

  • "." 或 "dots"

  • " " 或 "space"

注意

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

样式表中定义的样式名称，指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了该元素在输出文档中的外观，除非该元素的 Style 属性指定的格式覆盖了该样式。要了解有关使用样式表的更多信息，请参阅 使用样式表样式。

注意

Microsoft Word 报告会忽略文档模板中未定义的样式名称。有关 Microsoft Word 模板的详细信息，请参阅DOM API 报告程序模板。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此文档元素对象的格式规范，指定为 DOM 格式对象元胞数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此文档元素对象的格式将被忽略。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: cell

文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

此对象的父对象，指定为文档元素对象。一个文档元素必须只有一个父元素。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

此对象的子对象，指定为文档元素对象数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

打开实时脚本

创建一个图窗列表作为 mlreportgen.dom.LOF 对象。要将图片包含在列表中：

  • 为图窗创建题注作为 mlreportgen.dom.Paragraph 对象。

  • 将 Paragraph 对象与名为 figure 的编号流关联。

导入 DOM 命名空间，这样您就不必使用长而完全限定的类名。

import mlreportgen.dom.*

创建报告。

d = Document("DOM Report with List of Figures","docx");

创建一个 LOF 对象并将其追加到报告中。

LOFObj = LOF();
append(d,LOFObj);
append(d,PageBreak);

在报告中包含图像（图窗）。

append(d,Image('peppers.png'));

为图窗题注创建一个段落。 

p1 = Paragraph("Figure ");

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

append(p1,AutoNumber("figure"));

增加编号流的计数器。

p1.Style = {CounterInc("figure"),WhiteSpace("preserve")};

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

append(p1,".");
append(p1," Peppers");
append(d,p1);

在报告中包含另一幅图像并为该图创建题注。将题注与图窗编号流关联。 

append(d,Image("b747.jpg"));
p2 = Paragraph("Figure ");
append(p2,AutoNumber("figure"));
p2.Style = {CounterInc("figure"),WhiteSpace("preserve")};

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

append(p2,".");
append(p2," Airplane");
append(d,p2);

关闭并查看报告。

close(d);
rptview(d);

以下是生成的报告中的数字列表：

详细信息

全部展开

版本历史记录

在 R2020b 中推出

另请参阅

| | | |

主题