IRIS Toolbox Reference Manual

figure

Start new figure

Syntax

P.figure(Caption,...)

Syntax to capture an existing figure window

This is an obsolete syntax, and will be removed from IRIS in a future release. Use report/userfigure instead.

P.figure(Caption,H,...)

Input arguments

Options

Generic options

See help on generic options in report objects.

Description

Figures are top-level report objects and cannot be nested within other report objects, except align. Figure objects can have the following types of children:

Titles and subtitles

The input argument Caption can be either a text string, or a 1-by-2 cell array of strings. In the latter case, the first cell will be printed as a title, and the second cell will be printed as a subtitle.

To split the title or subtitle into multiple lines, use the following LaTeX commands wrapped in curly brackets: {\\} or {\\[Xpt]}, where X is the width of an extra vertical space (in points) added between the respective lines.

Figure handle

If the option 'close=' is set to false the figure window will remain open after the report is published. The handle to this figure window will be included in the field .figureHandle of the information struct Info returned by report/publish.

Example