mlreportgen.report.Section class

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

Разделите генератор отчетов

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

Описание

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

Конструкция

section = Section() создает генератор отчетов, который генерирует раздел отчета. Можно добавить генератор отчетов раздела в отчет, главу или другой раздел. Если вы добавляете раздел в отчет, раздел запускается на новой, странице портрета с полей по умолчанию и номера страницы в нижнем колонтитуле. Номер страницы равняется номеру предыдущей страницы плюс один. Если вы добавляете раздел в главу или другой раздел, генератор отчетов создает подраздел, который продвигается текущая страница. Размер заголовка уменьшает по умолчанию с глубиной раздела в иерархии отчета до пяти уровней глубоко. Заголовки разделов ниже, чем 5 не пронумерованы и имеют тот же размер шрифта как уровень 5.

section = Section(title) создает раздел отчета, содержащий заголовок раздела с заданным текстом заголовка. Иерархический номер раздела префиксы текст заголовка по умолчанию. Например, количество по умолчанию первого подраздела во второй главе 2.1. Размер шрифта заголовка уменьшает по умолчанию с глубиной раздела в иерархии отчета до пяти уровней глубоко.

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

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

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

Свойство See Title.

Свойства

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

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

  • Строка или символьный массив

  • Объект DOM

  • 1 N или N-by-1 массив строк или Объектов DOM

  • 1 N или N-by-1 массив ячеек строк, символьных массивов и/или Объектов DOM

  • SectionTitle генератор отчетов

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

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

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

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

  • Строка или символьный массив

  • Объекты DOM, которые могут быть добавлены к части документа DOM

  • Генераторы отчетов, включая Section генераторы отчетов

  • 1xN или массив N x1 строк или символьных массивов

  • 1xN или массив ячеек N x1 строк, символьных массивов и/или Объектов DOM

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

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

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

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

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

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

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

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

Методы

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

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

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

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

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

Примеры

Добавьте заголовок и изображение к разделу отчета

В этом примере показано, как добавить заголовок и изображение к двум разделам и добавить каждый из тех разделов к главе. Раздел инстанцируют, и его содержимое задано в add метод.

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

rpt = Report('My Report','pdf');
add(rpt,TitlePage('Title','My Report'));
add(rpt,TableOfContents);

ch = Chapter('Images');
add(ch,Section('Title','Boeing 747', ...
    'Content', Image(which('b747.jpg'))));
add(ch, Section('Title','Peppers', ...
    'Content',Image(which('peppers.png'))));
add(rpt,ch);

close(rpt)
rptview(rpt)

Используйте текстовый объект DOM в качестве заголовка раздела

Этот пример использует Text DOM объект задать заголовок. При помощи Объекта DOM можно установить его свойства и заменить черный цвет по умолчанию заголовка раздела.

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

rpt = Report('New Report','pdf');
open(rpt)
sect = Section;
sect.Title = Text('A Section');
sect.Title.Color = 'blue';
add(rpt,sect);

close(rpt)
rptview(rpt)

Измените выравнивание раздела

Этот пример генерирует отчет, который устанавливает заголовки подраздела на выравнивание по центру.

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

rpt = Report('My Report','html');
add(rpt,TitlePage('Title','My Report'));
add(rpt,TableOfContents);
chTitle = Heading1('Chapter ');
chTitle.Style = {CounterInc('sect1'),...
     WhiteSpace('preserve')...
     Color('black'),...
     Bold, FontSize('24pt')};
append(chTitle,AutoNumber('sect1'));
append(chTitle,'. ');

sectTitle = Heading2();
sectTitle.Style = {CounterInc('sect2'),...
     WhiteSpace('preserve') ...
     HAlign('center'),PageBreakBefore};
append(sectTitle,AutoNumber('sect1'));
append(sectTitle,'.');
append(sectTitle,AutoNumber('sect2'));
append(sectTitle,'. ');
title = clone(chTitle);
append(title,'Images');
ch = Chapter('Title',title);
title = clone(sectTitle());
append(title,'Boeing 747');
add(ch,Section('Title',title,'Content',...
     Image(which('b747.jpg'))));
title = clone(sectTitle());
append(title,'Peppers');
add(ch,Section('Title',title,'Content',...
     Image(which('peppers.png'))));

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

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

|

Темы

Введенный в R2017b

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