Main Content

mlreportgen.report.Section クラス

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

セクション レポーター

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

説明

レポートにセクションを追加するセクション レポーターを作成します。このクラスは mlreportgen.report.Reporter から継承します。

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

クラス属性

HandleCompatible
true

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

作成

説明

section = Section() は、レポート セクションを生成するレポーターを作成します。セクション レポーターをレポート、章、または別の節に追加できます。レポートにセクションを追加すると、既定の余白とページ番号付きのフッターが設定された縦向きの新規ページで、セクションが開始されます。ページ番号は、前のページ番号に 1 を加えたものになります。セクションを章または別の節に追加すると、レポーターは現在のページに、前に続く小節を作成します。既定では、タイトルのサイズがレポート階層のセクションの深さ (最大 5 レベル) に応じて小さくなります。5 よりも下層のセクションのタイトルには番号が付けられず、レベル 5 と同じフォント サイズになります。

section = Section(title) は、指定されたタイトル テキストのセクション タイトルを含むレポート セクションを作成します。既定では、階層セクション番号がタイトル テキストの前に付けられます。たとえば、2 番目の章で最初の節に付く既定の番号は 2.1 です。既定では、タイトルのフォント サイズがレポート階層のセクションの深さ (最大 5 レベル) に応じて小さくなります。

例

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

プロパティ

すべて展開する

セクション タイトル。次のいずれかの値として指定します。

  • string スカラーまたは文字配列

  • DOM オブジェクト

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

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

  • SectionTitle レポーター

インライン オブジェクトは、段落に含めることができるオブジェクトです。タイトルの値がインライン オブジェクトの場合、セクション オブジェクトはテンプレートのセットから 1 つのテンプレートを使用します。テンプレートは、セクション用のテンプレート ライブラリに保存されます。タイトルの作成に使用されるテンプレートは、タイトルに番号が付けられているかどうか、およびセクション階層のセクション レベルによって異なります。Numbered プロパティを使用して、セクション タイトルに番号を付けるかどうかを指定します。

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

属性:

GetAccess
public
SetAccess
public

データ型: string | char | DOM object | cell

このセクションに番号を付けるための選択。logical として指定します。このプロパティの値が [] または true の場合、セクションは、レポート内の他のセクションに対して相対的に番号付けされます。セクション番号は、セクション タイトルに表示されます。値が false の場合、このセクションには番号が付けられません。この Numbered プロパティの値は、mlreportgen.report.Section.number メソッドによるすべてのレポート セクションに対する番号付け指定をオーバーライドします。

属性:

GetAccess
public
SetAccess
public

データ型: logical

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

  • string または文字配列

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

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

  • string または文字配列から成る 1 行 N 列または N 行 1 列の配列

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

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

属性:

GetAccess
public
SetAccess
public

このレポーターのテンプレートのソース。次のオプションのいずれかとして指定します。

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

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

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

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

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

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

メソッド

すべて展開する

例

レポート セクションへのコンテンツの追加

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

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

theReport = Report("SectionExampleReport","pdf");

append(theReport,TitlePage(Title="Report with Sections"));

append(theReport,TableOfContents);
 
theChapter = Chapter("Images");
append(theChapter,Section(Title="Boeing 747",Content=Image("BoeingSectionExample.jpg")));
append(theChapter,Section(Title="Peppers",Content=Image("PeppersSectionExample.png")));
append(theReport,theChapter);

close(theReport);
rptview(theReport);

生成されたレポートのイメージを含むセクションは次のようになります。

セクション タイトルとしての DOM Text オブジェクトの使用

この例では、DOM Text オブジェクトを使用してタイトルを定義します。DOM オブジェクトを使用することで、そのプロパティを設定し、セクション タイトルの既定色である黒をオーバーライドできます。

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

rpt = Report('New Report','pdf');
open(rpt)
sect = Section;
sect.Title = Text('A Section');
sect.Title.Color = 'blue';
append(rpt,sect);

close(rpt)
rptview(rpt)

セクションの配置の変更

この例では、節のタイトルを中央揃えに設定するレポートを生成します。

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

rpt = Report('My Report','html');
append(rpt,TitlePage(Title='My Report'));
append(rpt,TableOfContents);
chTitle = Heading1('Chapter ');
chTitle.Style = {CounterInc('sect1'),...
     WhiteSpace('preserve')...
     Color('black'),...
     Bold, FontSize('24pt')};
append(chTitle,AutoNumber('sect1'));
append(chTitle,'. ');

sectTitle = Heading2();
sectTitle.Style = {CounterInc('sect2'),...
     WhiteSpace('preserve') ...
     HAlign('center'),PageBreakBefore};
append(sectTitle,AutoNumber('sect1'));
append(sectTitle,'.');
append(sectTitle,AutoNumber('sect2'));
append(sectTitle,'. ');
title = clone(chTitle);
append(title,'Images');
ch = Chapter(Title=title);
title = clone(sectTitle());
append(title,'Boeing 747');
append(ch,Section(Title=title,Content=Image(which('b747.jpg'))));
title = clone(sectTitle());
append(title,'Peppers');
append(ch,Section(Title=title,Content=Image(which('peppers.png'))));

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

バージョン履歴

R2017b で導入

参考

| | | | |