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

mlreportgen.report.TableOfContents 类

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

目录报告器

全页展开

描述

创建目录 (TOC) 报告器，将目录添加到报告。此类继承自 mlreportgen.report.Reporter。

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

创建对象

描述

toc = TableOfContents 返回一个为报告生成目录 (TOC) 节的报告器。TOC 节的默认模板定义了 TOC 的外观和页面布局。TOC 节包含一个默认标题和一个 TOC 元素，该元素根据报告输出类型指定要生成的 TOC 的位置。每种报告类型的目录生成方式都不同。

  • HTML - 从报告模板复制到报告的 JavaScript® 会在浏览器中打开报告时生成目录。该脚本将目录生成为可折叠树。树条目是报告的 HTML 标题元素（h1-h6）的超链接内容。TOC 树中条目的级别与标题元素的级别相对应。章节和节报告器生成章节和节标题作为适当级别的标题元素，因此章节和节标题会自动出现在目录中。您还可以使用报告中的 DOM 标题元素来生成 TOC 条目。

  • DOCX -报告生成器 rptview 函数指示 Word 在 Word 中打开报告后生成目录。如果您直接在 Word 中打开报告，而不使用 rptview，则必须自行更新报告文档以生成目录。请参阅更新 Word 文档中的目录和生成的列表。

    目录是一个包含两列的表。第一列包含已设置大纲级别的报告段落的超链接内容。大纲级别决定了目录条目的格式。第二列包含相应段落所在的页码。章节和节报告器将章节和节标题生成为具有适当级别设置的段落，因此章节和节标题会自动出现在目录中。您还可以使用报告中的 DOM 标题元素来生成 TOC 条目。

  • PDF - 在生成 PDF 文档期间会生成目录。

toc = TableOfContents(title) 创建使用指定 title 的 TOC。

示例

toc = TableOfContents(Name=Value) 使用名称-值参量设置属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

目录标题，指定为以下值之一：

  • 字符串或字符向量

  • DOM 对象

  • 1×N 或 N×1 字符串或 DOM 对象数组

  • 由字符串、字符向量和/或 DOM 对象组成的 1×N 或 N×1 元胞数组

  • TableOfContentsTitle 报告器

示例: "TableOfContents","Report Contents"

属性：

GetAccess
public
SetAccess
public

目录中使用的标题级别数，指定为 [1,9] 范围内的正整数。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

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

  • "." 或 "dots"

  • " " 或 "space"

注意

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public

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

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

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

  • 文档对象模型 (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 mlreportgen.report.*
rpt = Report("output","pdf");
toc = TableOfContents();
add(rpt,toc);

创建一份包含带有绿色标题的目录的报告。本报告还包括章、节和附录部分。

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

rpt = Report("Report with TOC");
add(rpt, TitlePage(Title="Report",Subtitle="with TOC"));
toc = TableOfContents;
toc.Title = Text("Table of Contents");
toc.Title.Color = "green";
toc.NumberOfLevels = 2; 
add(rpt,toc);

ch = Chapter("First Chapter");
add(ch,Section("First Subsection"));
add(ch,Section("Second Subsection"));

add(rpt,ch);
add(rpt,Chapter("Second Chapter"));

add(rpt,PDFPageLayout);
p = Paragraph("Appendix"); 
p.Style = {OutlineLevel(1), Bold, FontSize("18pt")};
add(rpt,p);

close(rpt);
rptview(rpt);

Report that includes a table of contents with a title in green.

提示

报告模板决定了此报告器生成的 TOC 的大小、间距、颜色和其他格式属性。默认的 Microsoft Word 和 PDF 模板为目录中的每个条目包含默认样式。要更改目录的格式，请创建一个自定义报告模板来重新定义这些样式，并在生成报告时使用该模板。请参阅 mlreportgen.report.Report.createTemplate。样式名称为 TOC1、TOC2、…、TOC6，其中样式 TOC1 定义第 1 级条目的格式，样式 TOC2 定义第 2 级条目的格式，依此类推。

版本历史记录

在 R2017b 中推出

全部展开

另请参阅

|

主题