mlreportgen.report.Chapter class

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

Генератор отчетов главы

Описание

Создайте генератор отчетов главы, который добавляет главу в отчет. Этот класс наследовался mlreportgen.report.Section.

Конструкция

ch = Chapter() создает генератор отчетов, который генерирует главу. Главе задал новый макет страницы шаблон по умолчанию генератора отчетов.

Шаблон по умолчанию является страницей портрета с заголовком и нижним колонтитулом. Заголовок пуст. Если глава является первой главой отчета, нижний колонтитул содержит автоматически сгенерированный номер страницы, который запускается с 1. Если это не первая глава, нумерация страницы продолжается от последней страницы предыдущей главы. Используйте Layout свойство заменить некоторые функции макета страницы главы, такие как ее ориентация.

Чтобы добавить содержимое в главу, используйте mlreportgen.report.Chapter.add метод.

Примечание

Прежде чем вы добавите главу в отчет, добавьте все содержимое, которое вы хотите в ту главу. Если вы добавляете что глава в отчет (add(report,chapter)), вы не можете добавить больше содержимого в ту главу.

ch = Chapter(title) создает главу отчета, содержащую заголовок главы с заданным текстом заголовка.

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

Входные параметры

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

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

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

Если пронумеровано, заголовок снабжается префиксом в английских отчетах строкой в Главе N формы., где N автоматически сгенерированный номер главы. В некоторых других локалях английский префикс переводится в язык локали. Смотрите Locale свойство mlreportgen.report.Report для списка переведенных локалей.

Свойства

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

Генератор отчетов главы является типом генератора отчетов раздела и наследовал его свойства. Layout свойство является единственным свойством, которое не наследовано от mlreportgen.report.Section.

Размещение этой главы, заданной как mlreportgen.report.ReporterLayout объект. Используйте Layout заменять некоторые свойства макета главы, которые заданы в шаблоне для главы. Первый номер страницы и ориентация страницы являются примерами свойств макета главы. Смотрите mlreportgen.report.ReporterLayout.

Пример: chapter.Layout.Landscape = true

Методы

Генератор отчетов главы является типом генератора отчетов раздела и наследовал его методы. Смотрите mlreportgen.report.Section для описаний методов.

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

добавление Добавьте содержимое раздела
createTemplateСоздайте шаблон раздела
customizeReporter Создайте пользовательский класс генератора отчетов раздела
getClassFolderРазделите расположение файла определения класса
getTitleReporter Получите генератор отчетов заголовка раздела
номерУстановите нумерацию раздела
customizeReporterСоздайте класс, выведенный из класса Генератора отчетов
getImpl Получите реализацию генератора отчетов

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

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

Примеры

Добавьте главу и набор ее ориентация страницы

Добавьте главу в отчет. Установите его ориентацию макета заниматься ландшафтным дизайном. Добавьте раздел в ту главу.

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

rpt = Report('My Report','pdf');

add(rpt,TitlePage('Title','My Report'));

chapter = Chapter('Images');
chapter.Layout.Landscape = true;
add(chapter,Section('Title','Boeing 747', ...
     'Content',Image(which('b747.jpg'))));

add(rpt,chapter);
close(rpt);
rptview(rpt);

Введенный в R2017b

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