Exponenta Banner
exponenta event banner

класс mlreportgen.report.RptFile

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

Создание репортера на основе проводника отчетов

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

Описание

Используйте RptFile для включения содержимого, сгенерированного настройкой проводника отчетов (.rpt) файл в отчете Report API. При добавлении в отчет RptFile репортер:

  1. Выполнение указанного файла настройки проводника отчетов для создания XML-представления DocBook отчета проводника отчетов

  2. Использует измененную версию шаблона преобразования Docbook-to-DOM проводника отчетов для преобразования XML в набор объектов DOM (см. раздел Управление шаблонами преобразования отчетов)

  3. Добавляет содержимое DOM в отчет API отчетов.

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

Создание

Описание

пример

reporter = RptFile() создает пустой отчет на основе проводника отчетов RptFile репортер. Перед добавлением репортера в отчет программа отчетов должна установить SetupFile в путь к настройке проводника отчетов (.rpt) файл. В противном случае возникает ошибка.

По умолчанию RptFile reporter использует шаблон преобразования, который является слегка измененной версией шаблона преобразования Report Explorer по умолчанию для типа вывода отчета. Например, если тип вывода отчета PDF, репортер использует слегка измененную версию шаблона по умолчанию для проводника отчетов. PDF (from template) тип вывода.

Для настройки вывода отчета можно использовать пользовательский шаблон преобразования. Используйте репортер createTemplate метод создания копии одного из шаблонов преобразования, специфичных для типа вывода по умолчанию для отчета, для настройки. Чтобы использовать настроенный шаблон, установите RptFile репортерская TemplateSrc в путь к настраиваемому шаблону.

пример

reporter = RptFile(SetupFile) создает RptFile на основе указанного файла установки Report Explorer (.rpt файл). См. свойство SetupFile.

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

Свойства

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

Путь к файлу настройки проводника отчетов, указанный как символьный массив или строка. Не использовать отчеты на основе форм для файлов установки, используемых с RptFile репортер.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: character array | string

«Источник шаблона преобразования, который будет использоваться этим репортером для преобразования вывода XML файла установки в объекты DOM». Пустое значение определяет использование шаблона по умолчанию для типа вывода создаваемого отчета. Значение строки или символьного массива указывает путь к пользовательской версии шаблона по умолчанию для создаваемого типа вывода.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: character array | string

Имя шаблона для этого репортера, указанное как символьный массив или строка. По умолчанию это свойство задает RptFile, имя шаблона репортера по умолчанию. Этот шаблон по умолчанию находится в библиотеке шаблонов его шаблона преобразования по умолчанию вместе с другими шаблонами, используемыми для преобразования XML-компонентов проводника отчетов в объекты DOM. Шаблон репортера по умолчанию содержит одно отверстие с именем Content для заполнения содержимым DOM, преобразованным из XML-содержимого, созданного программой установки. При изменении имени этого шаблона необходимо присвоить этому свойству новое имя. Можно изменить сам шаблон, но измененный шаблон должен содержать отверстие с именем «Содержимое».

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: character array | string

Цель гиперссылки для этого репортера, указанная как символьный массив или строка, указывающая идентификатор цели связи, или mlreportgen.dom.LinkTarget объект. Значение строки или символьного массива преобразуется в LinkTarget объект. Целевой объект связи непосредственно предшествует содержимому этого репортера в выходном отчете.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: character array | string | object

Методы

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

Примеры

Создание RptFile Reporter

Создание RptFile reporter без указания файла установки. Затем используйте SetupFile , чтобы указать файл настройки проводника отчетов.

reporter = mlreportgen.report.RptFile();
reporter.SetupFile = "my_setup_file.rpt"

Добавить выделенный синтаксисом код в отчет

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

Примечание

Перед выполнением этого примера используйте проводник отчетов для создания файла установки с именем highlight_syntax.rpt. Файл установки для этого примера содержит компонент Preformatted со следующим текстом в поле редактирования: 

% To import the Report API Package, use this command:
%<code_var>
Включить параметр Показывать текст как выделенный синтаксисом код MATLAB, который находится под текстовым полем Предварительно отформатировано. См. раздел Создание файла настройки отчета.

Этот код создает отчет Report API, включающий highlight_syntax.rpt файл установки.

rpt = mlreportgen.report.Report("My Report","pdf");

chap = mlreportgen.report.Chapter...
  ("Include Report Explorer Report Using the RptFile Reporter");
sect1 = mlreportgen.report.Section...
  ("Highlighted Syntax Example");

% Evaluate the expression and assign it to the code variable
evalin('base','code_var = "import mlreportgen.report.*"');

rptfile = mlreportgen.report.RptFile("highlight_syntax.rpt");

add(sect1,rptfile)
add(chap,sect1)
add(rpt,chap)

close(rpt)
rptview(rpt)

См. также

|

Темы

Представлен в R2019a

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

Поддержка