slreportgen.webview. Класс EmbeddedWebViewDocument

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

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

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

Описание

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

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

  • Документ DOM, чтобы сгенерировать отчет

  • Шаблон HTML DOM с тремя панелями для оглавления (TOC), содержимого документа и веб-представления, соответственно

  • Обработайте дыры по шаблону, чтобы быть заполненными содержимым документа и веб-представлением, соответственно. Дыру для веб-представления называют slwebview и располагают в правильной панели отчета. Дыру для содержимого документа называют Content и располагают в центральной панели отчета.

  • Методы для заполнения документа и дыр веб-представления.

  • Методы для создания двухсторонних гиперссылок между содержимым документа и встроенным webview (s)

  • JavaScript, который генерирует TOC из заголовков документа, когда отчет открывает в браузере

  • Образцовые опции экспорта, которые позволяют вам задавать модели и подсистемы, которые будут встроены как веб-представления в сгенерированном отчете

  • Методы для получения элементов (схемы, блоки, графики, и т.д.) из моделей, которые будут встроены как веб-представления в отчете

Конструкция

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 generator’s ExportOptions свойства, например:

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

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

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

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

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

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

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

Свойства

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

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

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

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

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

Путь отчета вывел директорию.

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

  • 'both' — Создает и заархивированный и разархивированный вывод

  • 'zipped' — Создает zip-файл с расширением .htmx

  • 'unzipped' — Создает папку файлов

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

Текст, чтобы отобразиться в строке заголовка браузера HTML раньше отображал сгенерированный отчет. Текст по умолчанию является “Веб-представлением Simulink - Созданный Simulink Report Generator".

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

Методы

Метод

Цель

createDiagramTwoWayLink

Создает двухстороннюю ссылку между местоположением в документе в центральной панели и схемой в веб-представлении в правильной панели

createElementTwoWayLink

Создает двухстороннюю ссылку между местоположением панели документа и элементом диаграммы в веб-представлении

createDiagramLink

Создает ссылку от панели документа до схемы в образцовом веб-представлении

createElementLink

Создает ссылку от панели документа до элемента в образцовом веб-представлении

fill

Вызовите встроенные методы заполнения дыры генератора отчетов веб-представления, чтобы заполнить дыры в его шаблоне.

fillslwebviewslwebview дыра шаблона заливок с веб-представлением
getExportModelsИмена моделей, которые будут включены в веб-представление
getExportDiagramsПути и указатели блок-схем, которые будут включены в веб-представление
getExportSimulinkSubSystemsПути и указатели подсистемы блокируются, чтобы быть включенными в это веб-представление
getExportStateflowChartsПути и указатели Stateflow® строят диаграмму, чтобы быть включенными в это веб-представление
getExportStateflowDiagramsМассив Stateflow схематически изображает пути

Смотрите также

|

Темы

Введенный в R2017a

Документация Simulink Report Generator
Поддержка
Для просмотра документации необходимо авторизоваться на сайте