Exponenta Banner

mlreportgen.report. Класс TitlePage

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

Генератор отчетов титульного листа

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

Описание

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

Конструкция

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

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

Свойства

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

Заголовок оглавления, заданный как одно из этих значений:

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

  • Объект DOM

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

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

  • Генератор отчетов TitlePageTitle

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

Заголовок оглавления, заданный как одно из этих значений:

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

  • Объект DOM

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

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

  • Генератор отчетов TitlePageSubtitle

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

Отобразите, чтобы вставить в титульный лист, заданный как одно из этих значений:

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

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

  • Объект DOM

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

  • Генератор отчетов TitlePageImage

Поддерживаемые форматы изображения:

  • BMP Битовый массив

  • GIF - формат обмена графическими данными

  • .jpg – JPEG

  • PNG - переносимая сетевая графика

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

  • .svg – Масштабируемое векторное изображение

  • .tif – Пометьте файл изображения

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

Сообщите об авторе, заданном как одно из этих значений:

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

  • Объект DOM

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

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

  • Генератор отчетов TitlePageAuthor

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

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

Сообщите об издателе, заданном как одно из этих значений:

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

  • Объект DOM

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

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

  • Генератор отчетов TitlePagePublisher

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

Сообщите о годе издания, заданном как одно из этих значений:

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

  • Объект DOM

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

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

  • Генератор отчетов TitlePagePublDate

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

Параметры макета для этого генератора отчетов, заданного, в зависимости от которого свойства макета вы устанавливаете. Свойствами макета является Watermark, FirstPageNumber, PageNumberFormat и Landscape. Смотрите mlreportgen.report.ReporterLayout для описаний этих свойств

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

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

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

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

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

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

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

Методы

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

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

customizeReporterСоздайте класс, выведенный из класса Генератора отчетов
getImpl Получите реализацию генератора отчетов

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

Титульный лист по умолчанию

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

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);

Замените форматирование заголовка титульного листа

Создайте титульный лист, который заменяет форматирование свойства заголовка. Измените шрифт заголовка на Arial на 24 ПБ, цвет текста заголовка белому, и используйте синий фон. Любые стили, которые вы не задаете, используют значения по умолчанию класса 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 поддерживает два подхода к переопределяющим шаблонам элемента титульного листа.

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

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

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

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

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

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

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

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

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

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

  5. Установите свойство элемента объекта титульного листа на объект генератора отчетов элемента.

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
Поддержка