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

В отчете Report API можно создать список заголовков или заголовков связанных элементов отчета, таких как уравнения, чтобы можно было просматривать список и легко переходить к определенному элементу отчета. Для создания списка элементов отчета используйте mlreportgen.report.ListOfCaptions репортер.

Примечание

Для получения списка рисунков используйте mlreportgen.report.ListOfFigures репортер. Для получения списка таблиц используйте mlreportgen.report.ListOfTables репортер. Посмотрите Create a List of Figures or Tables.

Использование ListOfCaptions reporter, необходимо создать абзац для подписи или заголовка элемента отчета. Затем свяжите абзац с именем потока автоматической нумерации, которое имеет имя, соответствующее имени потока автоматической нумерации ListOfCaptions объект.

A ListOfCaptions reporter создает местозаполнитель для списка в новом разделе отчета. Как правило, список заголовков добавляется после оглавления и перед разделами, содержащими содержимое отчета. В отчетах в формате PDF или Microsoft ^® Word список подписей находится там, где он помещен в отчет. В HTML-отчетах раздел располагается на боковой панели.

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

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

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

Чтобы создать список субтитров:

Создание отчета API отчетов.
Создание mlreportgen.report.ListOfCaptions объект.
Укажите заголовок раздела списка заголовков, установив Title имущества ListofCaptions объект.
Выберите имя потока нумерации, например: equation. Установите AutoNumberStreamName имущества ListOfCaptions объект к имени потока нумерации.
Добавить ListofCaptions объект для отчета.
Создание глав или разделов для содержимого отчета.
Добавление содержимого к главам или разделам. Создать mlreportgen.dom.Paragraph объекты для субтитров или заголовков элементов отчета, которые требуется включить в список субтитров. Использовать mlreportgen.dom.AutoNumber объекты для связывания абзацев с тем же именем потока автоматической нумерации, которое назначено AutoNumberStreamName имущества ListofCaptions объект.
Закройте отчет.

Создание отчета со списком разделов заголовков

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

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

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

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

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

rpt = Report("physics","docx");

Добавьте в отчет титульную страницу и оглавление.

tp = TitlePage();
tp.Title = "Physics Principles";
tp.Author = "John Doe";
append(rpt,TableOfContents);

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

loc = ListOfCaptions();
loc.Title = "List of Equations";

Определение имени потока автоматической нумерации для использования с ListOFCaptions объект.

equationStreamName = "equation";
loc.AutoNumberStreamName = equationStreamName;

Добавьте в отчет раздел списка подписей.

append(rpt,loc);

Создание глав для содержимого отчета. Для этого примера создайте две главы. Каждая глава имеет одно уравнение.

Создайте первую главу. Добавьте абзац и уравнение.

ch1 = Chapter("Force");
append(ch1,Paragraph("Calculate force by multiplying mass and acceleration."));
eq1 = Equation("F = ma");
append(ch1,eq1);

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

caption1 = Paragraph("Equation ");
append(caption1,AutoNumber(equationStreamName));

Определите стиль для заголовков. Включить mlreportgen.report.CounterInc объект для приращения счетчика для потока нумерации.

equationCaptionsStyle = {HAlign("center"),CounterInc(equationStreamName),WhiteSpace("preserve")};
caption1.Style = equationCaptionsStyle;

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

append(caption1,".");
append(caption1," Force");
append(ch1,caption1);

Добавьте главу в отчет.

append(rpt,ch1);

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

ch2 = Chapter("Momentum");
append(ch2,Paragraph("Calculate momentum by multiplying mass and velocity."));
eq2 = Equation("p = mv");
append(ch2,eq2);

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

caption2 = Paragraph("Equation ");
append(caption2,AutoNumber(equationStreamName));

Укажите стиль подписи.

caption2.Style = equationCaptionsStyle;

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

append(caption2,".");
append(caption2," Momentum");
append(ch2,caption2);

Добавьте главу в отчет.

append(rpt,ch2);

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

close(rpt);
rptview(rpt);

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

Настройка заголовка раздела списка подписей

Можно указать заголовок раздела списка заголовков, установив Title имущества ListOfCaptions репортер. Чтобы настроить стиль заголовка, например семейство шрифтов, цвет или размер, используйте один из следующих подходов.

Укажите заголовок как mlreportgen.dom.Text и задайте стиль с помощью свойств объекта.
Укажите стиль заголовка в шаблоне, используемом ListOfCaptions репортер.
Укажите стиль заголовка в шаблоне, используемом репортером заголовка для списка заголовков разделов. См. раздел Использование пользовательского шаблона для списка заголовков подписей.

См. также

mlreportgen.report.ListOfCaptions | mlreportgen.report.ListOfFigures | mlreportgen.report.ListOfTables

Документация