mlreportgen.report.Класс главы

Пакет: 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-by-N или N-by-1 массив строковых скаляров или объектов DOM
1-by-N или N-by-1 массив ячеек строковых скаляров, символьных векторов и/или объектов DOM
SectionTitle репортер, возвращенный getTitleReporter метод

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

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

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

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

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

Примечание

Чтобы заголовок страницы отображался правильно, имя стиля заголовка должно быть SectionTitle1. Если заголовок указан как DOM mlreportgen.dom.Paragraph объект без StyleName set, 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 или Nx1 массив строковых скаляров или символьных векторов
1xN или Nx1 массив ячеек строковых скаляров, символьных векторов и/или объектов DOM

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

`Layout` - Структура этой главы
`mlreportgen.report.ReporterLayout`

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

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

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

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

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

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

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

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

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

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

Примеры

свернуть все

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

Открыть сценарий в реальном времени

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

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 для добавления содержимого к объектам API отчетов используется то же имя метода, что и для добавления содержимого к объектам API DOM.

Нет планов по удалению 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.Класс главы

Описание

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

Создание

Описание

Свойства

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

`Numbered` - Следует ли нумеровать эту главу
`true` | `false`

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

`Layout` - Структура этой главы
`mlreportgen.report.ReporterLayout`

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

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

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

Методы

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

Примеры

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

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

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

См. также

Темы

Документация по генератору отчетов MATLAB

Поддержка

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

mlreportgen.report.Класс главы

Описание

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

Создание

Описание

Свойства

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

Numbered - Следует ли нумеровать эту главу true | false

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

Layout - Структура этой главы mlreportgen.report.ReporterLayout

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

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

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

Методы

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

Примеры

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

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

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

См. также

Темы

Документация по генератору отчетов MATLAB

Поддержка

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

`Numbered` - Следует ли нумеровать эту главу
`true` | `false`

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

`Layout` - Структура этой главы
`mlreportgen.report.ReporterLayout`

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

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

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

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