mlreportgen.report.HTMLModuleTabs class

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

Создание панелей с вкладками

Описание

Система координат mlreportgen.report.HTMLModuleTabs reporter добавляет виджет, состоящий из стека панелей с вкладками (вкладок модулей), в HTML. При выборе вкладки отображается содержимое панели. Используйте этого репортера для отображения связанной информации в компактной форме.

Примечание

Использование HTMLModuleTabs репортажи только с HTML или однофайловыми HTML отчетами.

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

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

HandleCompatible
true

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

Создание

Описание

пример

tabsObj = mlreportgen.report.HTMLModuleTabs() создает пустой HTMLModuleTabs репортер. Метки вкладок и содержимое необходимо задать с помощью свойства TabsData. Добавление пустого HTMLModuleTabs репортер в отчет создает ошибку.

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

Свойства

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

Метки вкладок и содержимое панелей, заданные как массив структур с этими полями:

  • Label - Метка вкладка, заданная в виде вектора символов, строкового скаляра или mlreportgen.dom.Text объект. Используйте уникальную метку для каждой вкладки.

  • Content - содержимое панели, заданное в качестве одного из следующих значений:

    • Вектор символов или строковый скаляр

    • Объект DOM

    • Объект Report API reporter

    Примечание

    Чтобы включить несколько объектов DOM на одну вкладку, установите Content поле к mlreportgen.dom.Group объект, содержащий объекты DOM.

Источник шаблона для этого репортера, заданный одним из следующих способов:

  • Вектор символов или строковый скаляр, который задает путь к файлу, содержащему шаблон для этого репортера

  • Репортер или отчет, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

  • DOM-документ или деталь документа, шаблон которой используется для этого репортера или библиотека шаблонов которой содержит шаблон для этого репортера

Для отчета HTML тип шаблона должен быть htmtx. Для отчета в одном файле тип должен быть htmt.

Имя шаблона для этого репортера, заданное как вектор символов или строковый скаляр. Шаблон для этого репортера должен быть в библиотеке шаблонов источника шаблона (TemplateSrc) для этого репортера.

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

Методы

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

Примеры

свернуть все

Этот пример генерирует отчет HTML в одном файле, который имеет отдельную панель с вкладками для каждой системной схемы Simulink® модель.

Этот пример требует Simulink и Simulink Report Generator™.

Создайте отчет и главу.

rpt = slreportgen.report.Report("MyReport","html-file");
open(rpt);

ch = mlreportgen.report.Chapter("slrgex_sf_car System Diagrams Tabbed Image Gallery");

Загрузите модель и найдите все схемы в модели.

model_name = "slrgex_sf_car";
load_system(model_name);

finder = slreportgen.finder.DiagramFinder(model_name);
results = find(finder);

Создайте mlreportgen.report.HTMLModuleTabs reporter, чтобы содержать вкладки, которые соответствуют схемам. Задайте метки вкладки и содержимое для каждой системной схемы. Метка вкладка является системным именем. Содержимое вкладки является моментальным снимком системной схемы.

moduleTabs = mlreportgen.report.HTMLModuleTabs();
for result = results
    moduleTabs.TabsData(end+1).Label = result.Name;
    
    diag = result.getReporter();
    moduleTabs.TabsData(end).Content = mlreportgen.dom.Image(diag.getSnapshotImage(rpt));
end

Добавьте HTMLModuleTabs репортер в главу и добавить главу в отчет. Закройте и просмотрите отчет.

add(ch,moduleTabs);
add(rpt,ch);

close(rpt);
rptview(rpt);

Откроется отчет, в котором отображается содержимое первой вкладки. Первая вкладка содержит схему верхнего уровня модели. Чтобы увидеть другую схему, щелкните соответствующую вкладку.

The first tab, for the top-level diagram, has a white background. The tab labels for the other diagrams are visible and have a gray background.

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

Создайте отчет и главу.

rpt = mlreportgen.report.Report("MyReport","html");
open(rpt);
ch = mlreportgen.report.Chapter("Tabs with Different Types of Content");

Создайте HTMLModuleTabs reporter и укажите метки и содержимое для каждой панели с вкладками. Для последней панели создайте Group объект, содержащий абзац и таблицу.

% Create group from a paragraph and a table
p = mlreportgen.dom.Paragraph('This is a table:');
t = mlreportgen.dom.Table(magic(2));
grp = mlreportgen.dom.Group;
append(grp,p);
append(grp,t);

% Create cell arrays for the labels and content
labels = {'Text','Paragraph','Link','List','Image','Group'};
content = {"This tab contains text as a string.",...
    mlreportgen.dom.Paragraph('This tab contains content using a DOM Paragraph.'),...
    mlreportgen.dom.ExternalLink("http://www.mathworks.com/","MathWorks"),...
    mlreportgen.dom.UnorderedList(["Coffee", "Tea", "Milk"]),...
    mlreportgen.dom.Image(which("ngc6543a.jpg")),...
    grp};

% Create a structure from the labels and content
tabsdata = struct('Label',labels,'Content',content);

% Create the HTMLModuleTabs reporter
modTabsObj = mlreportgen.report.HTMLModuleTabs('TabsData',tabsdata);

Добавьте HTMLModuleTabs репортер доклада. Закройте и просмотрите отчет.

add(ch,modTabsObj);
add(rpt,ch);
close(rpt);
rptview(rpt);

Откроется отчет, в котором отображается содержимое первой вкладки.

The first tab, for the text content, has a white background to indicate that it is selected. The other tab labels are visible and have a gray background.

Щелкните вкладку Group, чтобы увидеть, что она содержит абзац и таблицу.

The Group tab shows the text "This is a table" and a table with the output of magic(2).

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