System Snapshot

Insert snapshot of current system into report

Description

This component inserts a snapshot (screen capture) of the current system into a report. A System Snapshot must be a child or descendant of a System Loop component.

You can optionally hyperlink from the blocks in a snapshot of a block diagram to other parts of a report. For example, you can link a block to a table that contains the properties of the block. Similarly, you can link an unmasked subsystem block to a section of the report that describes the subsystem. Diagram hyperlinking is available only in the Direct PDF (from template) and HTML (from template) output formats.

To link from a block in a snapshot of a block diagram, select the Create link anchor for each object in loop check box on the appropriate loop component:

• For blocks and masked subsystems in this system, select the Create link anchor for each object in loop check box on the Block Loop component that reports on the blocks in the system.

• To link to the sections that report on the unmasked subsystems of this system, select the Create link anchor for each object in loop check box on the System Loop component.

For the Direct PDF (from template) output format, set the snapshot file format to Automatic SL format (PNG 24-bit image) or Scalable Vector Graphics.

To create searchable diagram snapshots, set the snapshot image file format to Scalable Vector Graphics, which represents the SVG file format. The Scalable Vector Graphics format allows you to search for any text represented as character codes that the SVG file contains.

Note

An SVG diagram file might represent parts of text as graphics instead of as character codes. You cannot find this text by using the search tool of a browser or an editor.

Snapshot Options

• Format: Specifies the image file format. Select Automatic SL format (PNG 24-bit image) to automatically choose the best format for the specified report output format. Otherwise, choose an image format that your output viewer can read.

  • Automatic SL format (PNG 24-bit image) (default) — Select this option to automatically select the optimal image file format for the selected report output type. For example, selecting this option in combination with the Direct PDF (from template) report format causes the report to use Scalable Vector Graphics as the snapshot image file format.

  • JPEG high quality image

  • JPEG low quality image

  • JPEG medium quality image

  • PNG 24–bit image

  • Scalable Vector Graphics

• Orientation:

  • Largest dimension vertical: Positions the image so that its largest dimension is vertical.

  • Landscape

  • Portrait

  • Use system orientation: Uses the paper orientation setting for the system. Use the Simulink^® PaperOrientation parameter to specify the orientation.

  • Full page image (PDF only): In PDF reports, scales images to fit the full page, minimizes page margins, and maximizes the size of the image by using either a portrait or landscape orientation.

• Scaling: Controls the size of the image in the image file.

  • Automatic (default): Automatically scales the image to output dimensions.

  • Custom: Specifies image size.

  • Zoom: Enlarges or reduces the image size to the percent that you specify. Use Max Size to specify the maximum size other than the default for the image.

    Note

    Selecting Use printframe paper settings deactivates the Custom and Zoom options and automatically scales the image to the print frame size.

Properties Options

• Include callouts to describe visible objects: Displays descriptive callouts for visible objects

• Use printframe: Prints a frame around the image. You can use the default frame, rptdefaultframe.fig, or use the Frame Editor to build a custom frame. For more information, see the frameedit function in Simulink documentation.

  The default frame is five inches wide and four inches high. It includes the name of the system and the model folder. This frame is optimized for use with a portrait paper orientation.

Display Options

To access the display options, click the Advanced button.

• Scaling: Controls size of the image, as displayed in a browser. Making an image larger using this option does not affect the storage size of the image, but the quality of the displayed image may decrease as you increase or decrease the size of the displayed image.

  Generally, to achieve the best and most predictable display results, use the default setting of Use image size.

  • Use image size: Causes the image to appear the same size in the report as on screen (default).

  • Fixed size: Specifies the number and type of units.

  • Zoom: Specifies the percentage, maximum size, and units of measure.

• Size: Specifies the size of the image in the format [width height]. This field is active only if you choose Fixed size in the Scaling list.

• Max size: Specifies the maximum size of the image in the format [width height]. This field is active only if you choose Zoom from the Scaling selection list.

• Units: Specifies the units for the size of the image. This field is active only if you choose Zoom or Fixed size in the Image size selection list.

• Alignment: Only reports in PDF or RTF format support this property.

  • Auto

  • Right

  • Left

  • Center

• Image title:

  • None (Default)

  • System name: Uses the system name as the image name.

  • Full system name: Uses the system name, with path information, as the image name.

  • Custom: Specifies a custom title.

• Caption:

  • None (Default)

  • Description (use system description)

  • Custom: Specifies a custom caption.

Insert Anything into Report?

Yes. Image.

Class

rptgen_sl.csl_sys_snap