mlreportgen.dom.LOF class

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

Список фигур

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

Описание

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

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

Путем список сгенерирован, зависит от типа отчета.

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

  • Word API DOM генерирует заполнителя для списка. Чтобы сгенерировать элементы списка, необходимо обновить документ 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 объект и наборы свойство LeaderPattern к '.'.

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

Свойства

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

Пометьте для этого элемента документа в виде вектора символов или строкового скаляра.

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

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

Методы

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

Примеры

свернуть все

Скрипт Open 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

Поддержка

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