Exponenta Banner
exponenta event banner

mlreportgen.dom.LOF класс

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

Список фигур

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

Описание

Использование объекта mlreportgen.dom.LOF для создания списка фигур в отчете.

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

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

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

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

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

Для включения фигур (изображений) в список фигур:

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

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

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

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

ConstructOnLoad
true
HandleCompatible
true

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

Создание

Описание

пример

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

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

Свойства

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

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

Создание списка фигур в виде mlreportgen.dom.LOF объект. Для включения фигур в список:

  • Создать подписи для рисунков как mlreportgen.dom.Paragraph объекты.

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

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

import mlreportgen.dom.*

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

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

Создание LOF и добавьте его в отчет.

LOFObj = LOF();
append(d,LOFObj);
append(d,PageBreak);

Включить изображение (рисунок) в отчет.

append(d,Image('peppers.png'));

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

p1 = Paragraph("Figure ");

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

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

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

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

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

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

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

append(d,Image("b747.jpg"));
p2 = Paragraph("Figure ");
append(p2,AutoNumber("figure"));
p2.Style = {CounterInc("figure"),WhiteSpace("preserve")};

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

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

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

close(d);
rptview(d);

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

См. также

| | | |

Темы

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

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

Поддержка