Exponenta Banner

mlreportgen.report.ListOfFigures class

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

Список генератора отчетов фигуры

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

Описание

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

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

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

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

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

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

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

Abstract
true

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

Создание

Описание

пример

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

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

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

Свойства

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

Список фигур разделяет заголовок в виде одного из этих значений:

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

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

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

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

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

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

Импортируйте пакет 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

Поддержка