Создайте список фигур или таблиц в отчете API отчета

В отчете Report API можно создать список рисунков или таблиц в отчете, чтобы можно было просматривать список и легко переходить к определенному рисунку или таблице. Чтобы создать список рисунков, добавьте mlreportgen.report.ListOfFigures репортер доклада. Чтобы создать список таблиц, добавьте mlreportgen.report.ListOfTables репортер доклада.

Примечание

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

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

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

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

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

Составьте список разделов фигур

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

Создайте отчет Report API.
Создайте ListofFigures объект. Заголовок по умолчанию для списка разделов рисунка List of Figures. Чтобы задать другой заголовок, установите Title свойство ListofFigures объект. Добавьте ListofFigures объект отчета.
Создание глав или разделов для содержимого отчета.
Добавить содержимое отчета в главы или разделы. Создавайте изображения как FormalImage или Figure объекты. Задайте подписи для изображений или рисунков. Для FormalImage объект, установите Caption свойство. Для Figure объект, установите Caption свойство FormalImage объект, заданный как SnapShot свойство Figure объект.
Закройте отчет.

Составьте список разделов таблиц

Чтобы создать список таблиц в отчете, выполните следующие действия.

Создайте отчет Report API.
Создайте ListofTables объект. Заголовок по умолчанию для раздела списка таблиц List of Tables. Чтобы задать другой заголовок, установите Title свойство ListofTables объект. Добавьте ListofTables объект отчета.
Создание глав или разделов для содержимого отчета.
Добавить содержимое отчета в главы или разделы. Создайте таблицы следующим BaseTable объекты и указание заголовков с помощью Title свойство объектов.
Закройте отчет.

Создайте отчет, который имеет список фигур и список таблиц

Открыть Live Script

В этом примере показано, как добавить список рисунков и раздел таблиц в отчет Report API. Пример генерирует отчет о магических квадратах, который включает два рисунков и таблицу.

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

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

Создайте отчет Report API. Добавьте к отчету заголовка страницу и таблицу содержимого.

rpt = Report('magic','docx'); 
tp = TitlePage; 
tp.Title = 'Magic Squares'; 
tp.Author = 'John Doe'; 
append(rpt,tp); 
append(rpt,TableOfContents);

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

lof = ListOfFigures();
append(rpt,lof);
lot = ListOfTables();
append(rpt,lot);

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

ch1 = Chapter('Introduction'); 
sec1 = Section('What is a Magic Square?'); 
para = Paragraph(['A magic square is an N-by-N matrix '... 
'constructed from the integers 1 through N^2 '... 
'with equal row, column, and diagonal sums.']); 
append(sec1,para); 
append(ch1,sec1); 

sec2 = Section('Albrecht Durer and the Magic Square'); 
para = Paragraph(['A 4-by-4 magic square appears in the upper right corner ' ... 
    'of the engraving, Melancholia I, by German artist Albrecht Durer (1471-1528).']);
append(sec2,para); 
append(ch1,sec2) ;

Добавьте изображение durer.png в главу как mlreportgen.report.FormalImage объект так, чтобы изображение было включено в список рисунков.

im = FormalImage('durer.png');
im.Caption = 'Melancholia I by Albrecht Durer';
append(sec2,im);
append(rpt,ch1);

Создайте вторую главу.

ch2 = Chapter('Magic Square Example'); 
square = magic(10);

Составьте таблицу из выхода magic(10) и добавить его в главу. Представьте таблицу как mlreportgen.report.BaseTable так, чтобы таблица была включена в список таблиц.

tbl = BaseTable(square); 
tbl.Title = 'Order Ten Magic Square';
append(ch2,tbl);

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

clf; 
imagesc(square) 
axis equal 
axis off
fig = Figure(gcf); 
fig.Snapshot.Caption = 'Color-coded image of 10-by-10 magic square'; 
append(ch2,fig); 
append(rpt,ch2);

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

close(rpt);
rptview(rpt);

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

Вот список таблиц в отчете:

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

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

Задайте заголовок как mlreportgen.dom.Text и задайте стиль, используя свойства объекта.
Задайте стиль заголовка в шаблоне, используемом ListOfFigures или ListOfTables репортер.
Укажите стиль заголовка в шаблоне, используемом репортером заголовка для списка рисунков или заголовка раздела таблиц. Смотрите раздел «Использование пользовательского Шаблона для списка Фигур заголовка» и «Использование пользовательского Шаблона для списка Таблиц заголовка».

См. также

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