Exponenta Banner

mlreportgen.report.ListOfCaptions class

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

Список подписей репортера

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

Описание

Используйте объект mlreportgen.report.ListOfCaptions Класс создать репортер, который добавляет раздел для списка подписанных элементов отчета в отчет. Чтобы создать репортер для списка рисунков с подписями или таблицами с заголовками, используйте объекты mlreportgen.report.ListOfFigure и mlreportgen.report.ListOfTables классы, соответственно. Чтобы создать репортер для списка для других типов элементов отчета, таких как уравнения, используйте ListOfCaptions объект.

Чтобы идентифицировать элементы отчета, которые будут включены в список подписей:

  1. Выберите имя нумерационного потока, например equation. Установите AutoNumberStreamName свойство ListOfCaptions объект - имя нумерационного потока.

  2. Создайте подписи для объектов отчета следующим mlreportgen.dom.Paragraph объекты.

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

Сгенерированный список подписей содержит подписи, связанные с заданным именем нумерационного потока. Записи списка ссылаются на подписи в отчете. В отчетах PDF и Word в список также включены номера страниц подписей в отчете. Выноска заполняет пространство между подписью и ее номером страницы.

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

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

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

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

Примечание

Можно использовать ListOfCaptions reporter для подписей, которые следуют за элементом отчета или заголовками, которые предшествуют элементу отчета.

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

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

HandleCompatible
true

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

Создание

Описание

пример

loc = mlreportgen.report.ListOfCaptions() создает ListOfCaptions reporter со значениями свойств по умолчанию. Укажите список заголовков разделов подписей путем установки Title свойство.

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

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

Свойства

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

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

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

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

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

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

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть Live Script

Этот пример генерирует раздел для списка подписей уравнений в отчете. Эту же процедуру можно использовать для создания списка подписей для других элементов отчета. Пример определяет подписи, которые будут включены в список путем связи подписей с потоком автоматической нумерации, который имеет имя equation. Вы можете использовать любое имя для нумерации потока, пока имя совпадает со значением AutoNumberStream свойство ListOfCaptions объект, который представляет список подписей.

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

import mlreportgen.dom.*
import mlreportgen.report.*

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

rpt = Report("My Report","pdf");

Добавьте таблицы содержимого к отчету.

toc = TableOfContents;
append(rpt,toc);

Создайте список подписей и добавьте его в отчет. Укажите, что элементы, включаемые в список, связаны с именем потока номеров equation.

loc = ListOfCaptions();
loc.Title = "List of Equations";
loc.AutoNumberStreamName = "equation";
append(rpt,loc);

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

ch = Chapter("Physics Principles");
eq = Equation("e = m * c^2");
append(ch,eq);

Создайте абзац для заголовка уравнения. 

p = Paragraph("Equation ");

Создайте поток автоматической нумерации с именем equation и связать его с этим пунктом.

append(p,AutoNumber("equation"));

Увеличьте счетчик для нумерации потока.

p.Style = {HAlign("center"),CounterInc("equation"),WhiteSpace("preserve")};

Добавить остальную часть подписи к абзацу и добавить абзац к главе. Добавьте главу к отчету.

append(p,' Mass–energy equivalence');
append(ch,p);
append(rpt,ch);

Закройте и просмотрите отчет.

close(rpt);
rptview(rpt);

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

См. также

| | | | |

Темы

Введенный в R2020b

MATLAB Report Generator

Поддержка