mlreportgen.report.TitlePage クラス

パッケージ: mlreportgen.report
スーパークラス: mlreportgen.report.Reporter

タイトル ページ レポーター

説明

mlreportgen.report.TitlePage クラスのオブジェクトを使用して、タイトル ページをレポートに追加します。

mlreportgen.report.TitlePage クラスは handle クラスです。

クラス属性

HandleCompatible

true

作成

説明

tp = mlreportgen.report.TitlePage() は、既定のタイトル ページ テンプレートを使用するタイトル ページ レポーターを作成します。

tp = mlreportgen.report.TitlePage(Name=Value) は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順番で指定できます。

プロパティ

Title — タイトル ページのタイトル

string スカラー | 文字ベクトル | ...

タイトル ページのタイトル。次の値のいずれかとして指定します。

• string スカラーまたは文字ベクトル

• DOM オブジェクト

• string または DOM オブジェクトから成る 1 行 N 列または N 行 1 列の配列

• string、文字ベクトル、または DOM オブジェクトからなる 1 行 N 列または N 行 1 列の cell 配列

• このタイトル ページの getTitleReporter メソッドによって作成されたレポーター

例: tp.Title = "My Report";

属性:

GetAccess	public
SetAccess	public

Subtitle — レポートのサブタイトル

string スカラー | 文字ベクトル | ...

レポートのサブタイトル。次の値のいずれかとして指定します。

• string スカラーまたは文字ベクトル

• DOM オブジェクト

• string または DOM オブジェクトから成る 1 行 N 列または N 行 1 列の配列

• string、文字ベクトル、または DOM オブジェクトからなる 1 行 N 列または N 行 1 列の cell 配列

• このタイトル ページの getSubtitleReporter メソッドによって作成されたレポーター

例: tp.Subtitle = "Part I";

属性:

GetAccess	public
SetAccess	public

Image — タイトル ページのイメージ

string スカラー | 文字ベクトル | ...

タイトル ページに挿入するイメージ。次の値のいずれかとして指定します。

• イメージのファイル システム パスを指定する string スカラーまたは文字ベクトル

• mlreportgen.report.Figure レポーター

• DOM オブジェクト

• イメージ パス、スナップショット メーカー、または DOM オブジェクトからなる 1 行 N 列または N 行 1 列の cell 配列

• このタイトル ページの getImageReporter メソッドによって作成されたレポーター

次のファイル拡張子のイメージ形式がサポートされています。

• .bmp – ビットマップ

• .gif – Graphics Interchange Format

• .jpg – JPEG

• .png – Portable Network Graphics

• .emf – Enhanced metafile (Windows の .docx 出力でのみサポート)

• .svg – Scalable Vector Graphic

• .tif – Tag Image File

例: tp.Image = "reports/imagedir/titleimage.jpg";

属性:

GetAccess	public
SetAccess	public

Author — レポートの作成者

環境変数ユーザー名 (既定値) | string スカラー | 文字ベクトル | ...

レポートの作成者。次の値のいずれかとして指定します。

• string スカラーまたは文字ベクトル

• DOM オブジェクト

• string または DOM オブジェクトから成る 1 行 N 列または N 行 1 列の配列

• string、文字ベクトル、または DOM オブジェクトからなる 1 行 N 列または N 行 1 列の cell 配列

• このタイトル ページの getAuthorReporter メソッドによって作成されたレポーター

環境変数ユーザー名が見つからない場合、既定値は空になります。

例: TitlePage("Author","John Smith")

属性:

GetAccess	public
SetAccess	public

Publisher — レポートの発行者

string スカラー | 文字ベクトル | ...

レポートの発行者。次の値のいずれかとして指定します。

• string スカラーまたは文字ベクトル

• DOM オブジェクト

• string または DOM オブジェクトから成る 1 行 N 列または N 行 1 列の配列

• string、文字ベクトル、または DOM オブジェクトからなる 1 行 N 列または N 行 1 列の cell 配列

• このタイトル ページの getPublisherReporter メソッドによって作成されたレポーター

例: tp.Publisher = "Smith Company";

属性:

GetAccess	public
SetAccess	public

PubDate — レポートの発行日

string スカラー | 文字ベクトル | ...

レポートの発行日。次の値のいずれかとして指定します。

• string スカラーまたは文字ベクトル

• DOM オブジェクト

• string または DOM オブジェクトから成る 1 行 N 列または N 行 1 列の配列

• string、文字ベクトル、DOM オブジェクトからなる 1 行 N 列または N 行 1 列の cell 配列

• このタイトル ページの getPubDateReporter メソッドによって作成されたレポーター

例: tp.PubDate = "April 23, 2017";

属性:

GetAccess	public
SetAccess	public

Layout — タイトル ページのページ レイアウト

mlreportgen.report.ReporterLayout オブジェクト

タイトル ページのページ レイアウト。mlreportgen.report.ReporterLayout オブジェクトとして指定します。ReporterLayout オブジェクトのプロパティを使用して、ページの向きなどの既定のページ レイアウト プロパティをオーバーライドします。

属性:

GetAccess	public
SetAccess	アクセスを制限

TemplateSrc — レポーターのテンプレートのソース

[] (既定値) | 文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメント パーツ

このレポーターのテンプレートのソース。次のいずれかの方法で指定します。

• このレポーターのテンプレートを含むファイルのパスを指定する文字ベクトルまたは string スカラー

• テンプレートがこのレポーターのために使用される、またはテンプレート ライブラリがこのレポーターのテンプレートを含むレポーターまたはレポート

• テンプレートがこのレポーターのために使用される、またはテンプレート ライブラリがこのレポーターのテンプレートを含む DOM ドキュメントまたはドキュメント パーツ

指定したテンプレートは、このレポーターが追加されるレポートと同じタイプにしなければなりません。たとえば、Microsoft^® Word レポートでは、TemplateSrc は Word レポーター テンプレートでなければなりません。TemplateSrc プロパティが空の場合、このレポーターはレポートの出力タイプに既定のレポーター テンプレートを使用します。

属性:

GetAccess	public
SetAccess	public

TemplateName — レポーターのテンプレートの名前

文字ベクトル | string スカラー

このレポーターのテンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーターのテンプレートは、このレポーターの TemplateSrc プロパティで指定されたテンプレートのテンプレート ライブラリになければなりません。

属性:

GetAccess	public
SetAccess	public

LinkTarget — このレポーターのハイパーリンク ターゲット

[] (既定値) | 文字ベクトル | string スカラー | mlreportgen.dom.LinkTarget オブジェクト

このレポーターのハイパーリンク ターゲット。リンク ターゲット ID を指定する文字ベクトルもしくは string スカラー、または mlreportgen.dom.LinkTarget オブジェクトとして指定します。文字ベクトルまたは string スカラー値は LinkTarget オブジェクトに変換されます。リンク ターゲットは、出力レポートでこのレポーターのコンテンツの直前にあります。

属性:

GetAccess	public
SetAccess	public

メソッド

パブリック メソッド

メソッド	目的
mlreportgen.report.TitlePage.createTemplate	タイトル ページ テンプレートの作成
mlreportgen.report.TitlePage.customizeReporter	カスタム タイトル ページ レポーター クラスの作成
mlreportgen.report.TitlePage.getClassFolder	タイトル ページのクラス定義ファイルの場所の取得
getAuthorReporter	タイトル ページの作成者レポーターの取得
getImageReporter	タイトル ページのイメージ レポーターの取得
getPublisherReporter	タイトル ページの発行者レポーターの取得
getSubtitleReporter	タイトル ページのサブタイトル レポーターの取得
getTitleReporter	タイトル ページのタイトル レポーターの取得
getPubDateReporter	タイトル ページの発行日レポーターの取得
getImpl	レポーターの実装の取得
copy	レポーター オブジェクトのコピーの作成、およびレポーター、ReporterLayout、または DOM オブジェクトを参照するプロパティ値のディープ コピーの作成

例

既定のタイトル ページ

既定の書式設定を使用するタイトル ページを作成します。レポートにタイトル ページを追加し、レポートを表示します。

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 ポイントの 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 オブジェクトのテンプレートによって決まります。既定のテンプレートのカスタマイズ バージョンを使用することで、タイトル ページのレイアウトをカスタマイズしてオーバーライドできます。それらの要素テンプレートをカスタマイズして、タイトル ページの個々の要素をカスタマイズすることもできます。TitlePage レポーターは、タイトル ページ要素テンプレートをオーバーライドする 2 つの方法をサポートしています。

カスタム 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 で導入

参考

mlreportgen.dom.Paragraph

トピック

• レポーターとは