mlreportgen.report.Report class

Пакет: mlreportgen.report

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

Описание

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

The mlreportgen.report.Report класс является handle класс.

Атрибуты класса

HandleCompatible true

Для получения информации об атрибутах класса см. раздел «Атрибуты класса».

Создание

Описание

report = mlreportgen.report.Report() возвращает объект контейнера отчетов со значениями свойств по умолчанию.

report = mlreportgen.report.Report(path) устанавливает свойство OutputPath на path.

пример

report = mlreportgen.report.Report(path,type) также устанавливает свойство Type на type.

report = mlreportgen.report.Report(path,type,template) также устанавливает свойство TemplatePath на template.

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

Свойства

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

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

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

Примечание

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

`PackageType` - Упаковка для сгенерированных файлов
`'zipped'` | `'unzipped'` | `'both'` | `'single-file'`

Упаковка, используемая для сгенерированных файлов, задается как одно из значений в таблице.

Значение	Поддерживаемые типы отчетов	Описание
`'zipped'`	`'docx'`или `'html'`	Генерирует отчет как zip- файла в местоположении, заданном `OutputPath` свойство. zip- файла имеет расширение, соответствующее виду документа (`docx` для выхода или `htmtx` Word для выхода HTML.) Для примера, если тип документа `docx` и `OutputPath` является `s:\docs\MyDoc`, выход упаковывается в zip-файл с именем `s:\docs\MyDoc.docx`.
`'unzipped'`	`'docx'` или `'html'`	Генерирует отчет как отдельные файлы в папке с именем файла `OutputPath` свойство. Для примера, если `OutputPath` является `s:\docs\MyDoc`, папка выхода `s:\docs\MyDoc`.
`'both'`	`'docx'` или `'html'`	Формирует zipped и unzipped выходы.
`'single-file'`	`'pdf'` или `'html-file'`	Генерирует отчет как один файл.

Когда Type свойство 'html', чтобы сгенерировать HTML, который можно открыть без распаковки, установите PackageType на 'unzipped' или 'both'. В папке, которая содержит сгенерированные файлы, откройте root.html файл.

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

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

'pdf' - PDF файла.
'html' - HTML отчет, упакованный как zipped файла, содержащий HTML файла, изображения, таблицу стилей и JavaScript^® файлы отчета. Чтобы сгенерировать HTML как папку, содержащую разархивированные файлы, установите PackageType свойство к 'unzipped' или 'both'.
'html-file' - HTML отчет, состоящий из одного HTML файла, которая содержит текст, таблицы стилей, JavaScript и закодированные в base64 изображения отчета.
'docx' - Microsoft^® Документ Word.

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

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

Опции макета страницы для этого отчета, заданные как mlreportgen.report.ReportLayout объект. Начальное значение Layout свойство является mlreportgen.report.ReportLayout объект со значениями по умолчанию. Настройте макет страницы путем изменения значений свойств. Для получения примера смотрите Создание отчета о ландшафте.

Опции размещения, заданные Layout свойство объектов mlreportgen.report.TitlePage, mlreportgen.report.TableOfContents, и mlreportgen.report.Chapter классы могут переопределять свойства макета страницы, заданные Layout свойство mlreportgen.report.Report объект.

Примечание

The Layout свойство применяется только к отчетам PDF и Word.

`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'. Если вы задаете неподдерживаемый локаль, используется версия на английском языке. См. https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.

Для получения примера смотрите Перевод префиксов заголовков глав.

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

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

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

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

`Context` - Контекст отчета
`containers.Map` объект

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

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

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

Методы

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

Общедоступные методы

`open`	Открывает отчет
`append`	Добавление содержимого в отчет
`add`	(Не рекомендуемый) Добавить содержимое в отчет
`close`	Закройте и сгенерируйте отчет
`rptview`	Откройте сгенерированный файл отчета в средстве просмотра
`mlreportgen.report.Report.createTemplate`	Создание шаблона отчета
`mlreportgen.report.Report.customizeReport`	Создайте класс, производный от класса Report
`mlreportgen.report.Report.getClassFolder`	Расположение файла определения класса отчета
`getTempPath`	Путь к временной директории отчетов
`generateFileName`	Сгенерируйте имя файла временного отчета
`getReportLayout`	Текущий макет страницы отчета
`fill`	Заполнение отверстий шаблона отчета
`getContext`	Получите значение контекста отчета
`setContext`	Установите значение контекста отчета
`ispdf`	Проверить отчет PDF
`isdocx`	Проверяйте, является ли отчет Word
`ishtml`	Проверяйте, есть ли мультифайл в формате HTML
`ishtmlfile`	Проверьте, является ли отчет HTML в одном файле

Примеры

свернуть все

Создание отчета

Создание отчета с помощью Report API.

Импортируйте пакеты DOM и Report API так, чтобы не использовать длинные, полные имена классов.

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

Создайте контейнер отчета.

rpt = Report('My Report','pdf');

Добавьте к отчету заголовка страницу, таблицу содержимого и главу. Глава содержит два раздела, каждый из которых содержит изображение.

append(rpt,TitlePage('Title','My Report'));
append(rpt,TableOfContents);
ch = Chapter('Images');
append(ch,Section('Title','Boeing 747', ...
    'Content',Image(which('b747.jpg'))));
append(ch, Section('Title','Peppers', ...
    'Content',Image(which('peppers.png'))));
append(rpt,ch);
close(rpt);
rptview(rpt);

Создание ландшафтного отчета

Создайте отчет с ландшафтной ориентацией с помощью Report API.

Импортируйте пакеты Report API так, чтобы не использовать длинные, полные имена классов.

import mlreportgen.report.*

Создайте контейнер отчета. В mlreportgen.report.ReportLayout объект, который назначен Layout свойство, установите Landscape свойство к true.

rpt = Report('myreport','pdf');
rpt.Layout.Landscape = true;

Добавить содержимое в отчет. Сгенерируйте и просмотрите отчет.

append(rpt,TitlePage('Title','My Landscape Report'));
append(rpt,TableOfContents);
append(rpt,Chapter('Title','Tests'));
append(rpt,Chapter('Title','Unit Tests'));
close(rpt);
rptview(rpt);

Перевод префиксов заголовков глав

Переведите префиксы заголовков глав на японский язык в английской системе путем установки Locale свойство.

import mlreportgen.report.*
rpt = Report('Japanese Report');
rpt.Locale = 'ja';
house = char(23478); % Kanji character for house
append(rpt, Chapter(house));
close(rpt);
rptview(rpt);

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

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

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

Не рекомендуемый запуск в R2020b

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

mlreportgen.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 = Report("My Report","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 = Report("My Report","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 = Report("My Report","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 = Report("My Report","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);

См. также

mlreportgen.report.Reporter

Темы

Введенный в R2017b

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

mlreportgen.report.Report class

Описание

Атрибуты класса

Создание

Описание

Свойства

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

`PackageType` - Упаковка для сгенерированных файлов
`'zipped'` | `'unzipped'` | `'both'` | `'single-file'`

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

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

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

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

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

`Context` - Контекст отчета
`containers.Map` объект

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

Методы

Общедоступные методы

Примеры

Создание отчета

Создание ландшафтного отчета

Перевод префиксов заголовков глав

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

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

См. также

Темы

MATLAB Report Generator

Поддержка

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

mlreportgen.report.Report class

Описание

Атрибуты класса

Создание

Описание

Свойства

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

PackageType - Упаковка для сгенерированных файлов 'zipped' | 'unzipped' | 'both' | 'single-file'

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

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

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

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

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

Context - Контекст отчета containers.Map объект

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

Методы

Общедоступные методы

Примеры

Создание отчета

Создание ландшафтного отчета

Перевод префиксов заголовков глав

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

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

См. также

Темы

MATLAB Report Generator

Поддержка

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

`PackageType` - Упаковка для сгенерированных файлов
`'zipped'` | `'unzipped'` | `'both'` | `'single-file'`

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

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

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

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

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

`Context` - Контекст отчета
`containers.Map` объект

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

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