MATLAB Report Generator

Choosing Figures to Loop On

The following sections describe what you can choose to loop on:

• Looping on the Current Figure
• Looping on All Visible Figures
• Looping on Figures with Certain Tags

Looping on the Current Figure

Select the Figure 5 window ("Peaks Data") to make Figure 5 current.

To include only the current figure in the report, select Current figure only. Notice that the Loop Figure List now shows Peaks Data only. Click on the Report button to generate a report.

Note    When you choose Current figure only, "current figure" refers to the figure that is current when the report is generated. This may not be the same figure you selected as the current figure in the Setup File Editor before report generation. For example, if the report generation process creates figures in your report, then the last figure created with HandleVisibility = 'on' is the current figure.

Looping on All Visible Figures

To loop on all visible figures, select Visible figures. This option runs subcomponents of the Figure "For" Loop component for all figures that are currently open and visible.

With HandleVisibility='on'

The Data figures only option is checked by default and excludes figures with HandleVisibility = 'off' from the loop. The Loop Figure List contains:

• Membrane Data (Figure 1)
• Peaks Data (Figure 5)

These are the figures that will be looped on.

Click on the Report button to generate a report. Notice that the report contains "Membrane Data" and "Peaks Data."

With HandleVisibility='on' or 'off'

Now deselect the Data figures only option. Figures with HandleVisibility = 'on'("Membrane Data" and "Peaks Data") and HandleVisibility = 'off' ("An Application") are now included in the loop.

The Loop Figure List now contains:

• Membrane Data (Figure 1)
• An Application (Figure 3 - HandleVisibility 'off')
• Peaks Data (Figure 5).

Click on the Report button to generate a report. Notice that the report now contains "Membrane Data," "An Application," and "Peaks Data."

Looping on Figures with Certain Tags

To loop on figures with certain tags, select the All figures with tags option. When you select a tag, all figures with that tag are included, regardless of whether the figure is visible or whether HandleVisibility is 'on' or 'off'.

See the Tags section earlier in this tutorial for a brief discussion of Handle Graphics tags.

Adding a Tag to the Tag List Box

To add a tag to the tag list box, select the tag from the drop box on the right and click on the Add button, shown below.

The tutorial tag list box on the left starts with app and membrane. For example, to add peaks to the list, click on the down arrow in the tag drop box on the right and select peaks. Then click on the Add button.

Adding a Tag Manually

The tag drop box on the right shows a list of tags for figures that are open. If you want to add a tag that does not appear in the tag drop box, you can manually type in the tag.

To type in a tag, select Enter tag in edit field and type in the name of the tag in the edit field below the tag drop box. Then click on the Add button.

Removing a Tag from the Tag List Box

To remove a tag from the tag list box, select the tag and click on the delete button. Note that you can select multiple tags in the tag list box.

The tag list box should now contain app, membrane, and peaks. To remove membrane and peaks, hold the Ctrl key down and click on membrane and peaks. Both membrane and peaks are now selected. To delete them from the list box, click on the Delete button, shown below.

The only tag remaining in the tag list box is app. The Loop Figure List now contains An Application and An Invisible Application. Click on the Report button. Notice that the report only contains "An Application" and "An Invisible Application."

Report Generation

Tutorial Summary