mlreportgen.report.Report class

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

Суперкласс для создания отчета

Описание

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

Конструкция

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

report = Report(path) использует заданный выход path для отчета.

report = Report(path,type) создает заданный type из отчета.

report = Report(path,type,template) использует заданный шаблон.

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

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

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

Свойство See OutputPath.

Свойство See Type.

Свойство See TemplatePath.

Свойства

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

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

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

  • 'HTML' – Отчет HTML, группированный как заархивированный файл, содержащий файл HTML, изображения, таблицу стилей и файлы JavaScript® отчета.

  • 'HTML-FILE' – Отчет HTML как один файл HTML, содержащий текст, таблицу стилей, JavaScript и base64-закодированные изображения отчета

  • 'PDF' pdfFile

  • 'DOCX'Microsoft® документ Word

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

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

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

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

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

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

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

Методы

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

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

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

Введенный в R2017b

Для просмотра документации необходимо авторизоваться на сайте