mlreportgen.report.ListOfTables class

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

Список таблиц reporter

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

Описание

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

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

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

  • Word - Report API генерирует заполнитель для списка. Чтобы сгенерировать элементы списка, необходимо обновить документ Word в программе генерации отчетов или в Word. См. раздел «Обновление таблицы или сгенерированный список в документе Word».

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

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

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

HandleCompatible
true

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

Создание

Описание

пример

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

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

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. В отчетах о словах всегда есть лидер точек. В отчетах HTML отсутствует лидер.

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть Live Script

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

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

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 Report Generator

Поддержка

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