mlreportgen.report.SummaryTable Class

Namespace: mlreportgen.report
Superclasses: mlreportgen.report.Reporter

Summarize finder results

Since R2022a

Description

Use an instance of mlreportgen.report.SummaryTable class to generate a table that summarizes the results of a search by a MATLAB^® Report Generator™ finder object. The table lists the key properties of each finder result object. For more information, see finder result class.

The mlreportgen.report.SummaryTable class is a handle class.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

summaryTableRptr = mlreportgen.report.SummaryTable creates an empty summary table reporter. Use the FinderResults property to specify the results to summarize.

Note

Adding an empty MATLAB summary table reporter to a report causes an error.

summaryTableRptr = mlreportgen.report.SummaryTable(finderResults) creates a summary table reporter for the result objects in the array finderResults and sets the FinderResults property to finderResults.

summaryTableRptr = mlreportgen.report.SummaryTable(Name=Value) sets properties by using name-value arguments. Specify multiple name-value arguments in any order.

Properties

FinderResults — Finder result objects to report

finder result objects

Finder result objects to report, specified as an array of objects of a finder result class such as mlreportgen.finder.MATLABVariableResult or mlreportgen.finder.AxesResult.

Attributes:

GetAccess	public
SetAccess	public

Title — Title for summary table

character vector | string scalar | DOM object

Title for the summary table, specified as a string, character vector, or a DOM object. By default, this property is empty and the reporter creates the table title by using the getDefaultSummaryTableTitle method for the finder result object specified by finderResults.

Specifying this property as a character vector or string scalar creates an mlreportgen.dom.Paragraph object with Style property set to "SummaryTableTitleParagraph".

Attributes:

GetAccess	public
SetAccess	public

Properties — Properties of result class to report

array | cell array

Properties of the result class to report on, specified as an array of string scalars or cell array of character vectors.

If Properties is empty, the reporter determines which finder result object properties to report by using the getDefaultSummaryProperties method of the finder result object specified by finderResults.

The summary table contains a row for each result whose entries contain properties of the found object. By default, the reported properties depend on the result object type. Use the summary table reporters Properties properties to customize the set of properties to report on.

Use the getPropertyValues method of the finder result object specified by finderResults to identify the properties you can add to the summary table.

Attributes:

GetAccess	public
SetAccess	public

Data Types: cell

IncludeLinks — Whether to link to corresponding result object

1 (true) (default) | 0 (false)

Whether to link the Title property of each object in the summary table to the corresponding reporter object, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Link the Title property of each object in the summary table to the corresponding reporter object.

• 0 (false) — Do not link the Title property of each object in the summary table to the corresponding reporter object.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ShowEmptyColumns — Whether to include columns for empty result properties

0 (false) (default) | 1 (true)

Whether to include columns for empty finder result object properties in the summary tables, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Include columns for empty finder result object properties.

• 0 (false) — Omit columns for empty finder result object properties.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

TableReporter — Table reporter formatter

mlreportgen.report.BaseTable object

Table reporter formatter type, specified as an mlreportgen.report.BaseTable object. Customize the appearance of the summary table by customizing the default reporter or by replacing it with a customized BaseTable reporter.

Attributes:

GetAccess	public
SetAccess	public

TemplateSrc — Source of template for this reporter

character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified in one of these ways:

• Character vector or string scalar that specifies the path of the file that contains the template for this reporter

• Reporter or report whose template this reporter uses or whose template library contains the template for this reporter

• Document Object Model (DOM) document or document part whose template this reporter uses or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. For example, for a Microsoft^® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true
Dependent	true

TemplateName — Name of template for this reporter

character vector | string scalar

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template specified by the TemplateSrc property of this reporter.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

Method	Purpose
mlreportgen.report.SummaryTable.createTemplate	Create reporter template template = createTemplate(templatePath,templateType) creates a copy of the default template for the report type specified by templateType at the location specified by templatePath. You can use the copied template as a starting point to design a custom reporter template for your report. Input Arguments templatePath — Target path and file name for template file, specified as a character vector or a string scalar. templateType — Template type, specified as "html", "docx", or "pdf" Return Values template — Path and file name of the template copy, returned as a string scalar For more information, see the method for the Reporter class, mlreportgen.report.Reporter.createTemplate.
mlreportgen.report.SummaryTable.customizeReporter	Create reporter from mlreportgen.report.SummaryTable class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of mlreportgen.report.SummaryTable at the location specified by classPath. The method copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom reporter class. Input Arguments classPath — Path and name of the new class definition file, specified as a character vector or string scalar Return Values classPathOut — Path and file name of the new class, returned as a string scalar For more information, see the method for the mlreportgen.report.Reporter class, mlreportgen.report.Reporter.customizeReporter.
mlreportgen.report.SummaryTable.getClassFolder	Get location of folder that contains mlreportgen.report.SummaryTable class definition file path = getClassFolder returns the path of the folder that contains the class definition file. Return Values path — Class definition file location, returned as a character vector For more information, see the method for the Reporter class, mlreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of property values copiedObj = copy(reporterObj) returns a copy of the specified reporter object. The returned copy contains a deep copy of any property value of reporterObj that references a reporter, DOM object, or mlreportgen.report.ReporterLayout object. As a result, you can modify the properties of the original or new object without affecting the other object. Input Arguments reporterObj — Reporter object to copy, specified as an object of a reporter class Return Values copiedObj — Copy of reporter, returned as an object of a reporter class For more information, see the method for the mlreportgen.report.Reporter class, copy.
getImpl	Get implementation of reporter impl = getImpl(reporter,report) returns the Document Object Model (DOM) object that implements the reporter, reporter, when you append it to the report, report. Note You cannot add content to the reporter after calling this method. Input Arguments reporterObj— Reporter object, specified as an object of mlreportgen.report.Reporter or an object of a subclass of mlreportgen.report.Reporter report — Report, specified as a mlreportgen.report.Report object Return Values impl — Implementation object, returned as a DOM object. For more information, see the method for the mlreportgen.report.Reporter class, getImpl.

Examples

Add Summary Table Reporter to Report

This example shows how to add a summary table for the results of an mlreportgen.finder.AxesFinder object.

Create a PDF report.

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",""));

Create a figure handle and the axes to report.

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");

Create an AxesFinder object to find the axes.

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

Pass the results of the find method to a SummaryTable reporter.

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

More About

finder result class

A finder result class is a Report API class that is a subclass of the mlreportgen.finder.Result class, which is an undocumented, internal class.

Version History

Introduced in R2022a