mlreportgen.report.Section class

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

Описание

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

Конструкция

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

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

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

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

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

См. «Свойство Title».

Свойства

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

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

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

  • Объект DOM

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

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

  • SectionTitle репортер

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

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

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

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

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

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

  • Репортеры, в том числе Section репортеры

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

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

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

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

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

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

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

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

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

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

Методы

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

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

копия Создайте копию объекта reporter и сделайте глубокие копии определенных значений свойств
getImpl Получите реализацию reporter

Примеры

Добавление содержимого в раздел отчета

Этот пример добавляет заголовок и изображение к двум разделам и добавляет разделы к главе.

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

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

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

close(rpt);
rptview(rpt);

Использование объекта текста DOM в качестве заголовка раздела

Этот пример использует DOM Text объект для определения заголовка. При помощи объекта 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';
append(rpt,sect);

close(rpt)
rptview(rpt)

Изменение выравнивания сечения

В этом примере создается отчет, в котором заголовки подразделов задаются как центральное выравнивание.

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

rpt = Report('My Report','html');
append(rpt,TitlePage('Title','My Report'));
append(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');
append(ch,Section('Title',title,'Content',...
     Image(which('b747.jpg'))));
title = clone(sectTitle());
append(title,'Peppers');
append(ch,Section('Title',title,'Content',...
     Image(which('peppers.png'))));

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

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

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

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

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