slreportgen.webview.EmbeddedWebViewDocument 类

命名空间: slreportgen.webview
超类: slreportgen.webview.WebViewDocument

创建一个报告生成器，生成包含相互链接的文档和相关 Web 视图的 HTML 报告

全页展开

描述

创建一个报告生成器，该报告生成器生成一个 HTML 报告，其中包含一个文档和一个或多个 Simulink^® 模型的 Web 视图，并且文档和 Web 视图之间有双向超链接。

此类提供以下功能用于生成嵌入式 Web 视图报告：

基于 slreportgen.report.Report 对象的报告生成器。您可以使用 DOM 和报告 API 来填充文档内容。
具有三个面板的 HTML 模板，分别用于目录 (TOC)、文档内容和 Web 视图
模板孔分别需要用文档内容和 Web 视图填充。Web 视图的孔名为 slwebview，位于报告的右侧面板中。文档内容的孔名为 Content，位于报告的中间面板。
填补文档和 Web 视图漏洞的方法。
在文档内容和嵌入式 Web 视图之间创建双向超链接的方法
当报告在浏览器中打开时，JavaScript 根据文档标题生成目录
模型导出选项允许您指定要在生成的报告中嵌入为 Web 视图的模型和子系统
从模型中检索元素（图、模块、图等）并将其作为 Web 视图嵌入到报告中的方法

slreportgen.webview.EmbeddedWebViewDocument 类是 handle 类。

创建对象

描述

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname,model) 创建一个报告生成器，该报告生成器生成具有指定文件名并包含指定模型的 Web 视图的报告。使用生成器的 fill 方法生成 Web 视图并将 Web 视图嵌入文档中。使用生成器的 close 方法将文档输出为包含 HTML 文档的 ZIP 文件或文件夹。

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

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname,{model1,model2,...modeln}) 创建一个生成器，该生成器在嵌入到输出文档的 Web 视图中包含指定的模型。

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname) 创建一个生成器，该生成器嵌入由生成器的 ExportOptions 属性的 Diagrams 属性指定的模型，例如：

import slreportgen.webview.*
rptgen = EmbeddedWebViewDocument("myDoc");
rptgen.ExportOptions.Diagrams = "myModel";

输入参量

全部展开

`rptname` — 输出报告文件和/或文件夹的名称
字符向量

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

`model` — 要导出的模型的名称
字符向量

模型名称，指定为字符向量，作为 Web 视图嵌入到生成的报告中。

属性

全部展开

`CurrentHoldID` — 文档中当前漏洞的标识符
字符向量 | 字符串标量

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

属性：

Dependent true

NonCopyable true

数据类型: char | string

`ExportOptions` — Web 视图导出选项
`slreportgen.webview.ExportOptions` (默认)

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

`IncludeNotes` — 是否在 Web 视图中包含用户注释
`"off"` (默认) | on/off 逻辑值

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

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

`ForceOverwrite` — 是否覆盖现有报告
`"on"` (默认) | on/off 逻辑值

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

“on” - 覆盖现有报告。
“off” - 以新名称生成报告。

`OpenStatus` — 报告生成的状态
`"unopened"` (默认) | `"opened"`

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

属性：

Dependent true

NonCopyable true

数据类型: char | string

`OutputPath` — 文档输出目录的路径
当前工作目录 (默认) | 字符向量 | 字符串标量

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

属性：

Dependent true

NonCopyable true

数据类型: char | string

`PackageType` — 为输出文档生成的文件的打包格式
`"both"` (默认) | `"zipped"` | `"unzipped"`

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

"both" - 创建压缩和解压后的输出
"zipped" - 创建一个带有 .htmx 扩展名的 ZIP 文件
"unzipped" - 创建一个文件夹

属性：

Dependent true

NonCopyable true

数据类型: char | string

`TemplatePath` — 用于生成此报告的模板的路径
默认 HTML 模板 (默认) | 字符向量 | 字符串标量

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

属性：

Dependent true

NonCopyable true

数据类型: char | string

`TitleBarText` — HTML 浏览器标题栏的文本
`"Simulink Web View - Created by Simulink Report Generator"` (默认) | 字符向量 | 字符串标量

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

属性：

Dependent true

NonCopyable true

数据类型: char | string

`ValidateLinksAndAnchors` — 是否检查生成的文档和 Web 视图之间的超链接的有效性
`"on"` (默认) | on/off 逻辑值

是否检查生成文档与 Web 视图之间的超链接的有效性，指定为 "on" 或 "off"，或指定为数值或逻辑值 1 (true) 或 0 (false)。值 "on" 等同于 true，而 "off" 等同于 false。因此，您可以将此属性的值用作逻辑值。该值以类型为 matlab.lang.OnOffSwitchState. 的 on/off 逻辑值存储。

"on" - 检查生成文档与 Web 视图之间的超链接的有效性。
"off" - 不检查生成文档与 Web 视图之间的超链接的有效性。

如果您指定的链接目标不存在或者您从已有链接的模型元素指定链接，则在命令行生成警告。验证检查会增加生成报告所需的时间。因此，请考虑仅在调试报告时使用链接验证检查。

方法

全部展开

公共方法

方法	目的
`createDiagramTwoWayLink`	在中间面板中的文档位置和右侧面板中的 Web 视图中的图之间创建双向链接
`createElementTwoWayLink`	在文档面板位置和 Web 视图中的图元素之间创建双向链接
`createDiagramLink`	创建从文档面板到模型 Web 视图中图的链接
`createElementLink`	创建从文档面板到模型 Web 视图中元素的链接
`fill`	调用嵌入式 Web 视图报告生成器的填补洞方法来填补其模板中的洞。
`fillslwebview`	使用 Web 视图填充模板的 slwebview 空洞
`getExportModels`	要包含在 Web 视图中的模型的名称
`getExportDiagrams`	要包含在 Web 视图中的模块图的路径和句柄
`getExportSimulinkSubSystems`	此 Web 视图中要包含的子系统模块的路径和句柄
`getExportStateflowCharts`	此 Web 视图中要包含的 Stateflow^® 图的路径和句柄
`getExportStateflowDiagrams`	Stateflow 图路径数组
`getReportObject`	返回嵌入式 Web 视图报告的报告对象

版本历史记录

在 R2017a 中推出

全部展开

R2019b: 目录中的项未编号

从 R2019b 开始，嵌入式 Web 视图报告中的目录中的项没有编号。要在目录中生成编号项，请执行以下操作：

将嵌入式 Web 视图报告的默认模板复制到当前文件夹。

copyfile(fullfile(matlabroot,...
        "/toolbox/slreportgen/webview/resources/templates/embedded_webview.htmtx"))

将模板解压到子文件夹 myTemplate 中。

unzipTemplate("embedded_webview.htmtx","myTemplate");

在 myTemplate 中，导航到 stylesheets 子文件夹。打开 root.css 文件并从 ol.toc 样式中删除此行：
list-style-type: none;
保存 root.css 文件。
导航到包含原始压缩模板文件的文件夹。将解压后的模板文件打包成压缩模板文件。
```
zipTemplate("Newtemplate.htmtx","myTemplate");
```
将嵌入式 Web 视图报告生成器对象的 TemplatePath 属性设置为新模板文件的路径和名称。例如，假设 MyEmbeddedWebView 是 slreportgen.webview.EmbeddedWebViewDocument 的子类。以下是设置 MyEmbeddedWebView 对象的 TemplatePath 属性的代码：
```
rpt = MyEmbeddedWebView(rptName,model);
rpt.TemplatePath = "NewTemplate.htmtx";
```

另请参阅

slreportgen.webview.ExportOptions | slreportgen.webview.WebViewDocument

slreportgen.webview.EmbeddedWebViewDocument 类

描述

创建对象

描述

输入参量

rptname — 输出报告文件和/或文件夹的名称 字符向量

model — 要导出的模型的名称 字符向量

属性

CurrentHoldID — 文档中当前漏洞的标识符 字符向量 | 字符串标量

属性：

ExportOptions — Web 视图导出选项 slreportgen.webview.ExportOptions (默认)

IncludeNotes — 是否在 Web 视图中包含用户注释 "off" (默认) | on/off 逻辑值

ForceOverwrite — 是否覆盖现有报告 "on" (默认) | on/off 逻辑值

OpenStatus — 报告生成的状态 "unopened" (默认) | "opened"

属性：

OutputPath — 文档输出目录的路径 当前工作目录 (默认) | 字符向量 | 字符串标量

属性：

PackageType — 为输出文档生成的文件的打包格式 "both" (默认) | "zipped" | "unzipped"

属性：

TemplatePath — 用于生成此报告的模板的路径 默认 HTML 模板 (默认) | 字符向量 | 字符串标量

属性：

TitleBarText — HTML 浏览器标题栏的文本 "Simulink Web View - Created by Simulink Report Generator" (默认) | 字符向量 | 字符串标量

属性：

ValidateLinksAndAnchors — 是否检查生成的文档和 Web 视图之间的超链接的有效性 "on" (默认) | on/off 逻辑值

方法

公共方法

版本历史记录

R2019b: 目录中的项未编号

另请参阅

主题

`rptname` — 输出报告文件和/或文件夹的名称
字符向量

`model` — 要导出的模型的名称
字符向量

`CurrentHoldID` — 文档中当前漏洞的标识符
字符向量 | 字符串标量

`ExportOptions` — Web 视图导出选项
`slreportgen.webview.ExportOptions` (默认)

`IncludeNotes` — 是否在 Web 视图中包含用户注释
`"off"` (默认) | on/off 逻辑值

`ForceOverwrite` — 是否覆盖现有报告
`"on"` (默认) | on/off 逻辑值

`OpenStatus` — 报告生成的状态
`"unopened"` (默认) | `"opened"`

`OutputPath` — 文档输出目录的路径
当前工作目录 (默认) | 字符向量 | 字符串标量

`PackageType` — 为输出文档生成的文件的打包格式
`"both"` (默认) | `"zipped"` | `"unzipped"`

`TemplatePath` — 用于生成此报告的模板的路径
默认 HTML 模板 (默认) | 字符向量 | 字符串标量

`TitleBarText` — HTML 浏览器标题栏的文本
`"Simulink Web View - Created by Simulink Report Generator"` (默认) | 字符向量 | 字符串标量

`ValidateLinksAndAnchors` — 是否检查生成的文档和 Web 视图之间的超链接的有效性
`"on"` (默认) | on/off 逻辑值