本页采用了机器翻译。点击此处可查看英文原文。

slreportgen.webview.WebViewDocument 类

命名空间: slreportgen.webview

创建 Web 视图文档生成器

全页展开

描述

创建一个文档生成器，该文档生成器生成一个包含一个或多个 Simulink® 模型的 Web 视图的 HTML 文档。

slreportgen.webview.WebViewDocument 类是 handle 类。

创建对象

描述

wvdocgen = slreportgen.webview.WebViewDocument(docname,model) 创建一个文档生成器，在指定位置生成一个包含指定模型的 Web 视图的 HTML 文档。使用生成器的 fill 方法生成文档。

wvdocgen = slreportgen.webview.WebViewDocument(docname,model1,model2,...modeln) 创建一个文档生成器，该文档生成器在其创建的 Web 视图中包含两个或更多模型。此构造函数将默认的 slreportgen.webview.ExportOptions 对象数组分配给生成器的 ExportOptions 属性，每个要包含在生成的文档的 Web 视图中的模型都有一个对象数组。您可以使用对象来指定要导出的模型的自定义导出选项。

示例

wvdocgen = slreportgen.webview.WebViewDocument(docname,{model1,model2,...modeln}) 将默认的 slreportgen.webview.ExportOptions 对象分配给生成器的 ExportOptions 属性，该属性适用于所有要导出的模型。

wvdocgen = slreportgen.webview.WebViewDocument(docname) 为最初未指定的模型或模型集创建一个 Web 视图文档生成器。使用生成器的 ExportOptions 属性的 Systems 属性来指定要包含在其生成的 Web 视图中的模型。

输入参量

全部展开

包含此生成器生成的报告的 ZIP 文件和/或文件夹的名称。使用此生成器的 PackageType 属性来指定是否将生成的报告打包为文件、文件夹或两者。如果指定扩展名，则扩展名必须是 .htmx。如果您未指定扩展名，报告生成器将附加 .htmx。

要导出为交互式 HTML Web 视图的 Simulink 模型的名称，指定为字符向量。

属性

全部展开

文档中当前所在位置的标识符，以字符向量或字符串标量形式存储。

属性：

Dependent
true
NonCopyable
true

数据类型: char | string

Web 视图导出选项，指定为 slreportgen.webview.ExportOptions 对象的数组，每个模型或模型集在导出到生成的报告的 Web 视图中占一个。生成器构造函数的构造函数为指定的模型设置此属性的默认值。使用 ExportOptions 对象或对象的属性来自定义将模型导出到生成的 Web 视图。例如，您可以指定要包含的其他模型，或者是否包含封装子系统和库模块的模块图。

是否在 Web 视图中包含用户注释，指定为 "on" 或 "off"，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 "on" 等同于 true，而 "off" 等同于 false。因此，您可以将此属性的值用作逻辑值。该值以类型为 matlab.lang.OnOffSwitchState. 的 on/off 逻辑值存储。

  • "on" - 在 Web 视图中包含用户注释。

  • "off" - 不在 Web 视图中包含用户注释。

是否用相同名称覆盖现有报告，指定为 "on" 或 "off"，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 "on" 等同于 true，而 "off" 等同于 false。因此，您可以将此属性的值用作逻辑值。该值以类型为 matlab.lang.OnOffSwitchState. 的 on/off 逻辑值存储。

  • “on” - 覆盖现有报告。

  • “off” - 以新名称生成报告。

报告的生成状态，以 "unopened" 或 "opened" 表示。

属性：

Dependent
true
NonCopyable
true

数据类型: char | string

报告输出目录的路径，指定为字符向量或字符串标量。

属性：

Dependent
true
NonCopyable
true

数据类型: char | string

为输出文档生成的文件的打包格式，指定为以下值之一：

  • "both" - 创建压缩和解压后的输出

  • "zipped" - 创建一个带有 .htmx 扩展名的 ZIP 文件

  • "unzipped" - 创建一个文件夹

属性：

Dependent
true
NonCopyable
true

数据类型: char | string

用于生成此报告的 HTML 模板的路径，指定为字符向量或字符串标量。该模板有一个 .htmtx 扩展名。此属性指向默认 HTML 模板。要使用自定义模板，请将此属性设置为自定义模板的路径。

属性：

Dependent
true
NonCopyable
true

数据类型: char | string

用于显示生成的报告的 HTML 浏览器标题栏中显示的文本，指定为字符向量或字符串标量。默认文本为 "Simulink Web View - Created by Simulink Report Generator"。

属性：

Dependent
true
NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

import slreportgen.webview.*
openExample("f14")
d = WebViewDocument("f14WebView", "f14");
fill(d);
rptview(d);

此示例使用:

打开实时脚本

此示例中的导出选项允许您查看在 f14 模型中实现 Simulink 库模块、带限白噪声的子系统以及在 Engine 模型中实现 sf_car 模块的 Stateflow® 图。如果示例未启用导出选项，则子系统和图将仅作为模块出现在导出的 Web 视图中。

import slreportgen.webview.*
open_system('f14');
open_system('sf_car');
wvdoc = WebViewDocument(...
    'myWebview','f14','sf_car'); 
opts = wvdoc.ExportOptions;
 
f14Opts = opts(1);
f14Opts.IncludeMaskedSubsystems = true; 
f14Opts.IncludeSimulinkLibraryLinks = true;

sfcarOpts = opts(2);
sfcarOpts.IncludeMaskedSubsystems = true; 

fill(wvdoc)
rptview(wvdoc);

此示例导出了f14和Aircraft Dynamics Model 子系统的根系统。

import slreportgen.webview.*
openExample("f14");
wvdoc = WebViewDocument("myWebView", ...
    {"f14", "f14/Aircraft Dynamics Model"});
wvdoc.ExportOptions.SearchScope = "Current";
fill(wvdoc)
rptview(wvdoc);

此示例导出了f14和Controller子系统的根系统。

import slreportgen.webview.*
openExample("f14");
wvdoc = WebViewDocument(...
    "mydoc", "f14/Controller");
wvdoc.ExportOptions.SearchScope = "CurrentAndAbove";
fill(wvdoc)
rptview(wvdoc);

版本历史记录

在 R2017a 中推出

另请参阅

|