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

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

Примечание

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

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

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

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

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

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

Скрипт Open Live Script

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

Импортируйте DOM и пакеты 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 генератор отчетов.
Укажите, что стиль заголовка в шаблоне, используемом генератором отчетов заголовка для списка заголовков, разделяет заголовок. Смотрите Использование Пользовательский Шаблон для Списка Заголовка Заголовков.

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