mlreportgen.report.SummaryTable 类

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

汇总查找器结果

自 R2022a 起

描述

使用 mlreportgen.report.SummaryTable 类的实例来生成一个表，该表总结了 MATLAB^® Report Generator™ 查找器对象搜索的结果。下表列出了每个查找器结果对象的关键属性。有关详细信息，请参阅查找器结果类。

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

类属性

HandleCompatible true

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

创建对象

描述

summaryTableRptr = mlreportgen.report.SummaryTable 创建一个空的摘要表报告器。使用 FinderResults 属性指定要汇总的结果。

注意

向报告中添加空的 MATLAB 摘要表报告器会导致错误。

summaryTableRptr = mlreportgen.report.SummaryTable(finderResults) 为数组 finderResults 中的结果对象创建一个摘要表报告器，并将 FinderResults 属性设置为 finderResults。

示例

summaryTableRptr = mlreportgen.report.SummaryTable(Name=Value) 使用名称-值参量设置属性。以任意顺序指定多个名称-值参量。

属性

全部展开

`FinderResults` — 要报告的 Finder 结果对象
查找器结果对象

要报告的 Finder 结果对象，指定为查找器结果类对象数组（例如 mlreportgen.finder.MATLABVariableResult 或 mlreportgen.finder.AxesResult）。

属性：

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

`Title` — 摘要表标题
字符向量 | 字符串标量 | DOM 对象

摘要表的标题，指定为字符串、字符向量或 DOM 对象。默认情况下，该属性为空，报告器使用 getDefaultSummaryTableTitle 方法为 finderResults 指定的查找器结果对象创建表标题。

将此属性指定为字符向量或字符串标量将创建一个 mlreportgen.dom.Paragraph 对象，其 Style 属性设置为 "SummaryTableTitleParagraph"。

属性：

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

`Properties` — 要报告的结果类的属性
数组 | 元胞数组

要报告的结果类的属性，指定为字符串标量数组或字符向量元胞数组。

如果 Properties 为空，则报告器使用 getDefaultSummaryProperties 指定的查找器结果对象的 finderResults 方法来确定要报告哪些查找器结果对象属性。

摘要表为每个结果包含一行，其条目包含找到的对象的属性。默认情况下，报告的属性取决于结果对象类型。使用摘要表报告器 Properties 属性来自定义要报告的属性集。

使用 getPropertyValues 指定的查找器结果对象的 finderResults 方法来识别可以添加到摘要表中的属性。

属性：

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

数据类型: cell

`IncludeLinks` — 是否链接到相应的结果对象
`1` (`true`) (默认) | `0` (`false`)

是否将摘要表中每个对象的 Title 属性与相应的报告器对象关联，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 将汇总表中每个对象的 Title 属性与相应的报告器对象建立关联。
0 (false) - 请勿将摘要表中每个对象的 Title 属性与相应的报告器对象建立关联。

属性：

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

数据类型: logical

`ShowEmptyColumns` — 是否包含空结果属性的列
`0` (`false`) (默认) | `1` (`true`)

是否在摘要表中包含空查找器结果对象属性的列，指定为逻辑值 1 (true) 或 0 (false)。当您指定：

1 (true) - 为空的查找器结果对象属性添加列。
0 (false) - 省略查找器结果对象中为空的属性对应的列。

属性：

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

数据类型: logical

`TableReporter` — 表报告格式化器
`mlreportgen.report.BaseTable` 对象

表报告器格式化程序类型，指定为 mlreportgen.report.BaseTable 对象。通过自定义默认报告器或用自定义的 BaseTable 报告器替换它来自定义摘要表的外观。

属性：

`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`

方法

全部展开

公共方法

方法	用途
`mlreportgen.report.SummaryTable.createTemplate`	创建报告器模板 `template = createTemplate(templatePath,templateType)` 在 `templatePath` 指定的位置，为 `templateType` 指定的报告类型创建默认模板的副本。您可以使用复制的模板作为起点，为您的报告设计自定义的报告模板。输入参量 `templatePath` - 模板文件的目标路径和文件名，指定为字符向量或字符串标量。 `templateType` - 模板类型，指定为 `"html"`、`"docx"` 或 `"pdf"` 返回值 `template` - 模板副本的路径和文件名，以字符串标量形式返回。有关详细信息，请参阅 `Reporter` 类的 `mlreportgen.report.Reporter.createTemplate` 方法。
`mlreportgen.report.SummaryTable.customizeReporter`	从 `mlreportgen.report.SummaryTable` 类创建报告器 `classPathOut = customizeReporter(classPath)` 创建一个报告类定义文件，该文件在 `classPath` 指定的位置定义 `mlreportgen.report.SummaryTable` 的子类。该方法将默认报告器模板复制到包含类定义文件的文件夹下的 `resources/templates` 子文件夹中。您可以使用类定义文件作为起点来设计自定义报告器类。输入参量 `classPath` - 新类定义文件的路径和名称，指定为字符向量或字符串标量返回值 `classPathOut` - 新类的路径和文件名，以字符串标量形式返回有关详细信息，请参阅 `mlreportgen.report.Reporter` 类的 `mlreportgen.report.Reporter.customizeReporter` 方法。
`mlreportgen.report.SummaryTable.getClassFolder`	获取包含 `mlreportgen.report.SummaryTable` 类定义文件的文件夹位置 `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` 方法。

示例

全部折叠

将摘要表报告器添加到报告中

此示例显示如何为 mlreportgen.finder.AxesFinder 对象的结果添加摘要表。

创建 PDF 报告。

import mlreportgen.report.*
import mlreportgen.finder.*

rpt = mlreportgen.report.Report("Summary Table Results","pdf");
add(rpt,TitlePage("Title",sprintf("Summary Table for Axes Finder Results"),"Author",""));

创建图窗手柄和要报告的坐标区。

figH = figure;
ax1 = subplot(3,2,2);
x = linspace(0,20);
y1 = cos(x);
plot(x,y1);
ax1.Title = title("Example Plot 1");

ax2 = subplot(3,2,4);
y2 = sin(tan(x).*x);
plot(x,y2);
ax2.Title = title("Example Plot 2");

创建一个 AxesFinder 对象来查找坐标区。

finderObj = mlreportgen.finder.AxesFinder(figH);
results = find(finderObj);

将 find 方法的结果传递给 SummaryTable 报告器。

rptr = mlreportgen.report.SummaryTable(results);
rptr.ShowEmptyColumns = true;
append(rpt,rptr);
close(rpt);
rptview(rpt);

详细信息

全部展开

查找器结果类

查找器结果类是一个报告 API 类，它是 mlreportgen.finder.Result 类的子类，是一个未记录的内部类。

版本历史记录

在 R2022a 中推出

另请参阅

mlreportgen.report.Report | mlreportgen.report.Reporter

mlreportgen.report.SummaryTable 类

描述

类属性

创建对象

描述

属性

FinderResults — 要报告的 Finder 结果对象 查找器结果对象

属性：

Title — 摘要表标题 字符向量 | 字符串标量 | DOM 对象

属性：

Properties — 要报告的结果类的属性 数组 | 元胞数组

属性：

IncludeLinks — 是否链接到相应的结果对象 1 (true) (默认) | 0 (false)

属性：

ShowEmptyColumns — 是否包含空结果属性的列 0 (false) (默认) | 1 (true)

属性：

TableReporter — 表报告格式化器 mlreportgen.report.BaseTable 对象

属性：

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

属性：

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

属性：

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

属性：

方法

公共方法

示例

将摘要表报告器添加到报告中

详细信息

查找器结果类

版本历史记录

另请参阅

主题

`FinderResults` — 要报告的 Finder 结果对象
查找器结果对象

`Title` — 摘要表标题
字符向量 | 字符串标量 | DOM 对象

`Properties` — 要报告的结果类的属性
数组 | 元胞数组

`IncludeLinks` — 是否链接到相应的结果对象
`1` (`true`) (默认) | `0` (`false`)

`ShowEmptyColumns` — 是否包含空结果属性的列
`0` (`false`) (默认) | `1` (`true`)

`TableReporter` — 表报告格式化器
`mlreportgen.report.BaseTable` 对象

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

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

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