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 (Simulink Report Generator) 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

true (default) | false

Whether to link the Title property of each object in the summary table to link to the corresponding reporter object, specified as true or false.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ShowEmptyColumns — Whether to include columns for empty result properties

false (default) | true

Whether to include columns for empty finder result object properties in the summary tables, specified as false or true.

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

Methods

Public Methods

Method	Purpose
mlreportgen.report.SummaryTable.createTemplate	template = mlreportgen.report.SummaryTable.createTemplate(path,type) Create reporter template Input Arguments path, Target path and file name for template file type, 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 equivalent method for the Reporter class, mlreportgen.report.Reporter.createTemplate.
mlreportgen.report.SummaryTable.customizeReporter	reporter = mlreportgen.report.SummaryTable.customizeReporter(classpath) Create reporter derived from mlreportgen.report.SummaryTable class Return Values reporter — Path and file name of the new reporter class, returned as a string scalar. For more information, see the equivalent method for the Reporter class, mlreportgen.report.Reporter.customizeReporter.
mlreportgen.report.SummaryTable.getClassFolder	path = mlreportgen.report.SummaryTable.getClassFolder Get location of folder that contains mlreportgen.report.SummaryTable class definition file Return Values path — Class definition file location, returned as a character vector. For more information, see the equivalent method for the Reporter class, mlreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of certain property values
getImpl	Get implementation of reporter

Examples

Add Summary Table Reporter to Report

This example shows how to add a summary table for the results of an mlreportgen.report.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