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 — API Отчета генерирует список во время генерации отчета.

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

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

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

пример

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

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

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

Свойства

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

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

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

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

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

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

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

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

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

Поддержка

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