mlreportgen.report.HTMLModuleTabs class

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

Создайте снабженные вкладками панели

Описание

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

Примечание

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

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

    • Объект генератора отчетов API Отчета

    Примечание

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

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

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

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

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

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

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

Цель гиперссылки для этого генератора отчетов в виде вектора символов или строкового скаляра, который задает ID цели ссылки или 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 генератор отчетов, чтобы содержать вкладки, которые соответствуют схемам. Задайте метки вкладки и содержимое для каждой системной схемы. Метка вкладки является именем системы. Содержимое вкладки является системным снимком состояния схемы.

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 генератор отчетов и задает метку и содержимое для каждой панели с вкладками. Для последней панели создайте 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
Для просмотра документации необходимо авторизоваться на сайте