Exponenta Banner
exponenta event banner

mlreportgen.dom.LOT класс

Пакет: mlreportgen.dom
Суперклассы: mlreportgen.dom.LOC

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

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

Описание

Использование объекта mlreportgen.dom.LOT для создания списка таблиц в отчете.

Каждый элемент списка содержит заголовок таблицы и ссылки на заголовок в отчете. В отчете PDF или Microsoft ® Word элемент списка также включает номер страницы и выноску, заполняющую пространство между заголовком и номером страницы. В отчете PDF или Word список находится в точке отчета, к которой добавляется LOT объект. В HTML-отчете список находится на боковой панели с заголовком List of Tables.

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

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

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

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

Чтобы включить таблицы в список таблиц, выполните следующие действия.

  1. Создание заголовков для таблиц с помощью mlreportgen.dom.Paragraph объекты.

  2. Связать Paragraph объекты с потоком нумерации, имеющим имя table с помощью mlreportgen.dom.AutoNumber объект.

mlreportgen.dom.LOT класс является handle класс.

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

ConstructOnLoad
true
HandleCompatible
true

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

Создание

Описание

пример

LOTObj = mlreportgen.dom.LOT() создает mlreportgen.dom.LOT и задает свойству LeeyPattern значение '.'.

LOTObj = mlreportgen.dom.LOT(leaderPattern) создает mlreportgen.dom.LOT и задает свойству LeeyPattern указанный образец выноски.

Свойства

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

Имя потока нумерации, указанное как 'table'. Не изменяйте значение этого свойства. Чтобы создать список заголовков или заголовков с использованием пользовательского имени потока нумерации, используйте mlreportgen.dom.LOC объект.

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

  • '.' или 'dots'

  • ' ' или 'space'

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

Имя стиля таблицы стилей для форматирования списка таблиц, заданного как вектор символов или скаляр строки.

Стиль, заданный StyleName свойство должно быть определено в таблице стилей документа или части документа, к которой добавляется этот список заголовков таблиц. Указанный стиль определяет внешний вид списка таблиц в выходном документе, за исключением форматов, заданных параметром Style свойство этого LOT объект. Объекты формата, указанные Style форматы переопределения свойств, определенные в таблице стилей.

Форматы, определяющие стиль списка таблиц, заданного как массив ячеек объектов формата DOM. Форматы переопределяют соответствующие форматы, определенные стилем таблицы стилей, указанным в StyleName собственность. Форматы, которые не применяются к списку таблиц, игнорируются.

Пользовательские атрибуты этого элемента документа, указанные как массив mlreportgen.dom.CustomAttribute объекты. Пользовательские атрибуты должны поддерживаться форматом вывода.

Родительский элемент этого документа, указанный как объект DOM. Это свойство доступно только для чтения.

Дочерние элементы этого элемента документа, указанные как массив объектов DOM. Это свойство доступно только для чтения.

Тег для этого элемента документа, заданный как вектор символов или скаляр строки.

DOM создает уникальный для сеанса тег как часть создания этого объекта. Созданный тег имеет вид CLASS: ID, где CLASS - класс объекта, а ID - значение Id свойства объекта. Указание собственного значения тега может помочь определить, где возникла проблема во время создания документа.

Идентификатор для этого элемента документа, указанный как вектор символов или скаляр строки. При создании элемента документа DOM создает уникальный идентификатор сеанса. Можно указать собственный идентификатор.

Методы

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

Примеры

свернуть все

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

Создание списка таблиц в виде mlreportgen.dom.LOT объект. Чтобы включить таблицы в список, выполните следующие действия.

  • Создание заголовков для таблиц как mlreportgen.dom.Paragraph объекты.

  • Связать Paragraph объекты с потоком нумерации, имеющим имя table.

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

import mlreportgen.dom.*

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

d = Document("DOM Report with List of Tables","docx");

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

lotObj = LOT();
append(d,lotObj);
append(d,PageBreak);

Создайте таблицу.

t1 = Table(magic(2));

Создайте абзац для заголовка таблицы. 

p1 = Paragraph("Table ");

Создание потока автоматической нумерации с именем table и связать его с абзацем. 

append(p1,AutoNumber("table"));

Увеличьте значение счетчика для потока нумерации.

p1.Style = {CounterInc("table"),WhiteSpace("preserve")};

Добавьте остальную часть текста заголовка к абзацу и добавьте его к отчету.

append(p1,".");
append(p1," Order 2 Magic Square");
append(d,p1);

Добавьте таблицу к отчету после заголовка таблицы.

append(d,t1);

Создайте другую таблицу и заголовок для таблицы. Связать table нумерующий поток с заголовком таблицы и приращение счетчика нумерации. 

t2 = Table(magic(3));
p2 = Paragraph("Table ");
append(p2,AutoNumber("table"));
p2.Style = {CounterInc("table"),WhiteSpace("preserve")};

Добавьте остальную часть текста заголовка к абзацу и добавьте его к отчету.

append(p2,".");
append(p2, " Order 3 Magic Square");
append(d,p2);

Добавьте таблицу к отчету после заголовка таблицы.

append(d,t2);

Закройте и просмотрите отчет.

close(d);
rptview(d);

Ниже приведен список таблиц в созданном отчете:

См. также

| | | |

Темы

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

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

Поддержка