mlreportgen.report.TableOfContents class

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

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

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

Описание

Создайте генератор отчетов оглавления (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 — Генератор отчетов использует Форматирование процессора объектов (FOP) Apache™, чтобы сгенерировать TOC как часть генерации документа в формате PDF, FOP генерирует TOC способом, похожим на способ, которым Word генерирует TOC для документа Word.

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'

mlreportgen.dom.TOC объект. Используйте этот объект в качестве свойства TableofContents генератор отчетов, чтобы настроить оглавление в вашем отчете. По умолчанию объект DOM TOC создает оглавление максимум с 3 уровнями и с точками как шаблон лидера, который задает символы между главой и именами раздела и их номерами страниц. Настройте TOCObj получить, например, различное количество уровней или пробелов как шаблон лидера.

Пример: toc = mlreportgen.report.TableOfContents; toc.TOCObj.NumberOfLevels = 2;

Параметры макета для этого генератора отчетов, заданного, в зависимости от которого свойства макета вы устанавливаете. Свойствами макета является Watermark, FirstPageNumber, PageNumberFormat, и Landscape. Смотрите mlreportgen.report.ReporterLayout для описаний этих свойств

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

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

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

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

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

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

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

Методы

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

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

customizeReporterСоздайте класс, выведенный из класса Генератора отчетов
getImpl Получите реализацию генератора отчетов

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

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

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

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.TOCObj.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);

Смотрите также

|

Темы

Введенный в R2017b

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