Main Content

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(Name=Value) は、名前と値のペアを使用してプロパティを設定します。複数の名前と値のペアの引数を任意の順番で指定できます。

プロパティ

すべて展開する

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

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

  • DOM オブジェクト

  • string スカラーまたは DOM オブジェクトからなる 1 行 N 列または N 行 1 列の配列

  • string スカラー、文字ベクトル、DOM オブジェクトのいずれか、またはこれらの組み合わせからなる 1 行 N 列または N 行 1 列の cell 配列

  • getTitleReporter メソッドによって返される SectionTitle レポーター

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

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

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

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

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

メモ

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

属性:

GetAccess
public
SetAccess
public

この章に番号を付けるかどうか。true または false として指定します。Numbered の値が空または true の場合、章はレポート内の他の章に対して相対的に番号付けされます。章番号はタイトルに表示されます。Numbered の値が false の場合、この章には番号が付けられません。Numbered プロパティの値は、mlreportgen.report.Chapter.number メソッドによってレポートのすべての章に指定された番号付けをオーバーライドします。

属性:

GetAccess
public
SetAccess
public

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

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

  • DOM ドキュメント パーツに追加できる DOM オブジェクト

  • レポーター (Section レポーターを含む)

  • string スカラーまたは文字ベクトルからなる 1 行 N 列または N 行 1 列の配列

  • string スカラー、文字ベクトル、DOM オブジェクトのいずれか、またはこれらの組み合わせからなる 1 行 N 列または N 行 1 列の cell 配列

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

属性:

GetAccess
public
SetAccess
アクセスを制限

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

例: chapter.Layout.Landscape = true

属性:

GetAccess
public
SetAccess
アクセスを制限

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

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

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

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

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

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

データ型: string | char

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

メソッド

すべて展開する

すべて折りたたむ

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

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 で導入

すべて展開する