mlreportgen.report.TitlePage class

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

Заглавная страница репортера

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

Описание

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

Конструкция

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

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

Свойства

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

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

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

  • Объект DOM

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

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

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

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

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

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

  • Объект DOM

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

  • 1-by- N или N-на-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 - Тег Image File

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

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

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

  • Объект DOM

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

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

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

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

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

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

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

  • Объект DOM

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

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

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

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

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

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

  • Объект DOM

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

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

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

Примеры

Страница заголовка по умолчанию

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

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 объект определяет ориентацию страницы, поля страницы, размер страницы и другие свойства макета страницы. Вы можете настроить и переопределить макет страницы заголовка с помощью настроенной версии его шаблона по умолчанию. Можно также настроить отдельные элементы страницы заголовка путем настройки этих шаблонов элементов. The TitlePage reporter поддерживает два подхода к переопределению шаблонов элементов страницы заголовка.

Использование пользовательского шаблона TitlePage

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

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

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

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

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

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

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

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

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

  5. Установите свойство элемента объекта title page на объект 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 Report Generator

Поддержка

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