slreportgen.webview.EmbeddedWebViewDocument class

Пакет: slreportgen.webview
Суперклассы:

Создайте генератор отчетов, который генерирует HTML, содержащий взаимосвязанный документ и связанное веб-представление

Описание

Создает генератор отчетов, который генерирует HTML, содержащий документ и веб-представление одного или нескольких Simulink^® модели с двухсторонними гиперссылками между документом и веб-представлением.

Этот класс предоставляет следующие возможности для создания отчетов о встраиваемых веб-представлениях:

Генератор отчетов на основе slreporten.report.Report объект. Для заполнения содержимого документа можно использовать DOM и API отчетов.
Шаблон HTML с тремя панелями для таблицы содержимого (TOC), содержимого документа и веб-представления, соответственно
Отверстия шаблона, заполняемые содержимым документа и веб-представлением, соответственно. Отверстие для веб-представления имеет имя slwebview и находится в правой панели отчета. Отверстие для содержимого документа имеет имя Content и находится в центральной панели отчета.
Методы заполнения отверстий для документов и веб-представления.
Методы для создания двусторонних гиперссылок между содержимым документа и встраиваемым веб-видом (видами)
JavaScript, который генерирует ТОС из заголовков документов, когда отчет открывается в браузере
Опции экспорта модели, которые позволяют вам задавать модели и подсистемы, которые будут встроены в качестве веб-представлений в сгенерированный отчет
Методы извлечения элементов (схем, блоков, графиков и т.д.) из моделей, которые должны быть встроены в виде веб-представлений в отчет

Конструкция

rptgen = slreportgen.webview.Embedded WebViewDocument(rptname,model) создает генератор отчетов, который генерирует отчет с заданным именем файла и содержащий веб-представление указанной модели. Используйте fill генератора метод для генерации веб-представления и встраивания веб-представления в документ. Используйте close генератора метод вывода документа в виде zip- файла или папки, содержащей HTML документ.

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname,model1,model2,...modeln) создает генератор отчетов, который включает две или более моделей в веб-представлении, которое он создает. Этот конструктор присваивает массив по умолчанию slreportgen.webview.ExportOptions объекты для ExportOptions генератора свойство, по одной для каждой модели, которая будет включена в веб-представление сгенерированного документа. Можно использовать объекты, чтобы задать пользовательские опции экспорта для каждой модели, которая будет включена в веб-представление, экспортированное в сгенерированный документ.

rptgen = slreportgen.webview.Embedded WebViewDocument(rptname,{model1,model2,...modeln}) создает генератор, который включает указанные модели в веб-представление, встраиваемое в выход документ.

rptgen = slreportgen.webview.EmbeddedWebViewDocument(rptname) создает генератор, который встраивает модели, заданные Diagrams свойство ExportOptions генератора свойство, для примера:

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

Входные параметры

расширить все

`rptname` - Имя файла выходного отчета и/или папки
вектор символов

Имя zip- файла и/или папки, содержащей отчет, сгенерированный этим генератором. Используйте PackageType этого генератора свойство, чтобы указать, упаковать ли сгенерированный отчет как файл, или папку, или и то, и другое. Если вы задаете расширение, то расширение должно быть .htmx. Если вы не задаете расширение, генератор отчетов добавляет .htmx.

`model` - Имя модели для экспорта
вектор символов

Имя модели, заданное как вектор символов, которая должна быть встроена в сгенерированный отчет как веб-представление.

Выходные аргументы

расширить все

`rptgen` - Встроенный генератор отчетов веб-представления
`slreportgen.webview.EmbeddedWebViewDocument`

Свойства

расширить все

`CurrentHoldID` - Идентификатор текущего отверстия в документе
вектор символов

Идентификатор текущего отверстия в документе, сохраненный как вектор символов. Это свойство доступно только для чтения.

`ExportOptions` - опции экспорта веб-представления
`slreportgen.webview.ExportOptions` (по умолчанию)

Массив slreportgen.webview.ExportOptions объекты, по одному для каждой модели или набора моделей, которые будут включены в веб-представление, экспортированное в сгенерированный отчет. Конструктор генератора устанавливает это свойство значениями по умолчанию для заданных вами моделей. Используйте свойства объекта или объектов опций экспорта, чтобы настроить экспорт моделей в сгенерированное веб-представление. Например, можно задать дополнительные модели для включения или включения блок-схем маскированных подсистем и библиотечных блоков.

`ForceOverwrite` - Перезаписать существующий отчет
`True` (по умолчанию) | `False`

Перезаписывать ли существующий отчет с таким же именем. True перезаписывает существующий отчет. False создает отчет под новым именем.

`OpenStatus` - Состояние формируемого отчета
`unopened` (по умолчанию) | `opened`

Состояние генерируемого отчета 'unopened' или 'opened'. Это свойство доступно только для чтения.

`OutputPath` - Путь к выходной директории документа
текущая рабочая директория (по умолчанию)

Путь к выходной директории отчета.

`PackageType` - Упаковка для сгенерированных файлов
`'both'` (по умолчанию) | `'zipped'` | `'unzipped'`

Упаковка для использования выхода документе в качестве одного из следующих векторов символов:

'both' - Создает как zipped, так и unzipped выход
'zipped' - Создает zip-файл с .htmx расширение
'unzipped' - Создает папку файлов

`TemplatePath` - Путь к шаблону, используемому для генерации этого отчета
вектор символов

Путь к HTML шаблона, используемой для генерации этого отчета, заданный как вектор символов. Шаблон имеет .htmtx расширение. Это свойство указывает по умолчанию на шаблон по умолчанию. Чтобы использовать пользовательский шаблон, задайте для этого свойства путь к пользовательскому шаблону.

`TitleBarText` - Текст для строки заголовка браузера HTML
вектор символов

Текст для отображения в строке заголовка HTML, используемой для отображения сгенерированного отчета. Текст по умолчанию является «Simulink Веб-представления - Created by Simulink Report Generator».

`ValidateLinksAndAnchors` - Проверять ли валидность гиперссылок между сгенерированным документом и веб-представлением
`True` (по умолчанию) | `False`

Генерирует предупреждение в командной строке, если указанная вами цель звена не существует или если вы задаете ссылку из элемента модели, который уже имеет ссылку. Проверка валидации увеличивает время, необходимое для создания отчета. По этой причине рассмотрите использование ссылки валидации проверки только при отладке отчета.

Методы

Метод	Цель
`createDiagramTwoWayLink`	Создание двухсторонней ссылки между расположением в документе на центральной панели и схемой в веб-представлении на правой панели
`createElementTwoWayLink`	Создание двухсторонней ссылки между расположением панели документов и элементом схемы в веб-представлении
`createDiagramLink`	Создает ссылку из панели документов на схему в веб-представлении модели
`createElementLink`	Создает ссылку из панели документов на элемент в веб-представлении модели
`fill`	Активируйте встроенные методы заполнения отверстий генератора отчетов веб-представления, чтобы заполнить отверстия в его шаблоне.
`fillslwebview`	Заполняет отверстие slwebview шаблона веб-представления
`getExportModels`	Имена моделей, которые будут включены в веб-представление
`getExportDiagrams`	Пути и указатели на блоки будут включены в веб-представление
`getExportSimulinkSubSystems`	Пути и указатели на блоки подсистем, которые будут включены в это веб-представление
`getExportStateflowCharts`	Пути и указатели на Stateflow^® Графики, которые будут включены в это веб-представление
`getExportStateflowDiagrams`	Массив путей схем Stateflow
`getReportObject`	Возвращает объект отчета для встроенного отчета о веб-представлении

Вопросы совместимости

расширить все

Элементы в таблицу содержимого не пронумерованы

Поведение изменено в R2019b

Начиная с R2019b, элементы таблицы содержимого во встроенном отчете о веб-представлении не нумеруются. Чтобы сгенерировать пронумерованные элементы в таблицу содержимого:

Скопируйте шаблон по умолчанию для встроенного отчета веб-представления в текущую папку.
```
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 файл.
Перейдите к папке, содержащей исходный файл zipped шаблона. Упакуйте разархивированные файлы шаблона в zipped файл шаблона.
```
zipTemplate('Newtemplate.htmtx','myTemplate');
```
Установите TemplatePath свойство объекта генератора отчетов встроенного веб-представления в путь и имя нового файла шаблона. Например, предположим, что MyEmbeddedWebView является подклассом slreportgen.webview.EmbeddedWebViewDocument. Вот код для установки TemplatePath свойство MyEmbeddedWebView объект:
```
rpt = MyEmbeddedWebView(rptName,model);
rpt.TemplatePath = 'NewTemplate.htmtx';
```

См. также

slreportgen.webview.ExportOptions

Темы

Введенный в R2017a

Документация

slreportgen.webview.EmbeddedWebViewDocument class

Описание

Конструкция

Входные параметры

`rptname` - Имя файла выходного отчета и/или папки
вектор символов

`model` - Имя модели для экспорта
вектор символов

Выходные аргументы

`rptgen` - Встроенный генератор отчетов веб-представления
`slreportgen.webview.EmbeddedWebViewDocument`

Свойства

`CurrentHoldID` - Идентификатор текущего отверстия в документе
вектор символов

`ExportOptions` - опции экспорта веб-представления
`slreportgen.webview.ExportOptions` (по умолчанию)

`ForceOverwrite` - Перезаписать существующий отчет
`True` (по умолчанию) | `False`

`OpenStatus` - Состояние формируемого отчета
`unopened` (по умолчанию) | `opened`

`OutputPath` - Путь к выходной директории документа
текущая рабочая директория (по умолчанию)

`PackageType` - Упаковка для сгенерированных файлов
`'both'` (по умолчанию) | `'zipped'` | `'unzipped'`

`TemplatePath` - Путь к шаблону, используемому для генерации этого отчета
вектор символов

`TitleBarText` - Текст для строки заголовка браузера HTML
вектор символов

`ValidateLinksAndAnchors` - Проверять ли валидность гиперссылок между сгенерированным документом и веб-представлением
`True` (по умолчанию) | `False`

Методы

Вопросы совместимости

Элементы в таблицу содержимого не пронумерованы

См. также

Темы

Simulink Report Generator

Поддержка

Документация

slreportgen.webview.EmbeddedWebViewDocument class

Описание

Конструкция

Входные параметры

rptname - Имя файла выходного отчета и/или папки вектор символов

model - Имя модели для экспорта вектор символов

Выходные аргументы

rptgen - Встроенный генератор отчетов веб-представления slreportgen.webview.EmbeddedWebViewDocument

Свойства

CurrentHoldID - Идентификатор текущего отверстия в документе вектор символов

ExportOptions - опции экспорта веб-представления slreportgen.webview.ExportOptions (по умолчанию)

ForceOverwrite - Перезаписать существующий отчет True (по умолчанию) | False

OpenStatus - Состояние формируемого отчета unopened (по умолчанию) | opened

OutputPath - Путь к выходной директории документа текущая рабочая директория (по умолчанию)

PackageType - Упаковка для сгенерированных файлов 'both' (по умолчанию) | 'zipped' | 'unzipped'

TemplatePath - Путь к шаблону, используемому для генерации этого отчета вектор символов

TitleBarText - Текст для строки заголовка браузера HTML вектор символов

ValidateLinksAndAnchors - Проверять ли валидность гиперссылок между сгенерированным документом и веб-представлением True (по умолчанию) | False

Методы

Вопросы совместимости

Элементы в таблицу содержимого не пронумерованы

См. также

Темы

Simulink Report Generator

Поддержка

`rptname` - Имя файла выходного отчета и/или папки
вектор символов

`model` - Имя модели для экспорта
вектор символов

`rptgen` - Встроенный генератор отчетов веб-представления
`slreportgen.webview.EmbeddedWebViewDocument`

`CurrentHoldID` - Идентификатор текущего отверстия в документе
вектор символов

`ExportOptions` - опции экспорта веб-представления
`slreportgen.webview.ExportOptions` (по умолчанию)

`ForceOverwrite` - Перезаписать существующий отчет
`True` (по умолчанию) | `False`

`OpenStatus` - Состояние формируемого отчета
`unopened` (по умолчанию) | `opened`

`OutputPath` - Путь к выходной директории документа
текущая рабочая директория (по умолчанию)

`PackageType` - Упаковка для сгенерированных файлов
`'both'` (по умолчанию) | `'zipped'` | `'unzipped'`

`TemplatePath` - Путь к шаблону, используемому для генерации этого отчета
вектор символов

`TitleBarText` - Текст для строки заголовка браузера HTML
вектор символов

`ValidateLinksAndAnchors` - Проверять ли валидность гиперссылок между сгенерированным документом и веб-представлением
`True` (по умолчанию) | `False`