mlreportgen.report.TitlePage class

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

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

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

Описание

Используйте объект mlreportgen.report.TitlePage класс, чтобы добавить титульный лист в отчет.

mlreportgen.report.TitlePage классом является handle класс.

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

HandleCompatible
true

Создание

Описание

пример

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

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

Свойства

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

Заголовок титульного листа в виде одного из этих значений:

  • Строковый скаляр или вектор символов

  • Объект DOM

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

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

  • Генератор отчетов создается getTitleReporter метод этого титульного листа

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

Атрибуты:

GetAccess
public
SetAccess
public

Сообщите о подзаголовке в виде одного из этих значений:

  • Строковый скаляр или вектор символов

  • Объект DOM

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

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

  • Генератор отчетов создается getSubtitleReporter метод этого титульного листа

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

  • mlreportgen.report.Figure генератор отчетов

  • Объект DOM

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

  • Генератор отчетов создается getImageReporter метод этого титульного листа

Форматы изображений с этими расширениями файла поддерживаются:

  • .bmp – Битовый массив

  • .gif – Формат обмена графическими данными

  • .jpg – JPEG

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

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

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

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

  • Строковый скаляр или вектор символов

  • Объект DOM

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

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

  • Генератор отчетов создается getAuthorReporter метод этого титульного листа

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

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

Атрибуты:

GetAccess
public
SetAccess
public

Сообщите об издателе в виде одного из этих значений:

  • Строковый скаляр или вектор символов

  • Объект DOM

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

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

  • Генератор отчетов создается getPublisherReporter метод этого титульного листа

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

Атрибуты:

GetAccess
public
SetAccess
public

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

  • Строковый скаляр или вектор символов

  • Объект DOM

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

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

  • Генератор отчетов создается getPubDateReporter метод этого титульного листа

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
Restricts access

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

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

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

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

Методы

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

Примеры

свернуть все

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

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 свойство как Text DOM возразите и выбранный его цвет к красному.

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 шаблон:

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

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

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

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

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

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

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

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

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

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

Поддержка

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