getTitleReporter

Class: mlreportgen.report.TitlePage
Namespace: mlreportgen.report

Get title page title reporter

expand all in page

Syntax

reporter = getTitleReporter(tp)

Description

reporter = getTitleReporter(tp) returns a reporter that the TitlePage reporter (tp) uses to format the value specified by its Title property. Use getTitleReporter to customize the title alignment, position, and appearance.

Input Arguments

expand all

Title page of the report, specified as a title page reporter object. To create the tp input, you use mlreportgen.report.TitlePage.

Output Arguments

expand all

Title page title reporter, returned as a reporter object.

Examples

Use Nondefault Title Page Title Style

Create a style for the title on your title page that differs from the default style. Before you run this example, create a template file named MyTitlePageTemplate and customize its TitlePageTitle style. Then, use the getTitleReporter method and the TemplateSrc property to use your template.

import mlreportgen.report.*
rpt = Report();
tp = TitlePage();
tp.Title = "My Report Title"
tp.Title = getTitleReporter(tp);
tp.Title.TemplateSrc = "MyTitlePageTemplate";
add(rpt,tp);

Version History

Introduced in R2017b

See Also

| |