mlreportgen.report.Section 类

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

节报告器

全页展开

描述

创建一个节报告器，将一个节添加到报告。此类继承自 mlreportgen.report.Reporter

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

类属性

HandleCompatible true

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

创建对象

描述

section = Section 创建一个生成报告节的报告器。您可以将章节报告器添加到报告、章节或其他章节中。如果向报告添加一个节，该节将从一个新的纵向页面开始，具有默认页边距和页脚中的页码。页码等于前一页码加一。如果您将该节添加到章节或其他节中，报告器将创建一个延续当前页面的子节。默认情况下，标题的大小会随着报告层次结构中节的深度而减小，最多可达五级。低于 5 级的章节标题没有编号，并且字体大小与 5 级相同。

section = Section(title) 创建一个包含具有指定标题文本的节标题的报告节。默认情况下，分层章节编号作为标题文本的前缀。例如第二章第一小节的默认编号为 2.1。标题的字体大小默认随着报告层次结构中节的深度而减小，最多可达五级。

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

示例

属性

全部展开

`Title` — 节标题
字符串标量 | 字符串数组 | 字符向量 | DOM 对象 | `SectionTitle` 报告器

章节标题，指定为以下值之一：

字符向量或字符串标量
DOM 对象
1×N 或 N×1 字符串标量或 DOM 对象数组
1×N 或 N×1 字符串标量、字符向量和 DOM 对象的元胞数组
getTitleReporter 方法返回的 mlreportgen.report.Title 对象

内联对象是段落可以包含的对象。如果标题值是内联对象，则节对象使用一组模板中的一个模板。模板存储在该节的模板库中。创建标题所用的模板取决于标题是否编号以及章节层次结构中的章节级别。使用 Numbered 属性指定章节标题是否编号。

如果标题值是 DOM 段落或其他 DOM 模块对象，则该节会将该对象插入到节的开头。如果使用 DOM 模块对象，则可以使用模块元素自定义节标题的间距、对齐方式和其他属性。在这种情况下，您必须自己完整指定标题格式并提供标题编号。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`Numbered` — 是否为本节编号
`[]` (默认) | 逻辑值 `1` (`true`) | `0` (`false`)

若要为本节编号，请将指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 该部分的编号是相对于报告中的其他部分而言的。章节编号出现在章节标题中。
0 (false) - 本节未编号。

此 Numbered 属性的值将覆盖 mlreportgen.report.Section.number 方法为所有报告节指定的编号。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: logical

`Content` — 此节的内容
字符向量 | 字符串标量 | 内联对象

此节的内容，指定为以下值之一：

字符串或字符向量
可以添加到 DOM 文档部件的 DOM 对象
1x N 或 N x1 字符串或字符向量数组
1x N 或 N x1 由字符串标量、字符数组和 DOM 对象组成的元胞数组
报告器，包括 Section 报告器

使用 Section 构造函数或 add 方法来设置此属性。您不能直接设置它。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`TemplateSrc` — 此报告器的模板来源
字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

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

字符向量或字符串标量，指定包含此报告器模板的文件的路径
此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告
文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`
`Dependent`	`true`

`TemplateName` — 此报告器的模板名称
字符向量 | 字符串标量

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`LinkTarget` — 此报告器的超链接目标
`[]` (默认) | 字符向量 | 字符串标量 | `mlreportgen.dom.LinkTarget` 对象

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

属性：

`GetAccess`	`public`
`SetAccess`	`public`

方法

全部展开

公共方法

方法	用途
`append`	向该节添加内容
`number`	设置章节编号
`getTitleReporter`	创建一个节标题报告器
`mlreportgen.report.Section.createTemplate`	创建报告器模板 `template = createTemplate(templatePath,templateType)` 在 `templatePath` 指定的位置，为 `templateType` 指定的报告类型创建默认模板的副本。您可以使用复制的模板作为起点，为您的报告设计自定义的报告模板。输入参量 `templatePath` - 模板文件的目标路径和文件名，指定为字符向量或字符串标量。 `templateType` - 模板类型，指定为 `"html"`、`"docx"` 或 `"pdf"` 返回值 `template` - 模板副本的路径和文件名，以字符串标量形式返回。有关详细信息，请参阅 `Reporter` 类的 `mlreportgen.report.Reporter.createTemplate` 方法。
`mlreportgen.report.Section.customizeReporter`	从 `mlreportgen.report.Section` 类创建报告器 `classPathOut = customizeReporter(classPath)` 创建一个报告类定义文件，该文件在 `classPath` 指定的位置定义 `mlreportgen.report.Section` 的子类。该方法将默认报告器模板复制到包含类定义文件的文件夹下的 `resources/templates` 子文件夹中。您可以使用类定义文件作为起点来设计自定义报告器类。输入参量 `classPath` - 新类定义文件的路径和名称，指定为字符向量或字符串标量返回值 `classPathOut` - 新类的路径和文件名，以字符串标量形式返回有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `mlreportgen.report.Reporter.customizeReporter` 方法。
`mlreportgen.report.Section.getClassFolder`	获取包含 `mlreportgen.report.Section` 类定义文件的文件夹位置 `path = getClassFolder` 返回包含类定义文件的文件夹的路径。返回值 `path` - 类定义文件的位置，以字符向量形式返回。有关详细信息，请参阅 `Reporter` 类的 `mlreportgen.report.Reporter.getClassFolder` 方法。
`copy`	创建报告器对象的副本，并对属性值进行深拷贝 `copiedObj = copy(reporterObj)` 返回指定报告对象的副本。返回的副本包含引用报告器、DOM 对象或 `mlreportgen.report.ReporterLayout` 对象的 `reporterObj` 的任何属性值的深拷贝。因此，您可以修改原始对象或新对象的属性，而不会影响其他对象。输入参量 `reporterObj` - 要复制的报告器对象，指定为报告器类的对象返回值 `copiedObj` - 报告器的副本，以报告器类对象形式返回有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `copy` 方法。
`getImpl`	获取报告器的实现 `impl = getImpl(reporter,report)` 返回在将报告器 `reporter` 追加到报告 `report` 时实现该报告器的文档对象模型 (DOM) 对象。注意调用此方法后，您无法再向报告器添加内容。输入参量 `reporterObj` - 报告器对象，指定为 `mlreportgen.report.Reporter` 的对象或 `mlreportgen.report.Reporter` 的子类的对象 `report` - 报告，指定为 `mlreportgen.report.Report` 对象返回值 `impl` - 实现对象，以 DOM 对象形式返回。有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `getImpl` 方法。
`add`	(不建议) 在该部分添加内容

示例

全部折叠

向报告节添加内容

打开实时脚本

将节添加到章中，将章添加到报告。将章节的布局方向设置为横向。

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

theReport = Report("SectionExampleReport","pdf");

append(theReport,TitlePage(Title="Report with Sections"));

append(theReport,TableOfContents);
 
theChapter = Chapter("Images");
append(theChapter,Section(Title="Boeing 747",Content=Image("BoeingSectionExample.jpg")));
append(theChapter,Section(Title="Peppers",Content=Image("PeppersSectionExample.png")));
append(theReport,theChapter);

close(theReport);
rptview(theReport);

以下是生成的报告中包含图像的节。

使用 DOM 文本对象作为章节标题

此示例使用 DOM Text 对象来定义标题。通过使用 DOM 对象，您可以设置其属性并覆盖节标题的默认黑色。

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

rpt = Report("New Report","pdf");
open(rpt)
sect = Section;
sect.Title = Text("A Section");
sect.Title.Color = "blue";
append(rpt,sect);

close(rpt)
rptview(rpt)

Example of title defined as "A Section" in displaying in blue

更改节的对齐方式

打开实时脚本

创建 HTML 报告并将子节标题设置为居中对齐。

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

rpt = Report('My Report','html');
append(rpt,TitlePage(Title='My Report'));
append(rpt,TableOfContents);
chTitle = Heading1('Chapter ');
chTitle.Style = {CounterInc('sect1'),...
     WhiteSpace('preserve')...
     Color('black'),...
     Bold, FontSize('24pt')};
append(chTitle,AutoNumber('sect1'));
append(chTitle,'. ');

sectTitle = Heading2();
sectTitle.Style = {CounterInc('sect2'),...
     WhiteSpace('preserve') ...
     HAlign('center'),PageBreakBefore};
append(sectTitle,AutoNumber('sect1'));
append(sectTitle,'.');
append(sectTitle,AutoNumber('sect2'));
append(sectTitle,'. ');
title = clone(chTitle);
append(title,'Images');
ch = Chapter(Title=title);
title = clone(sectTitle());
append(title,'Boeing 747');
append(ch,Section(Title=title,Content=Image(which('b747.jpg'))));
title = clone(sectTitle());
append(title,'Peppers');
append(ch,Section(Title=title,Content=Image(which('peppers.png'))));

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

版本历史记录

在 R2017b 中推出

另请参阅

mlreportgen.report.Report | mlreportgen.report.Reporter