mlreportgen.report.ListOfFigures class

Пакет: mlreportgen.report
Суперклассы: mlreportgen.report.Reporter

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

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

Описание

Используйте объект mlreportgen.report.ListOfFigures Класс создать репортер, который добавляет список рисунков разделов в отчет. Сгенерированный список рисунков содержит подписи к фигурам (изображениям), которые представлены как mlreportgen.report.FormalImage или mlreportgen.report.Figure объекты в программе генерации отчетов. Записи списка ссылаются на подписи в отчете. В отчетах PDF и Word в список также включены номера страниц подписей в отчете. Выноска заполняет пространство между подписью и ее номером страницы.

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

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

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

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

The mlreportgen.report.ListOfFigures класс является handle класс.

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

Abstract
true

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

Создание

Описание

пример

lof = mlreportgen.report.ListOfFigures() создает ListOfFigures reporter со значениями свойств по умолчанию.

lof = mlreportgen.report.ListOfFigures(title) создает ListOfFigures репортер с Заголовком набора свойств к указанному заголовку.

lof = mlreportgen.report.ListOfFigures(Name,Value) устанавливает свойства с помощью пар "имя-значение". Можно задать несколько аргументы пары "имя-значение" в любом порядке. Заключайте каждое имя свойства в одинарные или двойные кавычки.

Свойства

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

Список заголовков разделов рисунков, заданных в качестве одного из следующих значений:

  • Строковый скаляр или вектор символов

  • Встроенный объект DOM, такой как mlreportgen.dom.Text объект

  • 1-by- N или N-by-1 массив строковых скаляров или встроенных объектов DOM

  • 1-by- N или N-by-1 массив ячеек, который содержит любую комбинацию строк, векторов символов или встроенных объектов DOM

  • mlreportgen.report.Title объект, возвращенный getTitleReporter метод

Если вы не задаете Title свойство, заголовок List of Figures.

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

  • '.' или 'dots'

  • ' ' или 'space'

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

Макет страницы для списка рисунков, заданный как mlreportgen.report.ReporterLayout объект. Используйте свойства ReporterLayout объект, чтобы переопределить некоторые свойства макета страницы по умолчанию, такие как ориентация страницы.

Источник шаблона для этого репортера, заданный одним из следующих способов:

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

  • Репортер или отчет, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

  • DOM-документ или деталь документа, шаблон которой используется для этого репортера или библиотека шаблонов которой содержит шаблон для этого репортера

Указанный шаблон должен совпадать с типом отчета, к которому добавлен этот репортер. Для примера, для Microsoft® Отчет о словах, TemplateSrc должен быть шаблоном репортера Word. Если на TemplateSrc свойство пусто, этот репортер использует шаблон репортера по умолчанию для типа выхода отчета.

Имя шаблона для этого репортера, заданное как вектор символов или строковый скаляр. Шаблон для этого репортера должен быть в библиотеке шаблонов источника шаблона (TemplateSrc) для этого репортера.

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

Методы

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

Примеры

свернуть все

Открыть Live Script

Этот пример использует mlreportgen.report.TableOfContents reporter, чтобы добавить таблицы содержимого в отчет и mlreportgen.report.ListOfFigures reporter, чтобы добавить раздел для списка рисунков. Рисунки (изображения) в отчете представлены как mlreportgen.report.Figure или mlreportgen.report.FormalImage объекты так, чтобы ListOfFigures репортер включает их в список рисунков.

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

import mlreportgen.report.*

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

rpt = Report("myFigureReport","pdf");
open(rpt);

Создайте таблицу содержимого и добавьте его в отчет.

toc = TableOfContents();
append(rpt,toc);

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

lof = ListOfFigures();
lof.Title = "My List of Figures";
append(rpt,lof);

Создайте главу и добавьте подписанное изображение и рисунок в главу.

ch = Chapter("Images");
image1 = FormalImage(which("peppers.png"));
image1.Caption = "Peppers";
image1.Height = "5in";
append(ch,image1);
surf(peaks);
fig = Figure();
fig.Snapshot.Caption = '3-D shaded surface plot';
fig.Snapshot.Height = '5in';
append(ch,fig);

Добавить главу в отчет. Закройте и просмотрите отчет.

append(rpt,ch);

delete(gcf);
close(rpt);
rptview(rpt);

Вот список рисунков в отчете:

См. также

| | | | |

Темы

Введенный в R2020b

MATLAB Report Generator

Поддержка

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