mlreportgen.report.Chapter クラス

名前空間: mlreportgen.report
スーパークラス: mlreportgen.report.Section

章レポーター

このページをすべて展開する

説明

レポートに章を追加するには、mlreportgen.report.Chapter クラスのオブジェクトを使用します。

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

クラス属性

HandleCompatible true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

ch = mlreportgen.report.Chapter は、章を生成するレポーターを作成します。章は、レポーターの既定のテンプレートによって定義される新しいページレイアウトをもちます。

既定のテンプレートは、ヘッダーとフッターのある縦向きのページです。ヘッダーは空になります。章がレポートの最初の章である場合、フッターには 1 から始まる自動生成されたページ番号が含まれます。章が最初の章ではない場合、前の章の最後のページからページ番号が継続します。章のページレイアウト機能の一部 (向きなど) をオーバーライドするには、Layout プロパティを使用します。

タイトルを指定するには、Title プロパティを使用します。

章にコンテンツを追加するには、mlreportgen.report.Chapter オブジェクトの append メソッドを使用します。

メモ

章をレポートに追加する前に、すべてのコンテンツを章に追加します。章をレポートに追加すると、その章にコンテンツを追加できなくなります。

ch = mlreportgen.report.Chapter(title) は、指定されたタイトルの章を作成します。Title プロパティを参照してください。

例

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

プロパティ

すべて展開する

`Title` — 章のタイトル
文字ベクトル | string スカラー | DOM オブジェクト | `getTitleReporter` レポーター | ...

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

文字ベクトルまたは string スカラー
DOM オブジェクト
string スカラーまたは DOM オブジェクトからなる 1 行 N 列または N 行 1 列の配列
string スカラー、文字ベクトル、および DOM オブジェクトからなる 1 行 N 列または N 行 1 列の cell 配列
getTitleReporter メソッドによって返される mlreportgen.report.Title オブジェクト

タイトルは、章の最初と、最初のページを除くすべての章のページのヘッダーに表示されます。タイトルは、レポートの目次にも表示されます。

インラインオブジェクトは、段落に含めることができるオブジェクトです。タイトルの値がインラインオブジェクトの場合、Chapter オブジェクトはそのテンプレートライブラリのテンプレートを使用し、値に基づいてタイトルを作成します。タイトルの作成に使用されるテンプレートは、タイトルが番号付きかどうかによって異なります。章のタイトルは既定で番号付きになります。この章の番号付けをオフにするには、Numbered プロパティを使用します。レポート内の他の章すべてで番号付けをオフにするには、mlreportgen.report.Section.number メソッドを使用します。

タイトルに番号が付けられている場合、英語のレポートではタイトルの接頭辞として Chapter N という形式の文字列が付けられます。ここで、N は自動的に生成された章番号です。他の一部のロケールでは、英語の接頭辞がロケールの言語に変換されます。変換済みロケールのリストについては、mlreportgen.report.Report の Locale プロパティを参照してください。

インライン DOM オブジェクトを使用して、章の既定のタイトルテンプレートで指定された文字の書式設定をオーバーライドできます。

タイトルの値が DOM 段落または他の DOM ブロックオブジェクトである場合、章はそのオブジェクトを章の先頭に挿入します。DOM ブロックオブジェクトを使用する場合、ブロック要素を使用して、章タイトルの間隔、配置、およびその他のプロパティをカスタマイズできます。この場合、タイトル書式をすべて指定し、タイトルの番号付けを自分で指定しなければなりません。

メモ

ページヘッダーにタイトルを正しく表示するには、タイトルのスタイル名を SectionTitle1 にしなければなりません。StyleName が設定されていない DOM mlreportgen.dom.Paragraph オブジェクトとしてタイトルが指定されている場合、StyleName プロパティが正しいスタイル名に自動的に変更されます。Paragraph オブジェクトの Style プロパティに DOM スタイルオブジェクトを含めることで、段落スタイルをカスタマイズできます。カスタムテンプレートを使用してタイトルの書式を設定する場合は、テンプレートで使用されるスタイル名が SectionTitle1 であることを確認してください。カスタムテンプレートの SectionTitle1 スタイルを変更して、タイトルのスタイルをカスタマイズします。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

`Numbered` — この章に番号を付けるかどうか
`[]` (既定値) | `1` (`true`) | `0` (`false`)

この章に番号を付けるかどうか。logical の 1 (true) または 0 (false) として指定します。指定内容は以下のとおりです。

[] または 1 — 章はレポート内の他の章に対して相対的に番号付けされます。章番号はタイトルに表示されます。
0 — 章は番号付けされません。

Numbered プロパティの値は、mlreportgen.report.Chapter.number メソッドによってレポートのすべての章に指定された番号付けをオーバーライドします。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: logical

`Content` — このセクションのコンテンツ
文字ベクトル | string スカラー | インラインオブジェクト | ...

セクションのコンテンツ。次のいずれかの値として指定します。

文字ベクトルまたは string スカラー
DOM ドキュメントパーツに追加できる DOM オブジェクト
レポーター (Section レポーターを含む)
string スカラーまたは文字ベクトルからなる 1 行 N 列または N 行 1 列の配列
string スカラー、文字ベクトル、および DOM オブジェクトからなる 1xN または Nx1 の cell 配列

Chapter コンストラクターまたは append メソッドを使用して、このプロパティを設定します。直接設定することはできません。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

`Layout` — この章のレイアウト
`mlreportgen.report.ReporterLayout`

この章のレイアウト。mlreportgen.report.ReporterLayout オブジェクトとして指定します。ReporterLayout オブジェクトのプロパティを使用して、章のテンプレートで定義されている章のレイアウトプロパティの一部をオーバーライドします。

例: chapter.Layout.Landscape = true

属性:

`GetAccess`	`public`
`SetAccess`	`public`

`TemplateSrc` — このレポーターのテンプレートのソース
文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメントパーツ

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

このレポーターのテンプレートを含むファイルのパスを指定する文字ベクトルまたは string スカラー
このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレートライブラリに含む、レポーターまたはレポート
このレポーターが使用するテンプレートを含む、またはこのレポーターのテンプレートをテンプレートライブラリに含む、ドキュメントオブジェクトモデル (DOM) ドキュメントまたはドキュメントパーツ

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`
`Dependent`	`true`

`TemplateName` — このレポーターのテンプレートの名前
文字ベクトル | string スカラー

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`

データ型: char | string

`LinkTarget` — このレポーターのハイパーリンクターゲット
`[]` (既定値) | 文字ベクトル | string スカラー | `mlreportgen.dom.LinkTarget` オブジェクト

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`

メソッド

すべて展開する

パブリックメソッド

`append`	章へのコンテンツの追加
`add`	(非推奨) 章へのコンテンツの追加
`getTitleReporter`	章タイトルレポーターの取得
`mlreportgen.report.Chapter.number`	`mlreportgen.report.Chapter.number(report,numbering)` は、レポートの章に番号を付けるかどうかを指定します。`numbering` が `true` の場合、レポート内のすべての章に番号が付けられます。
`mlreportgen.report.Chapter.createTemplate`	`mlreportgen.report.Chapter.createTemplate(templatePath,type)` は、`type` で指定された `Chapter` テンプレートのコピーを `templatePath` で指定された場所に作成します。このメソッドを使用して、既定のセクションテンプレートのコピーを作成し、独自のカスタムテンプレートを作成するための開始点として使用できます。
`mlreportgen.report.Chapter.customizeReporter`	`mlreportgen.report.Chapter.customizeReporter(toClasspath)` は、`Chapter` レポータークラスから派生させた空のクラスを `toClasspath` という名前で作成します。生成されたクラスは、`Chapter` レポーターのカスタムバージョンを作成するための開始点として使用できます。
`mlreportgen.report.Chapter.getClassFolder`	`mlreportgen.report.Chapter` クラス定義ファイルが含まれるフォルダーの場所の取得 `path = getClassFolder` は、クラス定義ファイルが含まれるフォルダーのパスを返します。戻り値 `path` — クラス定義ファイルの場所。文字ベクトルとして返されます。詳細については、`Reporter` クラスのメソッド `mlreportgen.report.Reporter.getClassFolder` を参照してください。
`copy`	レポーターオブジェクトのコピーの作成およびプロパティ値のディープコピーの作成 `copiedObj = copy(reporterObj)` は、指定されたレポーターオブジェクトのコピーを返します。返されるコピーには、`reporterObj` のプロパティ値のうち、レポーター、DOM オブジェクト、または `mlreportgen.report.ReporterLayout` オブジェクトを参照しているものについて、deep copyが含まれます。その結果、元のオブジェクトまたは新しいオブジェクトのプロパティを変更しても、もう一方のオブジェクトには影響しません。入力引数 `reporterObj` — コピーするレポーターオブジェクト。reporter classのオブジェクトとして指定します。戻り値 `copiedObj` — レポーターのコピー。reporter classのオブジェクトとして返されます。詳細については、`mlreportgen.report.Reporter` クラスのメソッド `copy` を参照してください。
`getImpl`	レポーターの実装の取得 `impl = getImpl(reporter,report)` は、レポーターをレポート `report` に追加する際にレポーター `reporter` を実装するドキュメントオブジェクトモデル (DOM) オブジェクトを返します。メモこのメソッドを呼び出した後は、レポーターにコンテンツを追加できません。入力引数 `reporterObj`— レポーターオブジェクト。`mlreportgen.report.Reporter` のオブジェクト、または `mlreportgen.report.Reporter` のサブクラスのオブジェクトとして指定します。 `report` — レポート。`mlreportgen.report.Report` オブジェクトとして指定します。戻り値 `impl` — 実装オブジェクト。DOM オブジェクトとして返されます。詳細については、`mlreportgen.report.Reporter` クラスのメソッド `getImpl` を参照してください。

例

すべて折りたたむ

レポートへの章の追加

ライブスクリプトを開く

章に節を追加し、レポートに章を追加します。章のレイアウト方向を横向きに設定します。

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report('My Report','pdf');

append(rpt,TitlePage(Title='My Report'));

chapter = Chapter('Images');
chapter.Layout.Landscape = true;
append(chapter,Section(Title='Boeing 747',Content=Image('b747.jpg')));

append(rpt,chapter);
close(rpt);
rptview(rpt);

生成されたレポートの第 1 章の最初のページは次のようになります。

バージョン履歴

R2017b で導入

すべて展開する

R2020b: `add` メソッドは非推奨

R2020b 以降では、以下のレポート API クラスのオブジェクトにコンテンツを追加する場合、add メソッドの代わりに append メソッドを使用してください。

mlreportgen.report.Report
mlreportgen.report.Chapter
mlreportgen.report.Section
slreportgen.report.Report

mlreportgen.dom.Paragraph オブジェクトなどの DOM API オブジェクトにコンテンツを追加するには、引き続き DOM オブジェクトの append メソッドを使用してください。レポート API オブジェクトへのコンテンツの追加に append を使用することの利点は、DOM API オブジェクトへのコンテンツの追加に使用するのと同じメソッド名を使用できることです。

Report、Chapter、または Section クラスの add メソッドが削除される予定はありません。add メソッドを使用するレポート API プログラムは引き続き動作します。

既存のコードを更新するには、表の例に示すように、メソッド名を add から append に置き換えます。

非推奨	推奨
import mlreportgen.report.* import mlreportgen.dom.* rpt = Report("My Report","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); add(sect,para); add(ch,sect); add(rpt,ch); close(rpt); rptview(rpt);	import mlreportgen.report.* import mlreportgen.dom.* rpt = Report("My Report","pdf"); ch = Chapter("My Chapter"); sect = Section("My Section"); para = Paragraph("My Content "); append(para,"more Content"); append(sect,para); append(ch,sect); append(rpt,ch); close(rpt); rptview(rpt);

非推奨

推奨

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report("My Report","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
add(sect,para);
add(ch,sect);
add(rpt,ch);

close(rpt);
rptview(rpt);

import mlreportgen.report.*
import mlreportgen.dom.*

rpt = Report("My Report","pdf");
ch = Chapter("My Chapter");
sect = Section("My Section");
para = Paragraph("My Content ");
append(para,"more Content");
append(sect,para);
append(ch,sect);
append(rpt,ch);

close(rpt);
rptview(rpt);

参考

mlreportgen.report.Report | mlreportgen.report.Reporter | mlreportgen.report.Section | mlreportgen.report.ReportLayout

mlreportgen.report.Chapter クラス

説明

クラス属性

作成

説明

プロパティ

Title — 章のタイトル 文字ベクトル | string スカラー | DOM オブジェクト | getTitleReporter レポーター | ...

属性:

Numbered — この章に番号を付けるかどうか [] (既定値) | 1 (true) | 0 (false)

属性:

Content — このセクションのコンテンツ 文字ベクトル | string スカラー | インライン オブジェクト | ...

属性:

Layout — この章のレイアウト mlreportgen.report.ReporterLayout

属性:

TemplateSrc — このレポーターのテンプレートのソース 文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメント パーツ

属性:

TemplateName — このレポーターのテンプレートの名前 文字ベクトル | string スカラー

属性:

LinkTarget — このレポーターのハイパーリンク ターゲット [] (既定値) | 文字ベクトル | string スカラー | mlreportgen.dom.LinkTarget オブジェクト

属性:

メソッド

パブリック メソッド

例

レポートへの章の追加

バージョン履歴

R2020b: add メソッドは非推奨

参考

トピック

`Title` — 章のタイトル
文字ベクトル | string スカラー | DOM オブジェクト | `getTitleReporter` レポーター | ...

`Numbered` — この章に番号を付けるかどうか
`[]` (既定値) | `1` (`true`) | `0` (`false`)

`Content` — このセクションのコンテンツ
文字ベクトル | string スカラー | インラインオブジェクト | ...

`Layout` — この章のレイアウト
`mlreportgen.report.ReporterLayout`

`TemplateSrc` — このレポーターのテンプレートのソース
文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメントパーツ

`TemplateName` — このレポーターのテンプレートの名前
文字ベクトル | string スカラー

`LinkTarget` — このレポーターのハイパーリンクターゲット
`[]` (既定値) | 文字ベクトル | string スカラー | `mlreportgen.dom.LinkTarget` オブジェクト

パブリックメソッド

R2020b: `add` メソッドは非推奨