slreportgen.report.ScopeSnapshot Class

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

Create Simulink scope snapshot reporter

Since R2024b

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.

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

Properties

Source — Path or handle of scope

[] (default) | character vector | string scalar

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 — Snapshot reporter

mlreportgen.report.FormalImage object

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 customize the size of the image.

Note

The reporter initializes the Snapshot property. Do not clear or modify this property.

Attributes:

GetAccess	public
SetAccess	public

SnapshotFormat — Snapshot image format

"svg" (default) | "emf" | "gif" | "jpg" | ...

Snapshot image format, specified as one of these formats:

Import Image Format	File Extension	Supported in HTML	Supported in Word	Supported in PDF	Supported in PDF/A (since R2025a)
Windows® metafile	.emf	No	Yes	No	No
Graphics Interchange Format	.gif	Yes	Yes	Yes	Yes
JPEG image	.jpg	Yes	Yes	Yes	No
PDF	.pdf	No	No	Yes	No
PDF/A	.pdf	No	No	Yes	No
Portable Network Graphics (.png)	.png	Yes	Yes	Yes	Yes
Scalable Vector Graphics	.svg	Yes	Yes	Yes	Yes
TIFF image	.tif	No	Yes	Yes	Yes

Note

Unlike the PDF report output format, the PDF/A format does not support including PDF or PDF/A images. Use one of the image formats listed in the table to include an image in a PDF/A report.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

Scaling — Scaling options for snapshot image

"auto" (default) | "custom" | "none"

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

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 either of these combinations of property settings occur:

• Scaling set to "zoom", and Zoom, MaxHeight, and MaxWidth properties set to large values

• Scaling set to "custom", and Height and Width properties set to large values

To avoid this error, for zoom Scaling, use smaller Zoom, MaxHeight, and MaxWidth property values. For Scaling is set to "custom", use smaller Height and Width property values.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

Height — Height of snapshot image

"6in" (default) | character vector | string scalar

Height of the snapshot image, specified as a character vector or string scalar that contains 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

Note

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.

Example: "2in"

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

Width — Width of snapshot image

"6.5in" (default) | character vector | string scalar

Width of the snapshot image, specified as a character vector or string scalar that contains 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

Note

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.

Example: "2in"

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

PreserveBackgroundColor — Whether to preserve background color

0 (false) (default) | 1 (true)

Whether to preserve background color in the snapshot, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Set the background color of the snapshot to the same color as the background color of the snapshot source. The Theme property is ignored.

• 0 (false) — Set the background color of the snapshot to the setting of the Theme property.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

Theme — Graphics theme to use when printing the snapshot

"light" (default) | "dark"

Since R2025a

Graphics theme to use when printing the snapshot, specified as:

• "light" — prints the figure with a white background and dark-colored graph lines and text.

• "dark" — prints the figure with a dark-colored background and light-colored graph lines and text.

If you manually set any graphics colors, the snapshot preserves those colors, with the exception of the figure and axes background colors, regardless of theme setting. When PreserveBackgroundColor is true, this property is ignored.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

AutoScaleTimeAxis — Whether to scale the Simulink scope time axis to include entire log

0 (false) (default) | 1 (true)

Whether to scale the Simulink scope time axis to include entire log, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — The reporter scales the time axis and snapshot of the scope window includes the entire log.

• 0 (false) — The reporter does not scale the time axis and the snapshot might not include the entire log.

Data Types: logical

ForceOpenClosedScope — Whether to force open closed scopes to snapshot

0 (false) (default) | 1 (true)

Whether to force open closed scopes to snapshot, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Take a snapshot of all scopes in the context. This option forces closed scopes to open when the report generates and closes them afterwards.

• 0 (false) — Only include the snapshot of the opened scopes.

Data Types: logical

TemplateSrc — Source of template for this reporter

character vector | string scalar | reporter or report | DOM document or document part

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 this reporter uses or whose template library contains the template for this reporter

• Document Object Model (DOM) document or document part whose template this reporter uses 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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true
Dependent	true

TemplateName — Name of template for this reporter

character vector | string scalar

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.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

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.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

Method	Purpose
getSnapshotImage	Image snapshot of Simulink scope block
slreportgen.report.ScopeSnapshot.createTemplate	Create reporter template template = createTemplate(templatePath,templateType) creates a copy of the default template for the report type specified by templateType at the location specified by templatePath. You can use the copied template as a starting point to design a custom reporter template for your report. Input Arguments templatePath — Target path and file name for template file, specified as a character vector or a string scalar. templateType — Template type, specified as "html", "docx", or "pdf" Return Values template — Path and file name of the template copy, returned as a string scalar For more information, see the method for the Reporter class, slreportgen.report.Reporter.createTemplate.
slreportgen.report.ScopeSnapshot.customizeReporter	Create reporter from slreportgen.report.ScopeSnapshot class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of slreportgen.report.ScopeSnapshot at the location specified by classPath. The method copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom reporter class. Input Arguments classPath — Path and name of the new class definition file, specified as a character vector or string scalar Return Values classPathOut — Path and file name of the new class, returned as a string scalar For more information, see the method for the slreportgen.report.Reporter class, slreportgen.report.Reporter.customizeReporter.
slreportgen.report.ScopeSnapshot.getClassFolder	Get location of folder that contains slreportgen.report.ScopeSnapshot class definition file path = getClassFolder returns the path of the folder that contains the class definition file. Return Values path — Class definition file location, returned as a character vector For more information, see the method for the Reporter class, slreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of property values copiedObj = copy(reporterObj) returns a copy of the specified reporter object. The returned copy contains a deep copy of any property value of reporterObj that references a reporter, DOM object, or slreportgen.report.ReporterLayout object.As a result, you can modify the properties of the original or new object without affecting the other object. Input Arguments reporterObj — Reporter object to copy, specified as an object of a reporter class Return Values copiedObj — Copy of reporter, returned as an object of a reporter class For more information, see the method for the slreportgen.report.Reporter class, copy.
getImpl	Get implementation of reporter impl = getImpl(reporter,report) returns the Document Object Model (DOM) object that implements the reporter, reporter, when you append it to the report, report. Note You cannot add content to the reporter after calling this method. Input Arguments reporterObj— Reporter object, specified as an object of slreportgen.report.Reporter or an object of a subclass of slreportgen.report.Reporter report — Report, specified as a mlreportgen.report.Report object Return Values impl — Implementation object, returned as a DOM object. For more information, see the method for the slreportgen.report.Reporter class, getImpl.

Examples

Add Scope Snapshot to Report

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);

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);

Close and view the report.

close(rpt);
rptview(rpt);

Limitations

• If you run your simulation with the parsim function, this class is not supported.

Tips

If the snapshot that the ScopeSnapshot object adds to your report is missing or empty, check the order in which you add reporters to your report. slreportgen.report.ScopeSnapshot objects require the model to be uncompiled in order to capture the window of the Scope block. Some reporters, such as slreportgen.report.Diagram, compile the model when you append them to the report. If you append one of these reporters before the ScopeSnapshot reporter, the ScopeSnapshot reporter cannot capture the scope window because the model is no longer uncompiled.

These reporters require a compile the model when you add them to the report:

• slreportgen.report.ExecutionOrder

• slreportgen.report.Signal

• slreportgen.report.ScheduleDiagram

• slreportgen.report.SystemIO

Additionally, slreportgen.report.Diagram reporters require a compiled model when you enable execution-order, sorted-order, or timing overlays.

To prevent these issues:

• If possible, append the ScopeSnapshot reporter to your report before any reporter that compiles the model:

  append(chapter, slreportgen.report.ScopeSnapshot(model + "/Scope"));
  append(chapter, slreportgen.report.Diagram(model));

• If the reporting sequence requires ScopeSnapshot to occur after a reporter that compiles the model:

  1. Uncompile the model.

     slreportgen.utils.uncompileMode(model);

  2. Simulate the model.

     sim(model);

  3. Retrieve the DOM object that the ScopeSnapshot reporter uses and append it to the chapter. Appending the DOM object to the chapter forces the reporter to take the snapshot immediately, while the model is still uncompiled.

     reporter = slreportgen.report.ScopeSnapshot(model + "/Scope");
     reporterObj = getImpl(reporter,rpt);
     append(chapter,reporterObj);

  4. Recompile the model.

     slreportgen.utils.compileMode(model);

Version History

Introduced in R2024b

R2025a: Specify graphics theme for snapshot

Use the Theme property to set the graphics theme to use when printing the snapshot, specified as "light" or "dark". If the PreserveBackgroundColorproperty is true, the Theme property is ignored.