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` — Сообщите о выходе path
`untitled.pdf` (значение по умолчанию) | представляет в виде строки | символьный массив

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

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

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

`template` — Шаблон Report
представьте в виде строки | символьный массив

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

Свойства

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

`OutputPath` — Отчетный документ выход path
представьте в виде строки | символьный массив

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

Примечание

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

`Type` 'OutputType'
представьте в виде строки | вектор символов | `'docx'` | `'pdf'`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

`CompileModelBeforeReporting` — Модель Compile Simulink
`true` (значение по умолчанию) | `false`

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

Методы

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

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

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

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

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

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

При запуске в R2020b используйте append метод вместо add метод, чтобы добавить содержимое в объекты этих классов API Отчета:

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

Добавить содержимое в объект DOM API, такой как mlreportgen.dom.Paragraph возразите, продолжите использовать append метод Объекта DOM. Преимущество использования append добавить содержимое, чтобы Сообщить об объектах АПИ то, что вы используете то же имя метода, как вы используете, чтобы добавить содержимое в объекты ДОМА АПИ.

Нет никаких планов удалить 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` — Сообщите о выходе path
`untitled.pdf` (значение по умолчанию) | представляет в виде строки | символьный массив

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

`template` — Шаблон Report
представьте в виде строки | символьный массив

Свойства

`OutputPath` — Отчетный документ выход path
представьте в виде строки | символьный массив

`Type` 'OutputType'
представьте в виде строки | вектор символов | `'docx'` | `'pdf'`

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

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

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

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

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

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

`CompileModelBeforeReporting` — Модель Compile Simulink
`true` (значение по умолчанию) | `false`

Методы

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

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

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

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

Темы

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

Поддержка

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

slreportgen.report.Report class

Описание

Конструкция

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

path — Сообщите о выходе path untitled.pdf (значение по умолчанию) | представляет в виде строки | символьный массив

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

template — Шаблон Report представьте в виде строки | символьный массив

Свойства

OutputPath — Отчетный документ выход path представьте в виде строки | символьный массив

Type 'OutputType' представьте в виде строки | вектор символов | 'docx' | 'pdf'

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

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

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

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

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

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

CompileModelBeforeReporting — Модель Compile Simulink true (значение по умолчанию) | false

Методы

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

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

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

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

Темы

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

Поддержка

`path` — Сообщите о выходе path
`untitled.pdf` (значение по умолчанию) | представляет в виде строки | символьный массив

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

`template` — Шаблон Report
представьте в виде строки | символьный массив

`OutputPath` — Отчетный документ выход path
представьте в виде строки | символьный массив

`Type` 'OutputType'
представьте в виде строки | вектор символов | `'docx'` | `'pdf'`

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

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

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

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

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

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

`CompileModelBeforeReporting` — Модель Compile Simulink
`true` (значение по умолчанию) | `false`

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