mlreportgen.dom.LOF class

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

Список рисунков

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

Описание

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

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

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

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

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

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

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

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

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

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

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

ConstructOnLoad
true
HandleCompatible
true

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

Создание

Описание

пример

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

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

Свойства

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть Live Script

Создайте список рисунков как 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 Report Generator

Поддержка

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