slreportgen.report.Класс отчета

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

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

Описание

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

Примечание

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

Строительство

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'`

См. свойство Тип.

`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 языкового стандарта, для которого должен быть создан этот отчет. Дефолт [] определяет язык языкового стандарта системы, например английский язык в системе на английском языке. API Report использует код языка для перевода префиксов заголовка главы на язык указанного языкового стандарта. Переводы предоставляются для следующих языковых стандартов: 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` - Контейнер для ключей и значений
объект карты

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

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

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

`CompileModelBeforeReporting` - Компиляция модели Simulink
`true` (по умолчанию) | `false`

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

Методы

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

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

Ручка. Сведения о том, как классы обработки влияют на операции копирования, см. в разделе Копирование объектов.

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

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

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

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

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

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

Нет планов по удалению 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.Класс отчета

Описание

Строительство

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

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

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

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

Свойства

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

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

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

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

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

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

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

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

`CompileModelBeforeReporting` - Компиляция модели Simulink
`true` (по умолчанию) | `false`

Методы

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

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

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

См. также

Темы

Документация по генератору отчетов Simulink

Поддержка

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

slreportgen.report.Класс отчета

Описание

Строительство

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

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

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

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

Свойства

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

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

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

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

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

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

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

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

CompileModelBeforeReporting - Компиляция модели Simulink true (по умолчанию) | false

Методы

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

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

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

См. также

Темы

Документация по генератору отчетов Simulink

Поддержка

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

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

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

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

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

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

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

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

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

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

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

`CompileModelBeforeReporting` - Компиляция модели Simulink
`true` (по умолчанию) | `false`

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