slwebview_req

Export Simulink system to Web views with requirements

collapse all in page

Syntax

filename = slwebview_req(sysname)
filename = slwebview_req(sysname,Name,Value)

Description

filename = slwebview_req(sysname) exports the system sysname and its children to a web page filename with contextual requirements information for the system displayed on a separate panel of the layered model structure Web view.

filename = slwebview_req(sysname,Name,Value) uses additional options specified by one or more Name,Value pair arguments.

Note

You can use slwebview_req only if you have also installed Simulink® Report Generator™.

example

Examples

collapse all

Export all the layers (including libraries and masks) from the system gcs to the file filename

filename = slwebview_req(gcs, "LookUnderMasks", "all", "FollowLinks", "on")

Input Arguments

collapse all

System to export to the web view file, specified as a character vector or string scalar that contains the path to the system or a handle to a subsystem, block diagram, chart, or subchart. By default, the function also exports the child systems of the sysname system. Use the SearchScope name-value argument to export other systems, in relation to sysname.

Example: "sysname"

Name-Value Arguments

collapse all

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: "ShowProgressBar","off"

Systems to export, relative to the sysname system, specified as one of these values:

  • "CurrentAndBelow" — Exports the Simulink system or the Stateflow® chart specified by sysname and all systems or charts that it contains.

  • "Current" — Exports only the Simulink system or the Stateflow chart specified by sysname.

  • "CurrentAndAbove" — Exports the Simulink system or the Stateflow chart specified by the sysname and all systems or charts that contain it.

  • "All" — Exports all Simulink systems or Stateflow charts in the model that contains the system or chart specified by sysname.

Data Types: char | string

Whether to export masked blocks, specified as one of these values:

  • "none" — Does not export masked blocks in the web view. Masked blocks are included in the exported systems, but you cannot access the contents of the masked blocks.

  • "all" — Exports all masked blocks.

Data Types: char | string

Whether to access 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" — Includes referenced models in the web view

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

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 referenced subsystems in the web view

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

Whether to include behavior components defined in architecture 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" — Includes behavior components in the web view

  • "off" — Does not include behavior components in the web view

Whether to include user notes, 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" — Includes user notes in the web view

  • "off" — Does not include user notes in the web view

Whether to export supporting MATLAB functions used in MATLAB Function blocks or Stateflow charts, 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 supporting functions or charts in the web view

  • "off" — Does not export supporting functions or charts in the web view

Whether to display the web view in a web browser after you export the web view, 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" — Displays the web view in a web browser when you export the web view

  • "off" — Does not display the web view in a web browser when you export the web view

Whether to display the status bar when you export the web view, 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" — Displays the status bar when you export the web view

  • "off" — Does not display the status bar when you export the web view

Output Arguments

collapse all

Reports the name of the HTML file for displaying the web view. Exporting a web view creates the supporting files in a folder.

Tips

A Web view is an interactive rendition of a model that you can view in a Web browser. You can navigate a Web view hierarchically to examine specific subsystems and to see properties of blocks and signals.

You can use Web views to share models with people who do not have Simulink installed.

Web views require a Web browser that supports Scalable Vector Graphics (SVG).

Version History

Introduced in R2015a

expand all

See Also

Functions

Topics