Exponenta Banner
exponenta event banner

класс mlreportgen.report.ListOfCaptions

Пакет: 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 Report создает местозаполнитель для списка. Для создания элементов списка необходимо обновить документ Word в программе создания отчетов или в Word. См. раздел Обновление оглавления или сгенерированного списка в документе Word.

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

Примечание

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

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-by-N или N-by-1 массив строковых скаляров или встроенных объектов DOM

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

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

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

В этом примере создается раздел для списка заголовков уравнений в отчете. Эту же процедуру можно использовать для создания списка субтитров для других элементов отчета. Пример определяет подписи для включения в список, связывая подписи с потоком автоматической нумерации с именем 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

Поддержка