mlreportgen.report.TitlePage class

Package: mlreportgen.report
Superclasses:

Title page reporter

Description

Create a title page reporter that adds a title page to a report. This class inherits from mlreportgen.report.Reporter.

Construction

tp = TitlePage() creates a title page reporter object that uses the default title page template. The title page template does not include a page number in the footer.

tp = TitlePage(Name,Value) sets properties using name-value pairs. You can specify multiple name-value pair arguments in any order. Enclose each property name in single quotes.

Properties

Title — Title page title

string | character array | ...

Table of contents title, specified as one of these values:

• String or character array

• DOM object

• 1-by-N or N-by-1 array of strings or DOM objects

• 1-by-N or N-by-1 cell array of strings, character arrays, and/or DOM objects

• Reporter created by the getTitleReporter method of this title page

Example: tp.Title = 'My Report';

Subtitle — Report subtitle

string | character array | ...

Table of contents title, specified as one of these values:

• String or character array

• DOM object

• 1-by-N or N-by-1 array of strings or DOM objects

• 1-by-N or N-by-1 cell array of strings, character arrays, and/or DOM objects

• Reporter created by the getSubtitleReporter method of this title page

Example: tp.Subtitle = 'Part I';

Image — Title page image

string | character array | ...

Image to insert in title page, specified as one of these values:

• String or character array that specifies the file system path of the image

• Snapshot maker, such as an mlreportgen.report.Figure reporter.

• DOM object

• 1-by-N or N-by-1 cell array of image paths, snapshot makers, or DOM objects

• Reporter created by the getImageReporter method of this title page

Supported image formats are:

• .bmp – Bitmap

• .gif – Graphics Interchange Format

• .jpg – JPEG

• .png – Portable Network Graphics

• .emf – Enhanced metafile (supported only in .docx output on Windows)

• .svg – Scalable Vector Graphic

• .tif – Tag Image File

Example: tp.Image = 'reports/imagedir/titleimage.jpg';

Author — Report author

environment variable username (default) | string | character array | DOM object | ...

Report author, specified as one of these values:

• String or character array

• DOM object

• 1-by-N or N-by-1 array of strings or DOM objects

• 1-by-N or N-by-1 cell array of strings, character arrays, and/or DOM objects

• Reporter created by the getAuthorReporter method of this title page

If the environment variable user name is not found, the default value is empty.

Example: TitlePage('Author','John Smith')

Publisher — Report publisher

string | character array | ...

Report publisher, specified as one of these values:

• string or character array

• DOM object

• 1-by-N or N-by-1 array of strings or DOM objects

• 1-by-N or N-by-1 cell array of strings, character arrays, and/or DOM objects

• Reporter created by the getPublisherReporter method of this title page

Example: tp.Publisher = 'Smith Company';

PubDate — Report publication date

string | character array | DOM object | array | cell array | TitlePagePubDate reporter

Report publication date, specified as one of these values:

• String or character array

• DOM object

• 1-by-N or N-by-1 array of strings or DOM objects

• 1-by-N or N-by-1 cell array of strings, character arrays, and/or DOM objects

• Reporter created by the getPubDateReporter method of this title page

Example: tp.PubDate = 'April 23, 2017';

Layout — Layout options for this reporter

string | character array | ...

Layout options for this reporter, specified depending on which layout property you set. The layout properties are Watermark, FirstPageNumber, PageNumberFormat, and Landscape. See mlreportgen.report.ReporterLayout for descriptions of these properties

TemplateSrc — Source of template for this reporter

[] (default) | character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified in one of these ways:

• Character vector or string scalar that specifies the path of the file that contains the template for this reporter

• Reporter or report whose template is used for this reporter or whose template library contains the template for this reporter

• DOM document or document part whose template is used for this reporter or whose template library contains the template for this reporter

The specified template must be the same type as the report to which this reporter is appended. For example, for a Microsoft^® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

TemplateName — Name of template for this reporter

character vector | string scalar

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template source (TemplateSrc) for this reporter.

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget object. A character vector or string scalar value is converted to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Methods

createTemplate	Create title page template
customizeReporter	Create custom title page reporter class
getAuthorReporter	Get title page author reporter
getClassFolder	Title page class definition file location
getImageReporter	Get title page image reporter
getPubDateReporter	Get title page publication date reporter
getPublisherReporter	Get title page publisher reporter
getSubtitleReporter	Get title page subtitle reporter
getTitleReporter	Get title page title reporter

Inherited Methods

copy	Create copy of reporter object and make deep copies of property values that reference a reporter, ReporterLayout, or DOM object
customizeReporter	Create class derived from Reporter class
getImpl	Get implementation of reporter

Examples

Default Title Page

Create a title page that uses the default formatting. Add the title page to the report and view the report.

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 Page with Customized Color

Create a title page that uses the default title format, but changes the title color to red. In this case, you specify the Title property as a DOM Text object and set its color to red.

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

Override Title Page Title Formatting

Create a title page that overrides the title property formatting. Change the title font to 24 pt Arial, the title text color to white, and use a blue background. Any styles you do not specify use the mlreportgen.dom.Paragraph class defaults.

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

Override Title Page Formatting and Layout Using Templates

The template for a TitlePage object determines its page orientation, page margins, page size, and other page layout properties. You can customize and override the title page layout using a customized version of its default template. You can also customize individual title page elements by customizing those element templates. The TitlePage reporter supports two approaches to overriding title page element templates.

Use Custom TitlePage Template

1. Create a copy of the default title page template.

2. Edit the title page element templates as desired in the copy of the template. The names of the templates have the form TitlePageNAME where NAME is the name of the template in the template library. For example, the name of the title template is TitlePageTitle.

3. Set the TitlePage TemplateSrc property of the object to the path of the custom template.

Use a Different Template Library

This approach takes advantage of the fact that the TitlePage object uses specialized reporters, called hole reporters, to apply element templates to the elements. The TitlePage reporter provides methods for getting the reporter to apply a template to a particular element. For example, the getTitleReporter method returns the reporter used for applying the TitlePageTitle template to the content of the report title.

1. Copy the title page element templates that you want to customize into a different template library. For example, you can copy the template library of the report or the template library of a DOM document part object. These template libraries are often libraries that you created to store customized versions of templates.

2. For each title page element to be customized, get its element reporter. For example, for the title, use the getTitleReporter method.

3. Set the TemplateSrc property of the element reporter to the source of the template library containing the customized version of the element template.

4. Set Content property of the element reporter to the element content.

5. Set the title page object element property to the element reporter object.

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;