mlreportgen.report.Chapter class

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

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

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

Описание

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

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

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

HandleCompatible true

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

Создание

Описание

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

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

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

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

Примечание

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

пример

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

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

Свойства

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

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

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

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

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

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

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

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

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

Примечание

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

`Numbered` — Пронумеровать ли эту главу
`true` | `false`

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

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

Содержимое раздела в виде одного из этих значений:

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

Открытые методы

`append`	Добавьте содержимое в главу
`add`	(Не рекомендуемый), Добавляет содержимое к главе
`getTitleReporter`	Получите генератор отчетов заголовка главы
`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`. Можно использовать этот метод, чтобы создать копию шаблона Section по умолчанию, чтобы служить начальной точкой для создания собственного шаблона.
`mlreportgen.report.Chapter.customizeReporter`	`mlreportgen.report.Chapter.customizeReporter(toClasspath)` создает пустой класс, выведенный из `Chapter` класс генератора отчетов с именем `toClasspath`. Можно использовать сгенерированный класс в качестве начальной точки для создания пользовательской версии `Chapter` генератор отчетов.
`mlreportgen.report.Chapter.getClassFolder`	`mlreportgen.report.Chapter.getClassFolder()` возвращает путь папки, которая содержит файл определения класса для `Chapter` класс генератора отчетов.
`copy`	Создайте копию генератора отчетов, возражают и делают глубокие копии значений свойств, которые ссылаются на генератор отчетов, ReporterLayout или Объект DOM
`getImpl`	Получите реализацию DOM для этого генератора отчетов

Примеры

свернуть все

Добавьте главу в отчет

Скрипт Open 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 метод, чтобы добавить содержимое в объекты этих классов API Отчета:

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

Добавить содержимое в объект DOM API, такой как mlreportgen.dom.Paragraph возразите, продолжите использовать append метод Объекта DOM. Преимущество использования append добавить содержимое, чтобы Сообщить об объектах АПИ то, что вы используете то же имя метода, как вы используете, чтобы добавить содержимое в объекты ДОМА АПИ.

Нет никаких планов удалить 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.Chapter class

Описание

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

Создание

Описание

Свойства

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

`Numbered` — Пронумеровать ли эту главу
`true` | `false`

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

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

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

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

Методы

Открытые методы

Примеры

Добавьте главу в отчет

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

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

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

Темы

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

Поддержка

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

mlreportgen.report.Chapter class

Описание

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

Создание

Описание

Свойства

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

Numbered — Пронумеровать ли эту главу true | false

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

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

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

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

Методы

Открытые методы

Примеры

Добавьте главу в отчет

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

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

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

Темы

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

Поддержка

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

`Numbered` — Пронумеровать ли эту главу
`true` | `false`

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

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

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

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

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