slreportgen.report.Report class

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

Контейнер отчета

Описание

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

Примечание

Используйте объекты этого типа, а не mlreportgen.report.Report, чтобы создать отчеты Simulink, которые являются отчетами, которые используют репортеры Simulink для генерации содержимого. Можно также использовать MATLAB^® репортеры и объекты 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) устанавливает свойства с помощью пар "имя-значение". Можно задать несколько аргументы пары "имя-значение" в любом порядке. Заключайте каждое имя свойства в одинарные кавычки.

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

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

`path` - Путь выхода отчета
`untitled.pdf` (по умолчанию) | строку | символьный массив

См. свойство OutputPath.

`type` - Тип выхода отчета
`'pdf'` (по умолчанию) | `'html'` | `'html-file'` | `'docx'`

См. свойство Type.

`template` - Шаблон отчета
строка | символьный массив

См. свойство TemplatePath.

Свойства

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

`OutputPath` - Путь к выходному документу отчета
строка | символьный массив

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

Примечание

Создание отчета PDF на облачном диске, таком как MATLAB Drive™, может привести к ошибке, вызванной файлом противоречиями между программным обеспечением генерации отчетов и программным обеспечением синхронизации облачного диска. Чтобы избежать этой ошибки, сгенерируйте отчеты на локальном диске, который не синхронизируется с облаком. Рассмотрите запись скрипта, который генерирует отчет на локальном диске, а затем копирует отчет на облачный диск.

`Type` - Тип выхода
строка | вектор символов | `'docx'` | `'pdf'`

Выходной тип, заданный как одно из следующих значений.

'HTML' - HTML, упакованный как zipped-файл, содержащий HTML, изображения, таблицу стилей и JavaScript^® файлы отчета.
'HTML-FILE' - HTML как один HTML, содержащий текст, таблицу стилей, JavaScript и закодированные в base64 изображения отчета
'PDF' - PDF
'DOCX' - Microsoft^® Документ Word

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

`Layout` - опции макета страницы
`mlreportgen.report.ReportLayout` объект

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

`Locale` - Локаль или язык
`[]` (по умолчанию) | строку | символьный массив

Локаль или язык, заданный как двухбуквенный код языка ISO 639-1 локали, для которой должен быть создан этот отчет. Значение по умолчанию [] задает язык системной локали, например, английский язык в английской системе. Report 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. Если вы задаете неподдерживаемый локаль, используется версия на английском языке. См. коды 639-1 ISO.

`TemplatePath` - Расположение шаблона
строка | символьный массив

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

`Document` - Базовый объект документа DOM
Объект документа DOM

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

`Context` - Контейнер для ключей и значений
объект map

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

`Debug` - Режим отладки
`false` (по умолчанию) | `true`

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

`CompileModelBeforeReporting` - Скомпилируйте модель Simulink
`true` (по умолчанию) | `false`

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

Методы

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

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

Указатель. Чтобы узнать, как классы handle влияют на операции копирования, см. раздел «Копирование объектов».

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

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

`add` метод не рекомендуется

Начиная с R2020b, используйте append метод вместо add метод для добавления содержимого к объектам этих классов Report API:

slreportgen.report.Report
mlreportgen.report.Chapter
mlreportgen.report.Section

Чтобы добавить содержимое к объекту DOM API, такому как mlreportgen.dom.Paragraph , продолжите использовать append метод объекта DOM. Преимущество использования append добавление содержимого к объектам Report API заключается в том, что для добавления содержимого к объектам DOM API используется то же имя метода, что и для добавления содержимого.

Нет планов по удалению add методы Report, Chapter, или Section классы. Сообщите о программах API, которые используют add методы продолжат выполняться.

Чтобы обновить существующий код, замените имя метода add с append как показано примерами в таблице.

Не рекомендуется	Рекомендуется
import mlreportgen.report.* import mlreportgen.dom.* rpt = slreportgen.report.Report("myrpt","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); add(sect,para); add(ch,sect); add(rpt,ch); close(rpt); rptview(rpt);	import mlreportgen.report.* import mlreportgen.dom.* rpt = slreportgen.report.Report("myrpt","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); append(sect,para); append(ch,sect); append(rpt,ch); close(rpt); rptview(rpt);

Не рекомендуется

Рекомендуется

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = slreportgen.report.Report("myrpt","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
add(sect,para);
add(ch,sect);
add(rpt,ch);

close(rpt);
rptview(rpt);

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = slreportgen.report.Report("myrpt","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
append(sect,para);
append(ch,sect);
append(rpt,ch);

close(rpt);
rptview(rpt);

См. также

Темы

Введенный в R2017b

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

slreportgen.report.Report class

Описание

Конструкция

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

`path` - Путь выхода отчета
`untitled.pdf` (по умолчанию) | строку | символьный массив

`type` - Тип выхода отчета
`'pdf'` (по умолчанию) | `'html'` | `'html-file'` | `'docx'`

`template` - Шаблон отчета
строка | символьный массив

Свойства

`OutputPath` - Путь к выходному документу отчета
строка | символьный массив

`Type` - Тип выхода
строка | вектор символов | `'docx'` | `'pdf'`

`Layout` - опции макета страницы
`mlreportgen.report.ReportLayout` объект

`Locale` - Локаль или язык
`[]` (по умолчанию) | строку | символьный массив

`TemplatePath` - Расположение шаблона
строка | символьный массив

`Document` - Базовый объект документа DOM
Объект документа DOM

`Context` - Контейнер для ключей и значений
объект map

`Debug` - Режим отладки
`false` (по умолчанию) | `true`

`CompileModelBeforeReporting` - Скомпилируйте модель Simulink
`true` (по умолчанию) | `false`

Методы

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

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

`add` метод не рекомендуется

См. также

Темы

Simulink Report Generator

Поддержка

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

slreportgen.report.Report class

Описание

Конструкция

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

path - Путь выхода отчета untitled.pdf (по умолчанию) | строку | символьный массив

type - Тип выхода отчета 'pdf' (по умолчанию) | 'html' | 'html-file' | 'docx'

template - Шаблон отчета строка | символьный массив

Свойства

OutputPath - Путь к выходному документу отчета строка | символьный массив

Type - Тип выхода строка | вектор символов | 'docx' | 'pdf'

Layout - опции макета страницы mlreportgen.report.ReportLayout объект

Locale - Локаль или язык [] (по умолчанию) | строку | символьный массив

TemplatePath - Расположение шаблона строка | символьный массив

Document - Базовый объект документа DOM Объект документа DOM

Context - Контейнер для ключей и значений объект map

Debug - Режим отладки false (по умолчанию) | true

CompileModelBeforeReporting - Скомпилируйте модель Simulink true (по умолчанию) | false

Методы

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

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

add метод не рекомендуется

См. также

Темы

Simulink Report Generator

Поддержка

`path` - Путь выхода отчета
`untitled.pdf` (по умолчанию) | строку | символьный массив

`type` - Тип выхода отчета
`'pdf'` (по умолчанию) | `'html'` | `'html-file'` | `'docx'`

`template` - Шаблон отчета
строка | символьный массив

`OutputPath` - Путь к выходному документу отчета
строка | символьный массив

`Type` - Тип выхода
строка | вектор символов | `'docx'` | `'pdf'`

`Layout` - опции макета страницы
`mlreportgen.report.ReportLayout` объект

`Locale` - Локаль или язык
`[]` (по умолчанию) | строку | символьный массив

`TemplatePath` - Расположение шаблона
строка | символьный массив

`Document` - Базовый объект документа DOM
Объект документа DOM

`Context` - Контейнер для ключей и значений
объект map

`Debug` - Режим отладки
`false` (по умолчанию) | `true`

`CompileModelBeforeReporting` - Скомпилируйте модель Simulink
`true` (по умолчанию) | `false`

`add` метод не рекомендуется