mlreportgen.report.Report class

Пакет: 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` для Word выход или `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'`	Генерирует заархивированные и разархивированные выходные параметры.
`'single-file'`	`'pdf'` или `'html-file'`	Генерирует отчет как один файл.

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

`Type` 'OutputType'
`'pdf'` (значение по умолчанию) | `'html'` | `'html-file'` | `'docx'`

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

'pdf' pdfFile .
'html' – Отчет HTML, упакованный как заархивированный файл, который содержит файл 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 свойство применяется только к отчетам Word и PDF.

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

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

Методы

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

Открытые методы

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

Примеры

свернуть все

Создайте отчет

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

Импортируйте DOM и пакеты 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 Отчета.

Импортируйте пакеты 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 метод, чтобы добавить содержимое в объекты этих классов API Отчета:

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