slreportgen.webview.EmbeddedWebViewDocument класс

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

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

развернуть все на странице

Описание

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

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

Генератор отчетов на основе slreporten.report.Report объект. Для заполнения содержимого документа можно использовать API DOM и Report.
HTML-шаблон с тремя панелями для оглавления (оглавления), содержимого документа и веб-представления, соответственно;
Отверстия шаблона, заполняемые содержимым документа и веб-видом соответственно. Отверстие для веб-вида имеет имя 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' - Создает zip-файл с помощью .htmx расширение
'unzipped' - Создает папку файлов

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

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

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

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

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

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

Методы

Метод	Цель
`createDiagramTwoWayLink`	Создание двусторонней связи между местоположением в документе на центральной панели и диаграммой в веб-представлении на правой панели
`createElementTwoWayLink`	Создание двусторонней связи между расположением панели документа и элементом схемы в веб-представлении
`createDiagramLink`	Создание ссылки из панели документа на схему в веб-представлении модели
`createElementLink`	Создание ссылки из панели документа на элемент в веб-представлении модели
`fill`	Вызовите методы заполнения отверстий во встроенном генераторе отчетов веб-вида, чтобы заполнить отверстия в его шаблоне.
`fillslwebview`	Заполнение отверстия сводного вида шаблона веб-видом
`getExportModels`	Имена моделей, включаемых в веб-представление
`getExportDiagrams`	Пути и дескрипторы блок-схем для включения в веб-представление
`getExportSimulinkSubSystems`	Пути и дескрипторы блоков подсистем, которые должны быть включены в это веб-представление
`getExportStateflowCharts`	Пути и дескрипторы диаграмм Stateflow ®, которые будут включены в это веб-представление
`getExportStateflowDiagrams`	Массив путей диаграммы потока состояний
`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 файл.
Перейдите к папке, содержащей исходный архивированный файл шаблона. Упакуйте распакованные файлы шаблонов в запертый файл шаблонов.
```
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 класс

Описание

Строительство

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

`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

Поддержка

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

slreportgen.webview.EmbeddedWebViewDocument класс

Описание

Строительство

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

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

Поддержка

`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`