slreportgen.webview.EmbeddedWebViewDocument class

Package: slreportgen.webview
Superclasses:

Create a report generator that generates an HTML report containing an interlinked document and associated web view

Description

Creates a report generator that generates an HTML report containing a document and a web view of one or more Simulink^® models, with two-way hyperlinks between the document and the web view.

This class provides the following facilities for generating embedded web view reports:

A report generator based on an slreporten.report.Report object. You can use DOM and Report APIs to fill the document content.
An HTML template with three panels for a table of contents (TOC), document content, and a web view, respectively
Template holes to be filled with the document content and a web view, respectively. The hole for the web view is named slwebview and is located in the right panel of the report. The hole for document content is named Content and is located in the center panel of the report.
Methods for filling the document and web view holes.
Methods for creating two-way hyperlinks between the document content and embedded webview(s)
JavaScript that generates a TOC from document headings when the report opens in a browser
Model export options that allow you to specify the models and subsystems to be embedded as web views in the generated report
Methods for retrieving elements (diagrams, blocks, charts, etc.) from models to be embedded as web views in the report

Construction

rptgen = slreportgen.webview.Embedded WebViewDocument(rptname,model) creates a report generator that generates a report having the specified file name and containing a web view of the specified model. Use the generator’s fill method to generate the web view and embed the web view in the document. Use the generator’s close method to output the document as a zip file or folder containing the HTML document.

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname,model1,model2,...modeln) creates a report generator that includes two or more models in the web view that it creates. This constructor assigns an array of default slreportgen.webview.ExportOptions objects to the generator’s ExportOptions property, one for each of the models to be included in the generated document’s web view. You can use the objects to specify custom export options for each of the models to be included in the web view exported to the generated document.

rptgen = slreportgen.webview.Embedded WebViewDocument(rptname,{model1,model2,...modeln}) creates a generator that includes the specified models in the web view that it embeds in the output document.

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname) creates a generator that embeds models specified by the Diagrams property of the generator’s ExportOptions property, for example:

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

Input Arguments

expand all

`rptname` — Name of output report file and/or folder
character vector

Name of the zip file and/or folder containing the report generated by this generator. Use this generator’s PackageType property to specify whether to package the generated report as a file or a folder or both. If you specify an extension, the extension must be .htmx. If you do not specify an extension, the report generator appends .htmx.

`model` — Name of model to export
character vector

Name of model, specified as a character vector, to be embedded in the generated report as a web view.

Output Arguments

expand all

`rptgen` — Embedded web view report generator
`slreportgen.webview.EmbeddedWebViewDocument`

Properties

expand all

`CurrentHoldID` — Identifier of current hole in document
character vector

Identifier of current hole in document, stored as a character vector. This is a read-only property.

`ExportOptions` — Web view export options
`slreportgen.webview.ExportOptions` (default)

An array of slreportgen.webview.ExportOptions objects, one for each model or set of models to be included in the web view exported to the generated report. The generator’s constructor sets this property with default values for the models you specify. Use the properties of the export options object or objects to customize export of the models to the generated web view. For example, you can specify additional models to include or whether to include the block diagrams of masked subsystems and library blocks.

`ForceOverwrite` — Overwrite existing report
`True` (default) | `False`

Whether to overwrite an existing report with the same name. True overwrites the existing report. False generates the report under a new name.

`OpenStatus` — Status of the report being generated
`unopened` (default) | `opened`

Status of the report being generated, either 'unopened' or 'opened'. This is a read-only property.

`OutputPath` — Path of the document output directory
current working directory (default)

Path of the report output directory.

`PackageType` — Packaging for files generated
`'both'` (default) | `'zipped'` | `'unzipped'`

Packaging to use for output document, specified as one of these character vectors:

'both' — Creates both zipped and unzipped output
'zipped' — Creates a zip file with an .htmx extension
'unzipped' — Creates a folder of files

`TemplatePath` — Path of the template used to generate this report
character vector

Path to the HTML template to use to generate this report, specified as a character vector. The template has an .htmtx extension. This property points by default to a default template. To use a custom template, set this property to the path of the custom template.

`TitleBarText` — Text for HTML browser title bar
character vector

Text to display in the title bar of the HTML browser used to display the generated report. The default text is “Simulink Web View - Created by Simulink Report Generator."

`ValidateLinksAndAnchors` — Whether to check validity of hyperlinks between the generated document and web view
`True` (default) | `False`

Generates a warning at the command line if the link target that you specify does not exist or if you specify a link from a model element that already has a link. Validation checking increases the time required to generate a report. For this reason, consider using link validation checking only when debugging your report.

Methods

Method	Purpose
`createDiagramTwoWayLink`	Creates a two-way link between a location in the document in the center panel and a diagram in the web view in the right panel
`createElementTwoWayLink`	Creates a two-way link between a document panel location and a diagram element in the web view
`createDiagramLink`	Creates a link from the document panel to a diagram in the model web view
`createElementLink`	Creates a link from the document panel to an element in the model web view
`fill`	Invoke the embedded web view report generator’s hole filling methods to fill the holes in its template.
`fillslwebview`	Fills template’s slwebview hole with a web view
`getExportModels`	Names of models to be included in the web view
`getExportDiagrams`	Paths and handles of block diagrams to be included in the web view
`getExportSimulinkSubSystems`	Paths and handles of subsystem blocks to be included in this web view
`getExportStateflowCharts`	Paths and handles of Stateflow^® charts to be included in this web view
`getExportStateflowDiagrams`	Array of Stateflow diagram paths
`getReportObject`	Returns the report object for the embedded web view report

Compatibility Considerations

expand all

Items in table of contents are not numbered

Behavior changed in R2019b

Starting in R2019b, items in the table of contents in an embedded web view report are not numbered. To generate numbered items in a table of contents:

Copy the default template for an embedded web view report to the current folder.
```
copyfile(fullfile(matlabroot,'/toolbox/slreportgen/webview/resources/templates/embedded_webview.htmtx'))
```

Unzip the template into the subfolder myTemplate.

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

In myTemplate, navigate to the stylesheets subfolder. Open the root.css file and remove this line from the ol.toc style:
list-style-type: none;
Save the root.css file.
Navigate to the folder that contains the original zipped template file. Package the unzipped template files into a zipped template file.
```
zipTemplate('Newtemplate.htmtx','myTemplate');
```
Set the TemplatePath property of the embedded web view report generator object to the path and name of the new template file. For example, suppose that MyEmbeddedWebView is a subclass of slreportgen.webview.EmbeddedWebViewDocument. Here is the code to set the TemplatePath property of a MyEmbeddedWebView object:
```
rpt = MyEmbeddedWebView(rptName,model);
rpt.TemplatePath = 'NewTemplate.htmtx';
```

Documentation

slreportgen.webview.EmbeddedWebViewDocument class

Description

Construction

Input Arguments

`rptname` — Name of output report file and/or folder
character vector

`model` — Name of model to export
character vector

Output Arguments

`rptgen` — Embedded web view report generator
`slreportgen.webview.EmbeddedWebViewDocument`

Properties

`CurrentHoldID` — Identifier of current hole in document
character vector

`ExportOptions` — Web view export options
`slreportgen.webview.ExportOptions` (default)

`ForceOverwrite` — Overwrite existing report
`True` (default) | `False`

`OpenStatus` — Status of the report being generated
`unopened` (default) | `opened`

`OutputPath` — Path of the document output directory
current working directory (default)

`PackageType` — Packaging for files generated
`'both'` (default) | `'zipped'` | `'unzipped'`

`TemplatePath` — Path of the template used to generate this report
character vector

`TitleBarText` — Text for HTML browser title bar
character vector

`ValidateLinksAndAnchors` — Whether to check validity of hyperlinks between the generated document and web view
`True` (default) | `False`

Methods

Compatibility Considerations

Items in table of contents are not numbered

See Also

Topics

Simulink Report Generator Documentation

Support

Documentation

slreportgen.webview.EmbeddedWebViewDocument class

Description

Construction

Input Arguments

rptname — Name of output report file and/or folder character vector

model — Name of model to export character vector

Output Arguments

rptgen — Embedded web view report generator slreportgen.webview.EmbeddedWebViewDocument

Properties

CurrentHoldID — Identifier of current hole in document character vector

ExportOptions — Web view export options slreportgen.webview.ExportOptions (default)

ForceOverwrite — Overwrite existing report True (default) | False

OpenStatus — Status of the report being generated unopened (default) | opened

OutputPath — Path of the document output directory current working directory (default)

PackageType — Packaging for files generated 'both' (default) | 'zipped' | 'unzipped'

TemplatePath — Path of the template used to generate this report character vector

TitleBarText — Text for HTML browser title bar character vector

ValidateLinksAndAnchors — Whether to check validity of hyperlinks between the generated document and web view True (default) | False

Methods

Compatibility Considerations

Items in table of contents are not numbered

See Also

Topics

Simulink Report Generator Documentation

Support

`rptname` — Name of output report file and/or folder
character vector

`model` — Name of model to export
character vector

`rptgen` — Embedded web view report generator
`slreportgen.webview.EmbeddedWebViewDocument`

`CurrentHoldID` — Identifier of current hole in document
character vector

`ExportOptions` — Web view export options
`slreportgen.webview.ExportOptions` (default)

`ForceOverwrite` — Overwrite existing report
`True` (default) | `False`

`OpenStatus` — Status of the report being generated
`unopened` (default) | `opened`

`OutputPath` — Path of the document output directory
current working directory (default)

`PackageType` — Packaging for files generated
`'both'` (default) | `'zipped'` | `'unzipped'`

`TemplatePath` — Path of the template used to generate this report
character vector

`TitleBarText` — Text for HTML browser title bar
character vector

`ValidateLinksAndAnchors` — Whether to check validity of hyperlinks between the generated document and web view
`True` (default) | `False`