mlreportgen.report.ReporterLayout クラス

名前空間: mlreportgen.report

レポーター用のレイアウト

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

説明

mlreportgen.report.ReporterLayout クラスのオブジェクトを使用して、レポート セクションのページ レイアウト オプション (タイトル ページ、目次、図のリスト、テーブルのリスト、表題のリスト、章など) を指定します。ページ レイアウト オプションには、透かし、先頭のページの番号付け、ページ番号形式、ページのサイズと向き、余白が含まれます。

メモ

レポート セクションのレポーターを作成すると、このクラスのインスタンスが作成され、レポーターの Layout プロパティに割り当てられます。自分でこのオブジェクトを作成することはしません。

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

クラス属性

HandleCompatible
true

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

プロパティ

すべて展開する

透かしイメージ。[] として指定するか、イメージ パス名を含む文字ベクトルまたは string スカラーとして指定します。このプロパティは、レポートを開く前に設定しなければなりません。透かしは、レポート セクションのすべてのページに表示されます。Watermark プロパティが [] の場合、セクションの透かしはレポートの透かしと同じになります。レポート セクションおよびレポートのレイアウト オブジェクトの Watermark プロパティが [] の場合、透かしは表示されません。

有効なイメージの種類は次のとおりです。

  • .emf

  • .gif

  • .jpg

  • .pdf

  • .png

  • .svg

  • .tiff

メモ

透かしを追加できるのは、PDF レポートのみです。他のレポート タイプでは、このプロパティの内容は無視されます。

属性:

GetAccess
public
SetAccess
public

データ型: char | string

レポート セクションの先頭ページで使用する番号。整数または [] として指定します。このプロパティの値が -1 または [] の場合、番号付けは前のセクションから継続されます。先頭ページ番号を指定するには、正の整数を入力します。

メモ

既定では、最初の章の先頭ページ番号は 1 です。

属性:

GetAccess
public
SetAccess
public

データ型: int32

Word または PDF のレポートでレポート セクションに使用するページの番号付けのタイプ。文字ベクトルまたは string スカラーとして指定します。有効なページ番号形式のリストについては、mlreportgen.dom.PageNumber の Format プロパティを参照してください。

属性:

GetAccess
public
SetAccess
public

データ型: char | string

レポート セクションのページ方向。true または false として指定します。縦向きを横向きに変更するにはこのプロパティを true に、横向きを縦向きに変更するには false に設定します。値が [] の場合、向きはセクション レイアウトで指定されたページ サイズによって決まります。

属性:

GetAccess
public
SetAccess
public

データ型: logical

レイアウトのページ サイズ。mlreportgen.dom.PageSize オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このレイアウトのページ余白、ヘッダー、フッター、およびとじしろのサイズ。mlreportgen.dom.PageMargins オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
public

レイアウトのページ境界線。mlreportgen.dom.PageBorder オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

例

すべて折りたたむ

ライブ スクリプトを開く

レポートに 3 つの章を追加します。最初の章では、先頭ページ番号に既定値の 1 を使用し、既定のページ方向を縦にします。2 番目の章では、先頭ページ番号を 1 にリセットし、横向きのページ方向を使用します。3 番目の章では、ページ番号と方向を設定せず、前の章から続く既定の先頭ページ番号と、既定のページ方向 (縦) が使用されるようにします。

import mlreportgen.report.*
rpt = Report('newreport');

タイトル ページを追加します。

tp = TitlePage();
tp.Title = 'New Report'; 
tp.Author = 'MathWorks'; 
add(rpt,tp)

番号付けを既定の 1 から開始し、既定のページ方向を縦に設定して、最初の章を追加します。

ch1 = Chapter();
ch1.Title = 'First Chapter';
sec = Section('First Section of Chapter 1');
txt = ['This is the first section of chapter 1. ',...
      'The first page number for this ',...
      'chapter is 1, which is the default. ',...
      'The page orientation is also the default.']; 
append(sec,txt);
append(ch1,sec);
append(rpt,ch1);

番号を 1 にリセットし、ページ方向を横向きに設定して、2 番目の章を追加します。

ch2 = Chapter(); 
ch2.Title = '2nd chapter';
ch2.Layout.FirstPageNumber = 1;
ch2.Layout.Landscape = true;
sec = Section('First Section of Chapter 2'); 
txt = ['This is the first section of chapter 2. ',...
      'The first page number is set to 1 and the ',...
      'page orientation is set to landscape.'];
append(sec,txt);
append(ch2,sec);
append(rpt,ch2);

開始ページ番号とページ方向をどちらも設定せず、3 番目の章を追加します。これにより、章は既定の設定 (前のページから続くページ番号と縦向きのページ方向) に戻ります。

ch3 = Chapter(); 
ch3.Title = '3rd chapter';
sec = Section('First Section of Chapter 3'); 
txt = ['This is the first section of chapter 3. ',...
      'Neither first page number nor page ',...
      'orientation is set for this chapter. ',...
      'The first page number uses the default, ',...
      'which continues from the previous page. ',...
      'The page orientation also uses the default, ',...
      'which is portrait.'];
append(sec,txt);
append(ch3,sec);
append(rpt,ch3);

レポートを閉じて表示します。

close(rpt);
rptview(rpt)

バージョン履歴

R2017b で導入

すべて展開する

参考

| | | | | |

トピック