Main Content

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

mlreportgen.report.ListOfFigures 类

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

人物报告器名单

自 R2020b 起

全页展开

描述

使用 mlreportgen.report.ListOfFigures 类的对象创建一个报告器，将图窗列表节添加到报告中。生成的图窗列表包含在报告生成程序中以 mlreportgen.report.FormalImage 或 mlreportgen.report.Figure 对象表示的图窗（图像）的题注。列表条目链接到报告中的题注。在 PDF 和 Word 报 告中，列表还包括报告中题注的页码。引导符填充了题注和页码之间的空白。

数字列表的生成方式取决于报告类型：

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

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

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

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

类属性

Abstract
true

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

创建对象

描述

示例

lof = mlreportgen.report.ListOfFigures 创建具有默认属性值的 ListOfFigures 报告器。

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

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

属性

全部展开

图窗列表节标题，指定为以下值之一：

  • 字符串标量或字符向量

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

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

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

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

如果不指定 Title 属性，则标题为 List of Figures。

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

  • '.' 或 'dots'

  • ' ' 或 'space'

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

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

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

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

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

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

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

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

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

方法

全部展开

示例

全部折叠

打开实时脚本

此示例使用 mlreportgen.report.TableOfContents 报告器向报告中添加目录，并使用 mlreportgen.report.ListOfFigures 报告器添加图窗列表节。报告中的图窗（图像）以 mlreportgen.report.Figure 或 mlreportgen.report.FormalImage 对象表示，以便 ListOfFigures 报告器将它们包含在图窗列表中。

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

import mlreportgen.report.*

创建报告。

rpt = Report("myFigureReport","pdf");
open(rpt);

创建目录并将其添加到报告中。

toc = TableOfContents();
append(rpt,toc);

创建图窗节列表并将其添加到报告中。

lof = ListOfFigures();
lof.Title = "My List of Figures";
append(rpt,lof);

创建一个章节并为该章节添加带题注的图像和图窗。

ch = Chapter("Images");
image1 = FormalImage(which("peppers.png"));
image1.Caption = "Peppers";
image1.Height = "5in";
append(ch,image1);
surf(peaks);
fig = Figure();
fig.Snapshot.Caption = '3-D shaded surface plot';
fig.Snapshot.Height = '5in';
append(ch,fig);

将该章节添加到报告中。关闭并查看报告。

append(rpt,ch);
delete(gcf);
close(rpt);
rptview(rpt);

以下是报告中的图窗列表：

版本历史记录

在 R2020b 中推出

另请参阅

| | | | |

主题