mlreportgen.dom.LOC class

Пакет: mlreportgen.dom

Список подписей

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

Описание

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

Каждый элемент списка содержит заголовок элемента отчета и ссылки на заголовок в отчете. В формате PDF или Microsoft® Отчет Word, элемент списка также включает номер страницы и выноску, которая заполняет пространство между подписью и номером страницы.

В отчетах PDF и Word список подписей помещается в место, заданное в программе генерации отчетов. В отчетах HTML список подписей помещается на боковую панель и имеет заголовок, который состоит из List of далее указывается значение AutoNumberStreamName свойство с заглавной буквой.

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

  1. Выберите имя нумерационного потока, например equation. Установите AutoNumberStreamName свойство LOC объект - имя нумерационного потока.

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

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

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

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

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

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

Примечание

Можно использовать LOC объект для подписей, которые следуют за элементом отчета или заголовками, предшествующими элементу отчета.

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

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

ConstructOnLoad
true
HandleCompatible
true

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

Создание

Описание

пример

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

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

Свойства

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть Live Script

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

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

import mlreportgen.dom.*

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

d = Document("DOM Report with List of Captions","pdf");

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

locObj = LOC();
locObj.AutoNumberStreamName = "example";
append(d,locObj);
append(d,PageBreak);

Создайте абзац, который включает код примера.

pr1 = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a + b;");
append(d,pr1);

Создайте абзац для подписи кода примера.

p1 = Paragraph("Example ");

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

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

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

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

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

append(p1,".");
append(p1," Addition");
append(d,p1);

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

pr2 = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a * b;");
append(d,pr2);
p2 = Paragraph("Example ");
append(p2,AutoNumber("example"));
p2.Style = {CounterInc("example"),WhiteSpace("preserve")};

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

append(p2,".");
append(p2," Multiplication");
append(d,p2);

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

close(d);
rptview(d);

Вот список подписей в сгенерированном отчете:

См. также

| | | | | |

Темы

Введенный в R2020b

MATLAB Report Generator

Поддержка

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