Exponenta Banner

slreportgen.webview.EmbeddedWebViewDocument class

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

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

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

Описание

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

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

  • Генератор отчетов на основе slreporten.report.Report объект. Можно использовать DOM и API Отчета, чтобы заполнить содержимое документа.

  • Шаблон HTML с тремя панелями для оглавления (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 схематически изображает пути
getReportObjectВозвращает объект отчета для встроенного отчета веб-представления

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

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

Поведение изменяется в R2019b

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

Темы

Введенный в R2017a

Документация Simulink Report Generator
Поддержка