Exponenta Banner
exponenta event banner

mlreportgen.report.ListOfFigures класс

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

Список репортёров-деятелей

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

Описание

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

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

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

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

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

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

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

Abstract
true

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

Создание

Описание

пример

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

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

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. В отчетах Word всегда есть лидер точек. HTML-отчеты не имеют выноски.

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

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

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

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

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

Поддержка