mlreportgen.report.TableOfContents class

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

Генератор отчетов оглавления

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

Описание

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

Конструкция

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

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

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

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

  • PDF — Оглавление сгенерировано во время генерации документа в формате PDF.

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

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

Свойства

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

Заголовок оглавления в виде одного из этих значений:

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

  • Объект DOM

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

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

  • TableOfContentsTitle генератор отчетов

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

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

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

  • '.' или 'dots'

  • ' ' или 'space'

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

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

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

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

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

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

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

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

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

Методы

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

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

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

Примеры

Оглавление по умолчанию

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

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

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

Поддержка

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