Main Content

slreportgen.report.ScopeSnapshot Class

Namespace: slreportgen.report
Superclasses: slreportgen.report.Reporter

Create Simulink scope snapshot reporter

Since R2024b

expand all in page

Description

Create a Simulink® scope reporter. When added to a report, Simulink scope reporters create a snapshot of the specified scope block and adds the snapshot to the report as an image with an optional caption. Use the Source property to specify the desired scope.

Note

To use a ScopeSnapshot reporter in a report, you must create the report using the slreportgen.report.Report class.

The slreportgen.report.ScopeSnapshot class is a handle class.

Class Attributes

HandleCompatible
true

For information on class attributes, see Class Attributes.

Creation

Description

ssReporter = ScopeSnapshot creates an empty ScopeSnapshot object based on the default report template. Use the Source property to specify a Simulink scope block on which to report. Adding an ScopeSnapshot object with an empty Source property to a report produces an error.

ssReporter = ScopeSnapshot(source) sets the Source property to source. Adding this reporter to a slreportgen.report.Report object, without any further modification, adds the scope snapshot information based on default settings of the slreportgen.report.Report object. The snapshot displays in the generated report as an image with a caption. See slreportgen.report.Report.

example

ssReporter = ScopeSnapshot(Name=Value) sets properties using one or more name-value arguments. You can specify multiple name-value pair arguments in any order.

Properties

expand all

Path or handle of the scope block for which to create a Simulink scope reporter, specified as a string scalar or a character vector.

Data Types: char | string

Snapshot reporter, specified as an mlreportgen.report.FormalImage object. Use the properties of the FormalImage object to specify the caption for the snapshot image or to further customize the size of the image.

Note

The reporter initializes the Snapshot property. Do not reset this property.

Snapshot image format, specified as "svg", "emf", "gif", "jpg", "pdf", "png", or "tif". The table lists which image formats are supported for which report types.

Image FormatFile ExtensionSupported in HTMLSupported in WordSupported in PDF
Windows® metafile.emfNoYesNo
Graphics Interchange Format .gifYesYesYes
JPEG image.jpgYesYesYes
PDF.pdfNoNoYes
Portable Network Graphics .pngYesYesYes
Scalable Vector Graphics.svgYesYesYes
TIFF image.tifNoYesYes

Data Types: char | string

Scaling options for the snapshot image, specified as "auto", "custom", or "none". This property controls the size of the snapshot image in the image file. Supported scaling options are:

  • "auto" — For PDF or Word (DOCX) output, use this option to scale the snapshot image to fit the current page layout while maintaining its aspect ratio. First, the reporter scales the snapshot image to the page width. If the image height exceeds the page height, the reporter scales the image down again. This additional scaling ensures that the image fits the current page with an extra one inch spacing. Scaling does not apply to HTML output.

  • "custom" — Use this option to scale the snapshot image based on the values of the Height and Width properties.

  • "none" — Do not perform scaling

For a PDF image, the size limit is 10000px for width and height. For all other image types, the size limit is the screen size.

Note

The "auto" and "custom" options use the MATLAB® print command to resize the figure. If the figure is too large to fit in the specified space, the print command crops the snapshot image. To avoid cropping, set the Scaling property to "none" and use the reporter specified by the Snapshot property to size the image. Because the reporter reduces the size of the text with the rest of the image, fine details may not be legible unless you zoom the image. See Resize Figure Snapshot Image.

Note

A java.lang.OutOfMemoryError can occur when the Scaling is set to "custom", and Height and Width properties are set to large values. To avoid or solve this error, use smaller Height and Width property values.

Data Types: char | string

Height of the snapshot image, specified as a character vector or string scalar that consists of a number followed by an abbreviation for a unit of measurement. For example, "2in" specifies two inches. The default snapshot is 6 inches. Valid abbreviations are:

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

For PDF images, the height limit is 10000 pixels. For all other image types, the height limit is the screen height.

Example: "2in"

Data Types: char | string

Width of the snapshot image, specified as a character vector or string scalar that consists of a number followed by an abbreviation for a unit of measurement. For example, "2in" specifies two inches. The default snapshot width is 6.5 inches. Valid abbreviations are:

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

For PDF images, the width limit is 10000 pixels. For all other image types, the width limit is the screen width.

Example: "2in"

Data Types: char | string

Whether to preserve background color in the snapshot, specified as a numeric or logical 1 (true) or 0 (false). If PreserveBackgroundColor is true, the background color of the snapshot is the same as the background color of the snapshot source. If PreserveBackgroundColor is false, the background color of the snapshot is white.

Data Types: logical

Whether to scale the Simulink scope time axis to include entire log, specified as a numeric or logical 1 (true) or 0 (false). When set to true, the reporter scales the time axis and snapshot of the scope window includes the entire log. When this property is set to false, the reporter does not scale the time axis and the snapshot might not include the entire log.

Data Types: logical

Whether to force open closed scopes to snapshot, specified as true or false. This property when set to true, takes a snapshot of all scopes in the context. This option forces closed scopes to open when the report generates and closes them afterwards. When set to false, the report only includes the snapshot of the opened scopes.

Data Types: logical

Source of the template for this reporter, specified in one of these ways:

  • Character vector or string scalar that specifies the path of the file that contains the template for this reporter

  • Reporter or report whose template is used for this reporter or whose template library contains the template for this reporter

  • Document Object Model (DOM) document or document part whose template is used for this reporter or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. For example, for a Microsoft® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template specified by the TemplateSrc property of this reporter.

Data Types: char | string

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Methods

expand all

Examples

collapse all

Open Live Script

Create a report and add scope snapshots with both default and custom properties.

Add Scope Snapshot with Default Properties

import mlreportgen.report.*
import slreportgen.report.*

Add a scope snapshot using the default reporter properties to a report.

rpt = slreportgen.report.Report("MyScopeSnapshot","pdf");

Load and simulate the model.

model_name = "vdp";
load_system(model_name);
sim(model_name);

Create a chapter and title.

chapter = mlreportgen.report.Chapter(Title="Scope Block in Van der Pol Equation Model");

Create a ScopeSnapshot reporter using the scope path

reporter = slreportgen.report.ScopeSnapshot("vdp/Scope");

Add reporter to the chapter and chapter to the report

append(chapter,reporter);
append(rpt,chapter);

Figure contains an axes object. The axes object with title x1, x2, xlabel Time contains 2 objects of type line. These objects represent x1, x2.

Add Scope Snapshot with Custom Properties

Add a scope snapshot with the original scope background color and a custom caption to a report.

Create a second chapter and title.

chapter = mlreportgen.report.Chapter(Title="Customized Version of Scope Snapshot");

Create a ScopeSnapshot reporter using the scope path and set its properties

reporter = slreportgen.report.ScopeSnapshot("vdp/Scope");
reporter.Snapshot.Caption = "Scope Snapshot with Custom Caption";
reporter.PreserveBackgroundColor = true;

Add reporter to the chapter and chapter to the report

append(chapter,reporter);
append(rpt,chapter);

Figure contains an axes object. The axes object with title x1, x2, xlabel Time contains 2 objects of type line. These objects represent x1, x2.

Close and view the report.

close(rpt);
rptview(rpt);

Version History

Introduced in R2024b

See Also

| | | |