Exponenta Banner
exponenta event banner

класс mlreportgen.dom.LOC

Пакет: 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 генерирует список во время создания отчета.

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

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

Примечание

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

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

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

ConstructOnLoad
true
HandleCompatible
true

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

Создание

Описание

пример

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

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

Свойства

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

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

В этом примере создается список субтитров, например, код в отчете. Эту же процедуру можно использовать для создания списка субтитров для других элементов отчета. Этот пример определяет подписи для включения в список, связывая подписи с потоком автоматической нумерации с именем 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

Поддержка