Main Content

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

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 模型的名称，指定为字符向量。

属性

全部展开

文档中当前漏洞的标识符。这是一个只读属性。

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

是否包含用户注释，指定为数字或逻辑 0 (false) 或 1 (true)。

数据类型: logical

是否覆盖具有相同名称的现有报告。True 覆盖现有报告。False 以新名称生成报告。

文档输出目录的路径。

用于输出文档的包装，指定为以下字符向量之一：

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

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

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

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

在显示生成的 Web 视图文档的 HTML 浏览器的标题栏中显示的文本。默认文本是“ Simulink Web View - Created by Simulink Report Generator ”。

方法

全部展开

示例

全部折叠

import slreportgen.webview.*
openExample('f14')
d = WebViewDocument('f14WebView', 'f14');
fill(d);
rptview(d);
打开实时脚本

此示例中的导出选项允许您查看在 f14 模型中实现 Simulink 库模块、带限白噪声的子系统以及在 sf_car 模型中实现 Engine 模块的 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 中推出

另请参阅

|