mlreportgen.report.ReportLayout class

Пакет: mlreportgen.report

Макет страницы отчета

Описание

Используйте объект mlreportgen.report.ReportLayout Класс для задания опций макета страницы отчета, таких как водяные знаки, нумерация первой страницы, форматирование номера страницы, размер и ориентация страницы и поля.

Примечание

Отчет создает образец этого класса и присваивает его mlreportgen.report.Report Layout свойство. Вы не создаете объект самостоятельно.

The mlreportgen.report.ReportLayout класс является handle класс.

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

HandleCompatible
true

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

Свойства

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

Изображение водяного знака для страниц отчета, заданное как [] или вектор символов или строковый скаляр, содержащий имя пути к изображению. Указанный водяной знак отображается на всех страницах отчета. Пустое значение, [], указывает, что водяной знак не используется. Чтобы использовать другой водяной знак для отдельного раздела отчета, такого как глава, установите Watermark свойство mlreportgen.report.ReporterLayout объект, используемый репортером раздела. Допустимые типы изображений:

  • .bmp

  • .jpg

  • .pdf (только для типов выходных документов PDF)

  • .png

  • .svg

  • .tiff

Номер для использования на первой странице каждого раздела отчета, указанный как [] или положительное целое число. Например, если для первого номера страницы отчета задано значение 4, первый номер страницы для каждой главы отчета равен 4. Чтобы использовать другой номер первой страницы для отдельного раздела, установите FirstPageNumber свойство mlreportgen.report.ReporterLayout объект, используемый репортером раздела. Нумерация по умолчанию для отчета [], что указывает на то, что первая страница главы 1 является страницей 1. Все последующие страницы отчета нумеруются последовательно.

Тип нумерации страниц для отчета, заданный как строковый скаляр или вектор символов. Указанный формат номера страницы отображается на всех страницах отчета. Чтобы использовать другой формат номера страницы для отдельного раздела, такого как глава, установите PageNumberFormat свойство mlreportgen.report.ReporterLayout объект, используемый репортером раздела. Смотрите Format свойство в mlreportgen.dom.PageNumber список допустимых форматов номеров страниц.

Ориентация страницы для отчета, заданная как true или false. Установите это свойство на true чтобы изменить портретную ориентацию на ландшафтную ориентацию и false для изменения ориентации ландшафта на портретную. Если значение []ориентация определяется размером страницы, заданным размещением отчета.

Размер страниц в отчете, заданный как mlreportgen.dom.PageSize объект.

Размеры полей страницы, колонтитула, нижнего колонтитула и желоба в отчете, заданные как mlreportgen.dom.PageMargins объект.

Примеры

свернуть все

Установите в формате номера страницы для всего отчета арабские номера и номер страницы для таблицы содержимого римских цифр. Главы используют арабский формат номера, который является форматом по умолчанию для всего отчета. Первая страница первой главы по умолчанию имеет значение 1.

import mlreportgen.report.*
rpt = Report('newreport'); 
rpt.Layout.PageNumberFormat = 'n';

tp = TitlePage();
tp.Title = 'New Report'; 
tp.Author = 'MathWorks'; 
append(rpt,tp);

toc = TableOfContents();
toc.Layout.PageNumberFormat = 'i';
append(rpt,toc);

ch = Chapter();
ch.Title = 'Introduction';
sec = Section('First Section of Chapter 1');
txt = ['This is the first section of chapter 1. ',...
      'The page number format is Arabic numbers, ',...
      'which is the default for the report.'];
append(sec,txt);
append(ch,sec);
append(rpt,ch); 

ch = Chapter(); 
ch.Title = '2nd chapter';
sec = Section('First Section of Chapter 2'); 
txt = ['This is the first section of chapter 2. ',...
      'The page number format is Arabic numbers, ',...
      'which is the format defined for the report.'];
append(sec,txt);
append(ch,sec);
append(rpt,ch);

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