mlreportgen.report.TableOfContents class

Пакет: mlreportgen.report
Суперклассы: mlreportgen.report.Reporter

Таблица репортера содержимого

Описание

Создайте таблицу содержимого (TOC) репортера, который добавляет таблицы содержимого в отчет. Этот класс наследует от mlreportgen.report.Reporter.

Конструкция

toc = TableOfContents() возвращает репортер, который генерирует раздел таблицы содержимого (TOC) для отчета. Шаблон по умолчанию для раздела оглавления определяет внешний вид и макет страницы оглавления. Раздел TOC содержит заголовок по умолчанию и элемент TOC, который задает местоположение генерируемого TOC в зависимости от типа выхода отчета. Способ создания ТОС отличается для каждого вида отчета.

  • HTML - JavaScript, скопированный из шаблона отчета в отчет, генерирует TOC при открытии отчета в браузере. Скрипт генерирует ТОС как свертываемое дерево. Древовидные записи являются гиперссылочным содержимым элементов заголовка HTML (h1-h6) отчета. Уровень записи в дереве ТОС соответствует уровню элемента заголовка. Редакторы глав и разделов генерируют заголовки глав и разделов в качестве элементов заголовков на соответствующем уровне, поэтому заголовки глав и разделов появляются в оглавлении автоматически. Можно также использовать элементы заголовка DOM в отчете для создания записей TOC.

  • DOCX - Генератор отчетов rptview функция предписывает Word сгенерировать TOC после того, как он откроет отчет в Word. Если вы открываете отчет в Word непосредственно, не используя rptviewнеобходимо обновить отчетный документ самостоятельно, чтобы сгенерировать оглавление. См. раздел «Обновление таблицы или сгенерированный список в документе Word».

    Оглавление представляет собой двухколоночную таблицу. В первом столбце содержится гиперссылочное содержимое пунктов отчета, уровни контуров которых установлены. Уровень контура определяет форматирование записи TOC. Во втором столбце содержится номер страницы, на которой находится соответствующий абзац. Редакторы глав и разделов генерируют заголовки глав и разделов в виде абзацев с соответствующим набором уровней, поэтому заголовки глав и разделов появляются в оглавлении автоматически. Можно также использовать элементы заголовка DOM в отчете для создания записей TOC.

  • PDF - таблица содержимого генерируется во время генерации PDF-документа.

toc = TableOfContents(title) создает ТОС, который использует заданную title.

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

Свойства

расширить все

Таблица заголовка содержимого, заданное в качестве одного из следующих значений:

  • Строка или символьный массив

  • Объект DOM

  • 1-by- N или N -by-1 массив строк или объектов DOM

  • 1-by- N или N-на-1 массив ячеек со строками, символьными массивами и/или объектами DOM

  • TableOfContentsTitle репортер

Пример: 'TableOfContents','Report Contents'

Количество уровней заголовка для использования в таблицу содержимого, заданное в виде положительного целого числа в область значений [1,9].

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

Методы

createTemplate Создайте таблицу шаблона раздела содержимого
customizeReporter Создайте пользовательскую таблицу содержимого класса reporter
getClassFolderТаблица файла определения класса оглавления
getTitleReporterПолучить таблицу оглавления reporter

Унаследованные методы

копия Создайте копию объекта reporter и сделайте глубокие копии определенных значений свойств
getImpl Получите реализацию reporter

Примеры

Таблица содержимого по умолчанию

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

import mlreportgen.report.*
rpt = Report('output','pdf');
toc = TableOfContents();
add(rpt,toc);

Настраиваемая таблица

Создать отчет, содержащий таблицу содержимого с зеленым заголовком. Этот доклад также включает главы, разделы и раздел добавления.

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

rpt = Report('Report with TOC');
add(rpt, TitlePage('Title','Report','Subtitle','with TOC'));
toc = TableOfContents;
toc.Title = Text('Table of Contents');
toc.Title.Color = 'green';
toc.NumberOfLevels = 2; 
add(rpt,toc);

ch = Chapter('First Chapter');
add(ch,Section('First Subsection'));
add(ch,Section('Second Subsection'));

add(rpt,ch);
add(rpt,Chapter('Second Chapter'));

add(rpt,PDFPageLayout);
p = Paragraph('Appendix'); 
p.Style = {OutlineLevel(1), Bold, FontSize('18pt')};
add(rpt,p);

close(rpt);
rptview(rpt);

Вопросы совместимости

расширить все

Поведение изменено в R2021a

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