Exponenta Banner
exponenta event banner

класс mlreportgen.report.StartPage

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

Репортер титульной страницы

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

Описание

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

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

tp = TitlePage() создает объект-репортер титульной страницы, использующий шаблон титульной страницы по умолчанию. Шаблон титульной страницы не содержит номер страницы в нижнем колонтитуле.

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

Свойства

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

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

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

  • Объект DOM

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

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

  • Репортер, созданный getTitleReporter метод этой титульной страницы

Пример: tp.Title = 'My Report';

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

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

  • Объект DOM

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

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

  • Репортер, созданный getSubtitleReporter метод этой титульной страницы

Пример: tp.Subtitle = 'Part I';

Изображение для вставки в титульную страницу, указанное как одно из следующих значений:

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

  • Создатель снимков, например, mlreportgen.report.Figure репортер.

  • Объект DOM

  • 1-by-N или N-by-1 массив ячеек путей к изображениям, создателей снимков или объектов DOM

  • Репортер, созданный getImageReporter метод этой титульной страницы

Поддерживаются следующие форматы изображений:

  • .bmp - Растровое изображение

  • .gif - Формат обмена графикой

  • .jpg - JPEG

  • .png - Портативная сетевая графика

  • .emf - Расширенный метафайл (поддерживается только в .docx вывод в Windows)

  • .svg - Масштабируемая векторная графика

  • .tif - Файл изображения тега

Пример: tp.Image = 'reports/imagedir/titleimage.jpg';

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

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

  • Объект DOM

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

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

  • Репортер, созданный getAuthorReporter метод этой титульной страницы

Если имя пользователя переменной среды не найдено, значение по умолчанию пусто.

Пример: TitlePage('Author','John Smith')

Издатель отчета, указанный как одно из следующих значений:

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

  • Объект DOM

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

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

  • Репортер, созданный getPublisherReporter метод этой титульной страницы

Пример: tp.Publisher = 'Smith Company';

Дата публикации отчета, указанная как одно из следующих значений:

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

  • Объект DOM

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

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

  • Репортер, созданный getPubDateReporter метод этой титульной страницы

Пример: tp.PubDate = 'April 23, 2017';

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

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

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

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

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

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

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

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

Методы

createTemplateСоздать шаблон страницы заголовка
customizeReporterСоздать пользовательский класс репортера титульных страниц
getAuthorReporterПолучить репортера-автора титульной страницы
getClassFolderРасположение файла определения класса титульных страниц
getImageReporter Получить репортер изображений титульных страниц
getPubDateReporterПолучить репортера по дате публикации титульной страницы
getPublisherReporter Получить репортера издателя титульных страниц
getSubtitleReporter Получить репортера подзаголовков титульных страниц
getTitleReporterПолучить титульный репортер титульной страницы

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

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

Примеры

Титульная страница по умолчанию

Создайте страницу заголовка, использующую форматирование по умолчанию. Добавьте к отчету титульную страницу и просмотрите отчет.

import mlreportgen.report.*
rpt = Report('output','pdf');

tp = TitlePage();
tp.Title = 'Aircraft Tests';
tp.Subtitle = 'Monthly Data';
tp.Image = which('b747.jpg');
tp.Author = 'John Smith';
tp.Publisher = 'MathWorks';
tp.PubDate = date();

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

Титульная страница с настраиваемым цветом

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

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

rpt = Report('output','pdf');
tp = TitlePage;
tp.Title = Text('Aircraft Tests');
tp.Title.Color = 'red';

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

Переопределить форматирование заголовка страницы заголовка

Создайте страницу заголовка, которая переопределяет форматирование свойства заголовка. Измените шрифт заголовка на 24 pt Arial, цвет текста заголовка на белый и используйте синий фон. Любые стили, которые вы не указываете, используют mlreportgen.dom.Paragraph значения по умолчанию для класса. 

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

rpt = Report('output','pdf');
tp = TitlePage();
title = Paragraph('Aircraft Tests');
title.Style = {HAlign('left'),FontFamily('Arial'),...
         FontSize('24pt'),Color('white'),...
         BackgroundColor('blue'),...
         OuterMargin('0in','0in','.5in','1in'),...
         HAlign('center')};
tp.Title = title;
tp.Subtitle = 'Monthly Data';
tp.Image = which('b747.jpg');
tp.Author = 'John Smith';
tp.Publisher = 'MathWorks';
tp.PubDate = date();

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

Переопределить форматирование и макет титульных страниц с помощью шаблонов

Шаблон для TitlePage объект определяет ориентацию страницы, поля страницы, размер страницы и другие свойства макета страницы. Макет титульной страницы можно настроить и переопределить с помощью настроенной версии шаблона по умолчанию. Можно также настроить отдельные элементы страницы заголовка, настроив эти шаблоны элементов. TitlePage reporter поддерживает два подхода к переопределению шаблонов элементов титульных страниц.

Использовать шаблон настраиваемого кода страницы

  1. Создайте копию шаблона основной страницы по умолчанию.

  2. При необходимости отредактируйте шаблоны элементов титульной страницы в копии шаблона. Имена шаблонов имеют форму TitlePageNAME где NAME - имя шаблона в библиотеке шаблонов. Например, имя шаблона заголовка: TitlePageTitle.

  3. Установите TitlePage TemplateSrc свойства объекта к пути пользовательского шаблона.

Использование другой библиотеки шаблонов

Этот подход использует тот факт, что TitlePage Для применения шаблонов элементов к элементам объект использует специализированные репортеры, называемые репортерами отверстий. TitlePage reporter предоставляет способы для того, чтобы заставить reporter применить шаблон к конкретному элементу. Например, getTitleReporter возвращает репортер, используемый для применения TitlePageTitle шаблон к содержимому заголовка отчета.

  1. Скопируйте шаблоны элементов титульных страниц, которые требуется настроить, в другую библиотеку шаблонов. Например, можно скопировать библиотеку шаблонов отчета или библиотеку шаблонов объекта детали документа DOM. Эти библиотеки шаблонов часто являются библиотеками, созданными для хранения пользовательских версий шаблонов.

  2. Для каждого настраиваемого элемента титульной страницы получите его репортер элементов. Например, для заголовка используйте getTitleReporter способ.

  3. Установите TemplateSrc свойство репортера элемента к источнику библиотеки шаблонов, содержащей настроенную версию шаблона элемента.

  4. Набор Content свойство репортера элемента к содержимому элемента.

  5. Задайте свойство элемента объекта страницы заголовка для объекта reporter элемента.

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

rpt = Report('MyReport','pdf','MyCustomPDFTemplate');
tp = TitlePage;
titleReporter = getTitleReporter(tp);
titleReporter.TemplateSrc = rpt;
titleReporter.Content = 'My Report';
tp.Title = titleReporter;

См. также

Темы

Представлен в R2017b

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

Поддержка