Documentation Center

  • Trial Software
  • Product Updates

Contents

System Snapshot

Insert snapshot of the current system into report

Description

This component inserts a snapshot of the current system into the report. The Snapshot options control how the image file is stored. The Properties options control whether the image display includes callouts and a print frame. The Display options control how the image is displayed in a browser.

Snapshot Options

  • Format: Specifies the image file format (for example, JPEG or TIFF). Select Automatic SL Format (the default) to choose the format best suited for the specified report output format automatically. Otherwise, choose an image format that your output viewer can read.

    • Automatic SL Format (uses file format selected in the Preferences dialog box)

    • Bitmap (16m-color)

    • Bitmap (256-color)

    • Black and white encapsulated PostScript

    • Black and white encapsulated PostScript (TIFF)

    • Black and white encapsulated PostScript2

    • Black and white encapsulated PostScript2 (TIFF)

    • Black and white PostScript

    • Black and white PostScript2

    • Color encapsulated PostScript

    • Color encapsulated PostScript (TIFF)

    • Color encapsulated PostScript2

    • Color encapsulated PostScript2 (TIFF)

    • Color PostScript

    • Color PostScript2

    • JPEG high quality image

    • JPEG low quality image

    • JPEG medium quality image

    • PNG (screenshot)

    • PNG 24-bit image

    • Scalable Vector Graphics

    • Windows metafile

  • 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 the Use printframe 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. The Flight Control Model in the f14 Simulink model appears here with the default Simulink Report Generator™ frame option.

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 snapshot in a browser, using the format w h (width, height). This field is active only if you choose Fixed size in the Scaling selection list.

  • Max size: Specifies the maximum size of the snapshot in a browser, using the format w h (width, height). This field is active only if you choose Zoom in the Scaling selection list.

  • Units: Specifies the units for the size of the snapshot in a browser. This field is active only if you choose Fixed size in the Image size list box.

  • 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

See Also

System Loop

Was this topic helpful?