mlreportgen.report.Chapter class

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

Репортер главы

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

Описание

Используйте объект mlreportgen.report.Chapter Класс для добавления главы к отчету.

The mlreportgen.report.Chapter класс является handle класс.

Атрибуты класса

HandleCompatible true

Для получения информации об атрибутах класса см. раздел «Атрибуты класса».

Создание

Описание

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

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

Используйте свойство Title, чтобы задать заголовок.

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

Примечание

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

пример

ch = mlreportgen.report.Chapter(title) создает главу с заданным заголовком. См. свойство Title.

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

Свойства

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

`Title` - Заголовок главы
строковый скаляр | символьный вектор | объект DOM |...

Заголовок главы, заданный в качестве одного из следующих значений:

Строковый скаляр или вектор символов
Объект DOM
1-by- N или N-by-1 массив строковых скаляров или объектов DOM
1-by- N или N-на-1 массив ячеек строковых скаляров, векторов символов и/или объектов DOM
SectionTitle репортер, возвращенный getTitleReporter метод

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

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

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

Можно использовать встроенные объекты DOM для переопределения форматирования символов, заданного шаблонами заголовков по умолчанию.

Если значение title является абзацем DOM или другим объектом блока DOM, то в начале главы объект вставляется. Если вы используете объект блока DOM, можно использовать элементы блока для настройки интервалов, выравнивания и других свойств заголовка главы. В этом случае необходимо полностью указать формат title и предоставить нумерацию заголовок самостоятельно.

Примечание

Чтобы заголовки страниц правильно отображали заголовок, имя стиля заголовка должно быть SectionTitle1. Если заголовок задан как DOM mlreportgen.dom.Paragraph объект без StyleName set, the StyleName свойство автоматически изменяется на правильное имя стиля. Стиль абзаца можно настроить, включив объекты стиля DOM в Style свойство Paragraph объект. Если для форматирования заголовка используется пользовательский шаблон, убедитесь, что имя стиля, используемое шаблоном, SectionTitle1. Настройте стиль заголовка путем изменения SectionTitle1 стиль в пользовательском шаблоне.

`Numbered` - Стоит ли называть эту главу
`true` | `false`

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

`Content` - Содержимое этого раздела
строковый скаляр | символьный вектор | встроенный объект |...

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

Строковый скаляр или вектор символов
Объекты DOM, которые могут быть добавлены в деталь документа DOM
Репортеры, в том числе Section репортеры
1x N или N x1 массив строковых скаляров или векторов символов
1x N или N x1 массива ячеек строковых скаляров, векторов символов и/или объектов DOM

Используйте Chapter конструктор или append метод, чтобы задать это свойство. Вы не можете установить его напрямую.

`Layout` - Размещение этой главы
`mlreportgen.report.ReporterLayout`

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

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

`TemplateSrc` - Источник шаблона для этого репортера
`[]` (по умолчанию) | вектор символов | строковый скаляр | репортер или отчет | документе DOM или части документа

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

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

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

`TemplateName` - Имя шаблона для этого репортера
вектор символов | строковый скаляр

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

`LinkTarget` - Цель гиперссылки для этого репортера
`[]` (по умолчанию) | вектор символов | строковый скаляр | `mlreportgen.dom.LinkTarget` объект

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

Методы

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

Общедоступные методы

`append`	Добавление содержимого в главу
`add`	(Не рекомендуемый) Добавить содержимое в главу
`getTitleReporter`	Получить заголовок главы reporter
`mlreportgen.report.Chapter.number`	`mlreportgen.report.Chapter.number(report,numbering)` определяет, нумеровать ли главы в отчете. Если `numbering` является `true`все главы доклада пронумерованы.
`mlreportgen.report.Chapter.createTemplate`	`mlreportgen.report.Chapter.createTemplate(templatePath,type)` создает копию `Chapter` шаблон, заданный `type` в местоположении, заданном `templatePath`. Можно использовать этот метод для создания копии шаблона раздела по умолчанию, который будет служить начальной точке для создания собственного пользовательского шаблона.
`mlreportgen.report.Chapter.customizeReporter`	`mlreportgen.report.Chapter.customizeReporter(toClasspath)` создает пустой класс, производный от `Chapter` класс reporter с именем `toClasspath`. Можно использовать сгенерированный класс в качестве начальной точки для создания пользовательской версии `Chapter` репортер.
`mlreportgen.report.Chapter.getClassFolder`	`mlreportgen.report.Chapter.getClassFolder()` возвращает путь к папке, содержащей файл определения класса для `Chapter` класс reporter.
`copy`	Создайте копию объекта reporter и сделайте глубокие копии значений свойств, которые ссылаются на объект reporter, ReporterLayout или DOM
`getImpl`	Получите реализацию DOM для этого репортера

Примеры

свернуть все

Добавление главы к отчету

Открыть Live Script

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

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

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

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

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

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

Вот первая страница главы 1 в сгенерированном отчете.

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

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

`add` метод не рекомендуется

Не рекомендуемый запуск в R2020b

Начиная с R2020b, используйте append метод вместо add метод для добавления содержимого к объектам этих классов Report API:

mlreportgen.report.Report
mlreportgen.report.Chapter
mlreportgen.report.Section

Чтобы добавить содержимое к объекту DOM API, такому как mlreportgen.dom.Paragraph , продолжите использовать append метод объекта DOM. Преимущество использования append добавление содержимого к объектам Report API заключается в том, что для добавления содержимого к объектам DOM API используется то же имя метода, что и для добавления содержимого.

Нет планов по удалению add методы Report, Chapter, или Section классы. Сообщите о программах API, которые используют add методы продолжат выполняться.

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

Не рекомендуется	Рекомендуется
import mlreportgen.report.* import mlreportgen.dom.* rpt = Report("My Report","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); add(sect,para); add(ch,sect); add(rpt,ch); close(rpt); rptview(rpt);	import mlreportgen.report.* import mlreportgen.dom.* rpt = Report("My Report","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); append(sect,para); append(ch,sect); append(rpt,ch); close(rpt); rptview(rpt);

Не рекомендуется

Рекомендуется

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

rpt = Report("My Report","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
add(sect,para);
add(ch,sect);
add(rpt,ch);

close(rpt);
rptview(rpt);

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

rpt = Report("My Report","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
append(sect,para);
append(ch,sect);
append(rpt,ch);

close(rpt);
rptview(rpt);

См. также

mlreportgen.report.Report | mlreportgen.report.Reporter | mlreportgen.report.ReportLayout | mlreportgen.report.Section

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

mlreportgen.report.Chapter class

Описание

Атрибуты класса

Создание

Описание

Свойства

`Title` - Заголовок главы
строковый скаляр | символьный вектор | объект DOM |...

`Numbered` - Стоит ли называть эту главу
`true` | `false`

`Content` - Содержимое этого раздела
строковый скаляр | символьный вектор | встроенный объект |...

`Layout` - Размещение этой главы
`mlreportgen.report.ReporterLayout`

`TemplateSrc` - Источник шаблона для этого репортера
`[]` (по умолчанию) | вектор символов | строковый скаляр | репортер или отчет | документе DOM или части документа

`TemplateName` - Имя шаблона для этого репортера
вектор символов | строковый скаляр

`LinkTarget` - Цель гиперссылки для этого репортера
`[]` (по умолчанию) | вектор символов | строковый скаляр | `mlreportgen.dom.LinkTarget` объект

Методы

Общедоступные методы

Примеры

Добавление главы к отчету

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

`add` метод не рекомендуется

См. также

Темы

MATLAB Report Generator

Поддержка

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

mlreportgen.report.Chapter class

Описание

Атрибуты класса

Создание

Описание

Свойства

Title - Заголовок главы строковый скаляр | символьный вектор | объект DOM |...

Numbered - Стоит ли называть эту главу true | false

Content - Содержимое этого раздела строковый скаляр | символьный вектор | встроенный объект |...

Layout - Размещение этой главы mlreportgen.report.ReporterLayout

TemplateSrc - Источник шаблона для этого репортера [] (по умолчанию) | вектор символов | строковый скаляр | репортер или отчет | документе DOM или части документа

TemplateName - Имя шаблона для этого репортера вектор символов | строковый скаляр

LinkTarget - Цель гиперссылки для этого репортера [] (по умолчанию) | вектор символов | строковый скаляр | mlreportgen.dom.LinkTarget объект

Методы

Общедоступные методы

Примеры

Добавление главы к отчету

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

add метод не рекомендуется

См. также

Темы

MATLAB Report Generator

Поддержка

`Title` - Заголовок главы
строковый скаляр | символьный вектор | объект DOM |...

`Numbered` - Стоит ли называть эту главу
`true` | `false`

`Content` - Содержимое этого раздела
строковый скаляр | символьный вектор | встроенный объект |...

`Layout` - Размещение этой главы
`mlreportgen.report.ReporterLayout`

`TemplateSrc` - Источник шаблона для этого репортера
`[]` (по умолчанию) | вектор символов | строковый скаляр | репортер или отчет | документе DOM или части документа

`TemplateName` - Имя шаблона для этого репортера
вектор символов | строковый скаляр

`LinkTarget` - Цель гиперссылки для этого репортера
`[]` (по умолчанию) | вектор символов | строковый скаляр | `mlreportgen.dom.LinkTarget` объект

`add` метод не рекомендуется