slreportgen.webview.ExportOptions Class

Namespace: slreportgen.webview

Options for exporting Simulink model to web view

Description

Use objects of the slreportgen.webview.ExportOptions class to specify the items to export to a web view or an embedded web view report.

The slreportgen.webview.ExportOptions class is a handle class.

Creation

Description

Create an slreportgen.webview.ExportOptions object using the slreportgen.webview.ExportOptions function or by creating a web view or embedded web view document. When you create a web view or embedded web view document, slreportgen.webview.WebViewDocument or slreportgen.webview.EmbeddedWebViewDocument automatically create an slreportgen.webview.ExportOptions object.

exportopts = slreportgen.webview.ExportOptions(wvdoc)

Input Arguments

wvdoc — Web view object

slreportgen.webview.WebViewDocument | slreportgen.webview.EmbeddedWebViewDocument

Web view document, specified as a web view or embedded web view object.

Properties

Diagrams — Diagrams to export to web view

character vector | string scalar

Diagrams to export to the web view, specified as a character vector or string scalar.

Data Types: char | string

SearchScope — System and subsystem levels to export

"Current and Below" (default) | "Current" | "Current and Above" | "All"

System and subsystem levels to export, specified as one of these values:

• "Current and Below" — Current specified system or subsystem and all of its dependents

• "Current" — Current specified system or subsystem

• "Current and Above" — Current specified system or subsystem and all of its antecedents

• "All" — All systems and subsystems in the model

Data Types: char | string

IncludeMaskedDiagrams — Whether to export masked diagrams

"off" (default) | on/off logical value

Since R2025a

Whether to export the masked diagrams, specified as "on" or "off", or as numeric or logical 1 (true) or 0 (false). A value of "on" is equivalent to true, and "off" is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• "on" — Exports all masked diagrams in the web view

• "off" — Does not export masked diagrams in the web view

IncludeReferencedModels — Whether to export referenced models

"off" (default) | on/off logical value

Whether to export referenced models, specified as "on" or "off", or as numeric or logical 1 (true) or 0 (false). A value of "on" is equivalent to true, and "off" is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• "on" — Exports referenced models in the web view

• "off" — Does not export referenced models in the web view

IncludeReferencedSubsystems — Whether to export referenced subsystems

"on" (default) | on/off logical value

Since R2024b

Whether to export referenced subsystems, specified as "on" or "off", or as numeric or logical 1 (true) or 0 (false). A value of "on" is equivalent to true, and "off" is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• "on" — Exports all referenced subsystems in the web view

• "off" — Does not export referenced subsystems in the web view

IncludeSimulinkLibraryLinks — Whether to export Simulink^® library links

"off" (default) | on/off logical value

Whether to export Simulink library links, specified as "on" or "off", or as numeric or logical 1 (true) or 0 (false). A value of "on" is equivalent to true, and "off" is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• "on" — Exports Simulink library links in the web view

• "off" — Does not export Simulink library links in the web view

IncludeUserLibraryLinks — Whether to export user-defined library links

"off" (default) | on/off logical value

Whether to export user-defined library links, specified as "on" or "off", or as numeric or logical 1 (true) or 0 (false). A value of "on" is equivalent to true, and "off" is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• "on" — Exports user-defined library links in the web view

• "off" — Does not export user-defined library links in the web view

FilterCallback — Function to export a system and its descendants

character vector | string scalar | handle

Function to export a system and its descendants, specified as a character vector or string scalar that contains the function name, or function handle. The function must return true to include the system or false to exclude the system.

More About

Diagram

Diagram refers to a Simulink model, subsystem, or Stateflow^® chart.

Version History

Introduced in R2017a

R2025a: IncludeMaskedSubsystems renamed to IncludeMaskedDiagrams and now includes masked Stateflow charts

Prior to R2025a, the IncludeMaskedSubsystems property specified whether to include masked Simulink models or subsystems in a web view. The IncludeMaskedDiagrams property replaces the IncludeMaskedDiagrams property and specifies whether to include masked Simulink models or subsystems, and masked Stateflow charts.

R2024b: Specify whether to exclude referenced subsystems in web view

When generating a model web view, you can choose whether to include referenced subsystems by using the propertyIncludeReferencedSubsystems. The default behavior is to include referenced subsystems in the model web view.