exponenta event banner

mlreportgen.report.Класс раздела

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

Описание

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

Строительство

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

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

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

Входные аргументы

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

См. раздел Свойство заголовка.

Свойства

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

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

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

  • Объект DOM

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

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

  • SectionTitle репортер

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

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

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

Примеры

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

В этом примере заголовок и изображение добавляются к двум разделам, а разделы - к главе.

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