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

例

プロパティ

すべて展開する

`Title` — 節タイトル
string スカラー | string 配列 | 文字ベクトル | DOM 要素オブジェクト | `SectionTitle` レポーター

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

文字ベクトルまたは 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`

`Numbered` — このセクションに番号を付けるためのオプション
`[]` (既定値) | logical の `true` または `1` | `false` または `0`

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

属性:

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

データ型: logical

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

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

string または文字ベクトル
DOM ドキュメントパーツに追加できる DOM 要素オブジェクト
レポーター (Section レポーターを含む)
string または文字ベクトルから成る 1 行 N 列または N 行 1 列の配列
string、文字ベクトル、DOM 要素オブジェクトのいずれか、またはこれらの組み合わせから成る 1 行 N 列または N 行 1 列の cell 配列

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

属性:

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

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

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

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

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`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`	節へのコンテンツの追加
`number`	節の番号付けの設定
`getTitleReporter`	セクションタイトルレポーターの作成
`mlreportgen.report.Section.createTemplate`	`template = mlreportgen.report.Section.createTemplate(path,type)` レポーターテンプレートの作成入力引数 `path`。テンプレートファイルのターゲットパスとファイル名 `type`。テンプレートタイプ (`"html"`、`"docx"`、または `"pdf"` として指定) 戻り値 `template` — テンプレートのコピーのパスとファイル名。string スカラーとして返されます。詳細については、`Reporter` クラスの同等のメソッド `mlreportgen.report.Reporter.createTemplate` を参照してください。
`mlreportgen.report.Section.customizeReporter`	`reporter` `= mlreportgen.report.Section.customizeReporter(classpath)` `mlreportgen.report.Section` クラスから派生させたレポーターの作成戻り値 `reporter` — 新しいレポータークラスのパスとファイル名。string スカラーとして返されます。詳細については、`Reporter` クラスの同等のメソッド `mlreportgen.report.Reporter.customizeReporter` を参照してください。
`mlreportgen.report.Section.getClassFolder`	`path = mlreportgen.report.Section.getClassFolder` `mlreportgen.report.Section` クラス定義ファイルが含まれるフォルダーの場所の取得戻り値 `path` — クラス定義ファイルの場所。文字ベクトルとして返されます。詳細については、`Reporter` クラスの同等のメソッド `mlreportgen.report.Reporter.getClassFolder` を参照してください。
`copy`	レポーターオブジェクトのコピーの作成および特定のプロパティ値のディープコピーの作成
`getImpl`	レポーターの実装の取得
`add`	(非推奨) 節へのコンテンツの追加

例

すべて折りたたむ

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

ライブスクリプトを開く

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

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)
```

セクションの配置の変更

ライブスクリプトを開く

HTML レポートを作成し、節のタイトルを中央揃えに設定します。

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

参考

mlreportgen.report.Section クラス

説明

クラス属性

作成

説明

プロパティ

Title — 節タイトル string スカラー | string 配列 | 文字ベクトル | DOM 要素オブジェクト | SectionTitle レポーター

属性:

Numbered — このセクションに番号を付けるためのオプション [] (既定値) | logical の true または 1 | false または 0

属性:

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

属性:

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

属性:

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

属性:

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

属性: