slreportgen.report. Сообщите о классе

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

Суперкласс для создания отчета

Описание

slreportgen.report.Report является контейнером для отчета на основе генераторов отчетов Simulink® и Объектов DOM. Используйте этот объект сгенерировать HTML, PDF или отчет Word на основе шаблонов в библиотеке шаблонов.

Примечание

Используйте объекты этого типа, вместо mlreportgen.report.Report, чтобы создать отчеты Simulink, которые являются отчетами, которые используют генераторы отчетов Simulink, чтобы сгенерировать содержимое. Можно также использовать MATLAB®reporters и Объекты DOM, чтобы сгенерировать содержимое отчета Simulink.

Конструкция

report = slreportgen.report.Report() возвращает отчет объекта отчета с типом отчета по умолчанию (PDF) и именем файла по умолчанию (untitled.pdf).

report = slreportgen.report.Report(path) использует заданный вывод path для отчета.

report = slreportgen.report.Report(path,type) создает заданный type отчета.

report = slreportgen.report.Report(path,type,template) использует заданный шаблон.

report = slreportgen.report.Report(Name,Value) свойства наборов с помощью пар "имя-значение". Можно задать несколько аргументов пары "имя-значение" в любом порядке. Заключите каждое имя свойства в одинарные кавычки.

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

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

Смотрите свойство OutputPath.

Смотрите свойство Type.

Смотрите свойство TemplatePath.

Свойства

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

Отчетный документ вывод path, заданный как строка или символьный массив. Путь является местоположением в файловой системе, где отчет выходной документ хранится. Путь может быть полным путем или путем относительно текущей папки MATLAB, например, 'C:/myreports/reportA.docx' или 'reportA'. Если имя файла не имеет расширения файла, соответствующего свойству Type, соответствующее расширение файла добавляется.

Выведите тип, заданный как одно из этих значений.

  • 'HTML' — Отчет HTML, группированный как заархивированный файл, содержащий файл HTML, изображения, таблицу стилей и файлы JavaScript® отчета.

  • 'HTML-FILE' — Отчет HTML как один файл HTML, содержащий текст, таблицу стилей, JavaScript и base64-закодированные изображения отчета

  • 'PDF' — PdfFile

  • 'DOCX'Microsoft® документ Word

Если вы задаете шаблон с помощью свойства TemplatePath, значение для Type должно совпадать с типом шаблона.

Параметры макета страницы для этого отчета, заданного как объект размещения отчета. Смотрите mlreportgen.report.ReportLayout.

Локаль или язык, заданный как ISO 639-1 двухбуквенный код языка локали, для которой состоит в том, чтобы быть сгенерирован этот отчет. [] по умолчанию задает язык системной локали, например, английского языка в английской системе. API Отчета использует код языка, чтобы перевести префиксы заголовка главы в язык заданной локали. Переводы обеспечиваются для следующих локалей: af, ca, cs, da, de, el, en, es, et, eu, fi, fr, hu, id, it, ja, ko, nl, nn, no, pl, pt, ro, ru, sk, sl, sr, sv, tr, uk, xh и zh. Если вы задаете неподдерживаемую локаль, английская версия используется. См. коды ISO 639-1.

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

Этим свойством только для чтения является mlreportgen.dom.Document, который используется, чтобы сгенерировать содержимое отчета.

Это свойство только для чтения является объектом containers.Map, который содержит информацию для генерации отчета, такого как иерархический уровень текущего раздела отчета.

Режим отладки, заданный как логическое. Если вы устанавливаете Debug на true, временные файлы для отчета хранятся в подпапке папки отчета. В режиме отладки не удалены эти файлы, когда отчет закрывается.

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

Методы

Этот класс использует те же методы в качестве версии MATLAB. Вместо того, чтобы использовать mlreportgen в имени класса, используйте slreportgen. Смотрите mlreportgen.report.Report для списка методов.

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Введенный в R2017b