mlreportgen.report.TableOfContentsclass

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

目录的记者

描述

创建一个目录(TOC)记者,添加一个目录。这个类继承自mlreportgen.report.Reporter。

的mlreportgen.report.TableOfContents类是一个处理类。

创建

描述

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

HTML, JavaScript抄袭报告报告模板生成TOC报表时在浏览器中打开。脚本生成TOC作为一个可折叠树。这棵树条目的超链接内容的HTML标题元素(h1-h6)的报告。目录树中的一个条目的对应级别的标题元素。章和节记者生成章节和段落标题标题元素的适当水平,所以章,章节标题自动出现在TOC。在一份报告中还可以使用DOM标题元素生成TOC条目。
多克斯——报告生成器rptview功能指示词生成TOC后打开报告在字(词)。如果你直接打开一个报告在字(词),不使用rptview,你必须更新报告文档生成TOC。看到更新表的内容和在Word文档中生成的列表。
TOC是一个两列表格。第一列包含超链接的内容报告已设置段落的大纲级别。轮廓水平决定了一个TOC条目的格式。第二列包含的页面的数量相应的段落。章和节记者生成章节和段落标题与段落适当的水平集,所以章,章节标题自动出现在TOC。在一份报告中还可以使用DOM标题元素生成TOC条目。
生成PDF -目录中生成PDF文档。

例子

toc= TableOfContents (标题)创建一个使用指定的目录标题。

toc= TableOfContents (名称=值)使用名称-值对集合属性。你可以在任何顺序指定多个参数名称-值对。

属性

全部展开

`标题`- - - - - -目录标题
`表的内容`(默认)|字符串|字符数组|……

目录标题,指定这些值之一:

字符串或字符数组
DOM对象
1 -N或N1的字符串数组或DOM对象
1 -N或N1单元阵列的字符串、字符数组和/或DOM对象
TableOfContentsTitle记者

例子:“TableOfContents”、“报告内容的

`NumberOfLevels`- - - - - -标题的数量水平
3(默认)|正整数

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

`LeaderPattern`- - - - - -类型的领袖
`“。”`(默认)|“点”|`' '`|“空间”

类型的领导人使用标题和页码之间,指定为这些特征向量或字符串标量之一:

“。”或“点”
' '或“空间”

这个属性只适用于PDF报告。字的报告总是有一个点的领导者。HTML报告没有领袖。

`布局`- - - - - -目录部分的页面布局
`mlreportgen.report.ReporterLayout`对象

页面布局的目录部分,指定为一个mlreportgen.report.ReporterLayout对象。使用的属性ReporterLayout对象来覆盖默认的页面布局的一些属性,比如页面方向。

`TemplateSrc`- - - - - -这个记者的模板
`[]`(默认)|特征向量|字符串标量|记者或报告|DOM文档或文档部分

这个记者的模板,指定为这些选项之一:

特征向量或字符串标量指定路径的文件,其中包含的模板的记者
记者或报告的模板是用于这个记者或模板库中包含的模板的记者
DOM文档或文档模板的一部分用于记者或模板库中包含的模板的记者

指定的模板必须是相同的类型作为这个记者是附加的报告。例如,对于一个微软^®词报告,TemplateSrc必须是一个文字记者模板。如果TemplateSrc属性是空的,这个记者记者使用默认模板输出类型的报告。

`TemplateName`- - - - - -这个记者名字的模板
特征向量|字符串标量

模板的名字为这个记者,指定为一个特征向量或字符串标量。这个记者的模板必须在模板的模板库源(TemplateSrc这个记者)。

`LinkTarget`- - - - - -这个记者超链接的目标
`[]`(默认)|特征向量|字符串标量|`mlreportgen.dom.LinkTarget`对象

这个记者,超链接目标指定为一个特征向量或字符串标量指定链接ID或作为一个目标mlreportgen.dom.LinkTarget对象。一个特征向量或字符串转换为一个标量值LinkTarget对象。链接目标立即先于这个记者在输出中报告的内容。

方法

全部展开

公共方法

`mlreportgen.report.TableOfContents.createTemplate`	创建目录部分模板
`mlreportgen.report.TableOfContents.customizeReporter`	创建自定义目录记者类
`mlreportgen.report.TableOfContents.getClassFolder`	目录类定义文件的位置
`getTitleReporter`	目录标题的记者
`复制`	创建的副本记者对象,使深拷贝的某些属性值
`getImpl`	得到实现的记者

例子

全部折叠

默认目录

创建一个目录,使用默认格式。

进口mlreportgen.report。*rpt =报告(“输出”,“pdf”);toc = TableOfContents ();add (rpt, toc);

自定义目录

创建一个报告,其中包括一个目录标题在绿色。这份报告还包括章节,章节和附录部分。

进口mlreportgen.report。*进口mlreportgen.dom。*rpt =报告(“报告TOC”);添加(rpt, TitlePage(标题=“报告”字幕=“与TOC”));toc = TableOfContents;toc。Title =文本(“目录”);toc.Title。颜色=“绿色”;toc。NumberOfLevels = 2; add(rpt,toc); ch = Chapter(“第一章”);添加(ch,部分(“第一节”));添加(ch,部分(第二小节的));add (rpt, ch);add (rpt,章(“第二章”));add (rpt, PDFPageLayout);p =段(“附录”);p。风格= {OutlineLevel(1)、粗体字形大小(“18 pt”)};添加(rpt, p);关闭(rpt);rptview (rpt);