Exponenta Banner
exponenta event banner

класс mlreportgen.report.ListOfTables

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

Список таблиц-репортеров

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

Описание

Использование объекта mlreportgen.report.ListOfTables для создания репортера, который добавляет в отчет раздел со списком таблиц. Созданный список таблиц содержит названия таблиц, которые представлены как mlreportgen.report.BaseTable объекты в программе создания отчетов. Элементы списка связаны с заголовками в отчете. В отчетах PDF и Word список также включает номера страниц заголовков в отчете. Выноска заполняет пространство между заголовком и номером страницы.

Способ создания списка таблиц зависит от типа отчета:

  • PDF - API отчетов генерирует список во время создания отчета.

  • Word - API Report создает местозаполнитель для списка. Для создания элементов списка необходимо обновить документ Word в программе создания отчетов или в Word. См. раздел Обновление оглавления или сгенерированного списка в документе Word.

  • HTML - API Report создает местозаполнитель для списка. Когда отчет открывается в HTML-браузере, браузер создает список на боковой панели.

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

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

HandleCompatible
true

Сведения об атрибутах класса см. в разделе Атрибуты класса.

Создание

Описание

пример

lot = mlreportgen.report.ListOfTables() создает ListOfTables репортер со значениями свойств по умолчанию.

lot = mlreportgen.report.ListOfTables(title) создает ListOfTables репортер со свойством Title, равным указанному заголовку.

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

Свойства

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

Список названий разделов таблиц, указанных как одно из следующих значений:

  • Строковый скалярный или символьный вектор

  • Встроенный объект DOM, например, mlreportgen.dom.Text объект

  • 1-by-N или N-by-1 массив строковых скаляров или встроенных объектов DOM

  • 1-by-N или N-by-1 массив ячеек, содержащий любую комбинацию строк, векторов символов или встроенных объектов DOM

  • mlreportgen.report.Title объект, возвращенный getTitleReporter метод

Если не указать Title свойство, заголовок List of Tables в созданном списке таблиц.

Тип выноски для использования между заголовком и номером страницы, указанный как один из следующих векторов символов или строковых скаляров:

  • '.' или 'dots'

  • ' ' или 'space'

Это свойство применяется только к отчетам PDF. В отчетах Word всегда есть лидер точек. HTML-отчеты не имеют выноски.

Макет страницы для раздела списка таблиц, указанный как mlreportgen.report.ReporterLayout объект. Использовать свойства ReporterLayout для переопределения некоторых свойств макета страницы по умолчанию, таких как ориентация страницы.

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

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

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

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

Указанный шаблон должен быть того же типа, что и отчет, к которому добавлен этот репортер. Например, для отчета Microsoft ® Word :TemplateSrc должен быть шаблоном репортера Word. Если TemplateSrc пустое свойство, этот репортер использует шаблон репортера по умолчанию для типа вывода отчета.

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

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

Методы

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

Примеры

свернуть все

Открыть сценарий в реальном времени

В этом примере используется mlreportgen.report.TableOfContents для добавления оглавления к отчету и mlreportgen.report.ListOfTables reporter, чтобы добавить раздел для списка таблиц. Таблицы в отчете представлены как mlreportgen.report.BaseTable объекты так, что ListOfTables репортер включает их в список таблиц.

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

import mlreportgen.report.*

Создание отчета.

rpt = Report("myTableReport","pdf");
open(rpt);

Создайте оглавление и добавьте его в отчет.

toc = TableOfContents();
append(rpt,toc);

Создайте раздел списка таблиц и добавьте его в отчет.

lot = ListOfTables();
lot.Title = "My List of Tables";
append(rpt,lot);

Создайте главу и добавьте к ней таблицы с заголовками.

ch = Chapter("Magic Squares");
t1 = BaseTable(magic(2));
t1.Title = "Order Two Magic Square";
append(ch,t1);
t2 = BaseTable(magic(3));
t2.Title = "Order Three Magic Square";
append(ch,t2);

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

append(rpt,ch);
close(rpt);
rptview(rpt);

Вот список таблиц в отчете:

См. также

| | | |

Темы

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

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

Поддержка