mlreportgen.dom.LOT class

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

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

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

Описание

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

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

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

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

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

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

Для включения таблиц в список таблиц:

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

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

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

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

ConstructOnLoad
true
HandleCompatible
true

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

Создание

Описание

пример

LOTObj = mlreportgen.dom.LOT() создает mlreportgen.dom.LOT Объект и устанавливает свойство LeaderPattern на '.'.

LOTObj = mlreportgen.dom.LOT(leaderPattern) создает mlreportgen.dom.LOT Объект и устанавливает свойство LeaderPattern на заданный шаблон выноски.

Свойства

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть Live Script

Составьте список таблиц как 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 Report Generator

Поддержка

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