Learn more about MATLAB Report Generator

Working with Summary Table Components

On this page…
About Summary Table Components Opening the Example Report Template Selecting Object Types Adding and Removing Properties Setting Relative Column Widths Setting Object Row Options

About Summary Table Components

Summary Table components insert tables that include specified properties for objects into generated reports. Tables contain one object per row, with each object property appearing in a column, as shown in the following Summary Table in the figloop-tutorial report.

Many types of Summary Table components are available, including:

• Handle Graphics Summary Table

• Simulink Summary Table

• Stateflow Summary Table

The component used in this example represents MATLAB Report Generator Summary Table components, all of which exhibit similar behavior

Back to Top

Opening the Example Report Template

This example uses the figloop-tutorial report template. To open the figure loop tutorial report template, enter the following at the MATLAB command line:

setedit figloop-tutorial

Back to Top

Selecting Object Types

You can use the Object type selection list to choose Handle Graphics object types for the Summary Table, including blocks, signals, systems, and models. The figloop-tutorial reports on figure objects.

Back to Top

Adding and Removing Properties

You can select object properties to appear in the Summary Table from the Property Columns pane. To add a property to the summary table, select the property category from the property category box to the right of the Property columns field. Selecting different property categories causes the selected category's properties to appear in the field under the box. The following figure shows main as the selected category.

• To add a property:

  1. Select the category from the property category box.

  2. Select a property in the properties list.

  3. Click the Add property button.

     The property appears in the Property columns field.

• To remove a property from the table:

  1. Select the property in the Property columns field.

  2. Press Delete.

     The property name is removed from the Property columns field.

Note   After making changes in the Report Explorer interface, click Apply to make the changes take effect.

You can define your own properties by entering their names into the Property columns field using valid variable notation. For more information, see %<VariableName> Notation on the Text component reference page in the MATLAB Report Generator documentation.

Back to Top

Setting Relative Column Widths

Use the Width field to apply a relative column width to the Summary Table columns in the generated report. If you do not specify a value for this field, column widths automatically set.

Back to Top

Setting Object Row Options

You can use the Object Rows pane to set options for table rows, including anchor, filtering, and sorting options. Select Insert anchor for each row to place an anchor in each table row in the report. Use the Include figures list to specify what objects to include in the Summary Table.

Summary Table components in figloop-tutorial report on figure objects. For more information on options for these figure objects, see the following sections:

• Looping on the Current Figure

• Looping on Visible Figures

• Looping on Figures with Tags

Back to Top

Working with Property Table Components

Creating Custom Components

© 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS