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

Пакет: mlreportgen.report

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

Описание

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

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` для вывода в формате 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 объект.

Примечание

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

`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'. Если указан неподдерживаемый языковой стандарт, используется английская версия. Смотрите 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-отчета

Примеры

свернуть все

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

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

Импортируйте пакеты 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);

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

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

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

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 метод добавления содержимого к объектам следующих классов API отчетов:

mlreportgen.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 = 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.Класс отчета

Описание

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

Создание

Описание

Свойства

`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

Поддержка

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

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

Описание

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

Создание

Описание

Свойства

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

Поддержка

`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` метод не рекомендуется