slreportgen.webview.ExportOptions Class

Namespace: slreportgen.webview

Options for exporting Simulink model to web view

Description

Use an slreportgen.webview.ExportOptions object 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

exportopts = slreportgen.webview.ExportOptions(wvdoc) creates an export options object, exportopts, for the wvdoc web view or embedded web view document. wvdoc is created using slreportgen.webview.WebViewDocument or slreportgen.webview.EmbeddedWebViewDocument. When you create a Web view or embedded Web view document, an export options object is created automatically.

Input Arguments

wvdoc — Web view object

slreportgen.webview.WebViewDocument or slreportgen.webview.EmbeddedWebViewDocument object

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

Properties

Diagrams — Diagram or diagrams to export to the web view

character vector

Diagram or diagrams to export to the web view, specified as a character vector.

SearchScope — System and subsystem levels to export

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

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

• 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

IncludeMaskedSubsystems — Option to export masked subsystems

False (default) | True

Option to export masked subsystems, specified as a logical. If you set IncludeMaskedSystems to False, no masked subsystems are exported. If you set it to True, all masked subsystems are exported.

IncludeReferencedModels — Option to export referenced models

False (default) | True

Option to export referenced models, specified as a logical. If you set IncludeReferencedModels to False, no masked subsystems are exported. If you set it to True, all referenced models are exported.

IncludeReferencedSubsystems — Option to export referenced subsystems

True (default) | False

Since R2024b

Option to export referenced subsystems, specified as a logical. If you set IncludeReferencedModels to False, no referenced subsystems are exported. If you set it to True, all referenced subsystems are exported.

IncludeSimulinkLibraryLinks — Option to export Simulink^® library links

False (default) | True

Option to export Simulink library links, specified as a logical. If you set IncludeSimulinkLibraryLinks to False, no library links are exported. If you set it to True, all library links are exported.

IncludeUserLibraryLinks — Option to export user-defined library links

False (default) | True

Option to export user-defined library links, specified as a logical. If you set IncludeUserLibraryLinks to False, no user-defined library links are exported. If you set it to True, all user-defined library links are exported.

FilterCallback — Function to determine whether to export a system and its descendants

function name or handle

Function to determine whether to export a system and its descendants, specified as a 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

R2024b: Option to exclude referenced subsystems in web view

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